API docs by Redocly

VoiceML — Twilio-compatible REST API (0.9.1)

Download OpenAPI specification:Download

URL: https://voiceml.voicetel.com License: MIT with Commons Clause

Twilio-compatible voice (inbound + outbound), SMS, conferencing, recording, transcription, and payment platform

VoiceML exposes a Twilio-compatible REST + voice markup surface covering voice (inbound + outbound calls, conferences, queues), SMS via the Messages resource, mid-call recording / SIPREC / real-time transcription / <Pay> subresources, and the IncomingPhoneNumbers

  • Applications configuration surfaces. Existing Twilio SDKs (twilio-node, twilio-python, twilio-go, ...) integrate with minimal migration effort. Authentication, error codes, and pagination follow Twilio's documented conventions where supported.

URL format: Twilio's canonical URL form ends with .json (e.g. /Calls/{Sid}.json). VoiceML accepts BOTH the .json-suffixed and the unsuffixed form — the server strips a trailing .json/.xml/.wav suffix before routing (see WrapWithFormatSuffix). The spec documents the .json form so SDKs generated against this spec produce Twilio-compatible URLs out of the box; existing clients that omit .json continue to work unchanged.

Authentication is per-tenant HTTP Basic:

  • Username = :AccountSid (the URL path parameter, Twilio-format AC + 32 hex chars). Same value the Twilio SDK validates in its constructor — migration-compatible.
  • Password = the per-account API key. The same key is used to compute X-Twilio-Signature on outbound webhooks.

Account management (create / rotate / disable / delete) is NOT exposed on this public listener — it lives on a private observability listener documented separately.

Calls

List calls

Paginated list of call records for the given account. Filters match Twilio: To, From, Status, ParentCallSid, StartTime (bare = full UTC day), StartTime< (strict upper), StartTime> (strict lower), and the same triple for EndTime. For backwards compatibility the legacy StartTime>= / EndTime<= SQL-style operators are also accepted at the handler. Pagination via Page and PageSize (max 1000). EndTime filters restrict the result set to terminal-status rows (an in-progress call has no end time and cannot match an EndTime window).

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
To
string
From
string
Status
string
ParentCallSid
string
StartTime
string <date-time>

Calls started on this UTC date (YYYY-MM-DD).

StartTime<
string <date-time>

Calls started strictly before this UTC date/time.

StartTime>
string <date-time>

Calls started strictly after this UTC date/time.

EndTime
string <date-time>

Calls ended on this UTC date (YYYY-MM-DD).

EndTime<
string <date-time>

Calls ended strictly before this UTC date/time.

EndTime>
string <date-time>

Calls ended strictly after this UTC date/time.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "calls": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Create (originate) a call

Originates an outbound call. The To and From numbers are validated and normalised to E.164 against the authenticated tenant's phone_regions list — set per-account in the admin API. Empty list disables validation; multi-region tenants accept numbers valid in any listed region. MachineDetection is optional; omitting it skips AMD entirely.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema:
required
To
required
string
From
required
string
Url
string

HTTP(S) endpoint that returns voice markup when the call answers. Mutually exclusive with the inline voice-markup body (inline body wins if both set).

Method
string
Default: "POST"
Enum: "GET" "POST"

HTTP method used to fetch Url (Twilio default = POST).

Twiml
string

Inline voice markup body — alternative to Url. If both are set, the inline voice-markup body wins (matches Twilio's documented precedence).

ApplicationSid
string

References a stored Application resource. Its VoiceUrl / VoiceMethod / VoiceFallbackUrl / VoiceFallbackMethod / StatusCallback{,Method,Event} fields fill any per-call request field that's empty. Per-call values always win — the Application provides defaults, not overrides. Cross-tenant Application lookups return 404 with the same shape as a nonexistent sid.

FallbackUrl
string

URL to fetch voice markup from if the primary Url / the inline voice-markup body source fails to fetch or parse. Tried only on primary failure.

FallbackMethod
string
Default: "POST"
Enum: "GET" "POST"
StatusCallback
string
StatusCallbackMethod
string
Default: "POST"
StatusCallbackEvent
Array of strings
Items Enum: "initiated" "ringing" "answered" "completed"
MachineDetection
string
Enum: "Enable" "DetectMessageEnd"
MachineDetectionTimeout
integer
MachineDetectionSpeechThreshold
integer
MachineDetectionSpeechEndThreshold
integer
MachineDetectionSilenceTimeout
integer
AsyncAmdStatusCallback
string
AsyncAmdStatusCallbackMethod
string
Default: "POST"
Record
boolean
Default: false
RecordingStatusCallback
string
RecordingStatusCallbackMethod
string
Default: "POST"
RecordingStatusCallbackEvent
string

Comma-separated subset of in-progress, completed, absent.

RecordingChannels
string
Enum: "mono" "dual"

Recording channel layout. Only mono is honored — dual is accepted but a single mixed channel is written.

RecordingTrack
string
Enum: "inbound" "outbound" "both"

Accepted for Twilio compatibility but currently ignored.

Trim
string
Enum: "trim-silence" "do-not-trim"

Accepted for Twilio compatibility but currently ignored.

Timeout
integer >= 1
Default: 60

Originate timeout (seconds).

SendDigits
string

DTMF burst played after answer — charset 0-9*#wW (w=500ms, W=1s pause). Wired into the originate.

CallerId
string

Twilio compatibility — accepted but ignored. VoiceML always uses From as the caller ID on the originating leg; CallerId does not override it.

CallReason
string

Stored as a custom channel variable on the originating call leg, accessible to customer dialplans for reporting and routing decisions.

SipAuthUsername
string

SIP digest auth username for BYOC trunks; channel var sip_auth_username.

SipAuthPassword
string

SIP digest auth password (paired with SipAuthUsername).

Byoc
string

Twilio BYOC Trunk SID. Accepted-and-ignored — VoiceML routes via gateways configured at deploy time.

AsyncAmd
boolean

Twilio compatibility — AMD on VoiceML is always async; this flag is accepted but redundant.

CallToken
string

Twilio CallToken for verified-caller-id flows. Accepted-and-ignored.

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "api_version": "2010-04-01",
  • "to": "+18005551234",
  • "to_formatted": "string",
  • "from": "+18005550000",
  • "from_formatted": "string",
  • "parent_call_sid": "string",
  • "caller_name": "string",
  • "forwarded_from": "string",
  • "status": "queued",
  • "direction": "inbound",
  • "answered_by": "human",
  • "start_time": "string",
  • "end_time": "string",
  • "duration": "string",
  • "price": "string",
  • "price_unit": "string",
  • "phone_number_sid": "string",
  • "annotation": "string",
  • "group_sid": "string",
  • "queue_time": "string",
  • "trunk_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Fetch a call

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "api_version": "2010-04-01",
  • "to": "+18005551234",
  • "to_formatted": "string",
  • "from": "+18005550000",
  • "from_formatted": "string",
  • "parent_call_sid": "string",
  • "caller_name": "string",
  • "forwarded_from": "string",
  • "status": "queued",
  • "direction": "inbound",
  • "answered_by": "human",
  • "start_time": "string",
  • "end_time": "string",
  • "duration": "string",
  • "price": "string",
  • "price_unit": "string",
  • "phone_number_sid": "string",
  • "annotation": "string",
  • "group_sid": "string",
  • "queue_time": "string",
  • "trunk_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Update or terminate a live call

Three flows on the same endpoint (mirrors Twilio):

  • Status=completed|canceled — terminate the call.
  • inline voice-markup body — execute inline voice markup on the live call (wins over Url when both are present).
  • Url=… — fetch new voice markup and execute it on the live call (live redirect / hot swap). If Status is present alongside any voice markup source, Status wins. The success response is the full Call resource — same shape GET returns — so SDK deserialisers round-trip.
Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema:
required
Status
string
Enum: "completed" "canceled"
Twiml
string

Inline voice markup body. Wins over Url.

Url
string
Method
string
Default: "POST"
Enum: "GET" "POST"
FallbackUrl
string
FallbackMethod
string
Default: "POST"
Enum: "GET" "POST"
StatusCallback
string

Swaps the live call's StatusCallback URL.

StatusCallbackMethod
string

Swaps the live call's StatusCallback HTTP method.

StatusCallbackEvent
Array of strings
Items Enum: "initiated" "ringing" "answered" "completed"

Replaces the event-mask. Repeatable form param; empty list defaults to [completed] (Twilio default).

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "api_version": "2010-04-01",
  • "to": "+18005551234",
  • "to_formatted": "string",
  • "from": "+18005550000",
  • "from_formatted": "string",
  • "parent_call_sid": "string",
  • "caller_name": "string",
  • "forwarded_from": "string",
  • "status": "queued",
  • "direction": "inbound",
  • "answered_by": "human",
  • "start_time": "string",
  • "end_time": "string",
  • "duration": "string",
  • "price": "string",
  • "price_unit": "string",
  • "phone_number_sid": "string",
  • "annotation": "string",
  • "group_sid": "string",
  • "queue_time": "string",
  • "trunk_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Delete a call record

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Calls / Recordings

List recordings for one call

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

query Parameters
DateCreated
string <date-time>

Filter to recordings created on this UTC date (YYYY-MM-DD).

DateCreated<
string <date-time>

Filter to recordings created strictly before this UTC date.

DateCreated>
string <date-time>

Filter to recordings created strictly after this UTC date.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "recordings": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Start a recording mid-call

Begins a fresh recording on the live call leg. The new Recording resource is returned in the 201 response. Distinct from Record=true on POST /Calls, which captures from the start of the call.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Request Body schema: application/x-www-form-urlencoded
optional
RecordingMaxDuration
integer

Cap recording length in seconds. 0 = no limit.

RecordingChannels
string
Enum: "mono" "dual"

dual is accepted but not honored — VoiceML records mono, so Recording.channels is always 1.

PlayBeep
boolean
Default: true

Twilio-compatible; accepted but currently a no-op on this REST endpoint (the <Record> voice markup verb does honor it).

RecordingStatusCallback
string
RecordingStatusCallbackMethod
string
Default: "POST"
RecordingStatusCallbackEvent
string

Comma-separated: in-progress,completed,absent

Responses

Response samples

Content type
application/json
{
  • "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "conference_sid": "string",
  • "status": "in-progress",
  • "source": "OutboundAPI",
  • "channels": 1,
  • "duration": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "start_time": "string",
  • "price": "string",
  • "price_unit": "string",
  • "encryption_details": { },
  • "subresource_uris": { },
  • "media_url": "string",
  • "error_code": 0
}

Fetch recording metadata for a specific call (call-scoped form)

Same JSON resource as /Recordings/{RecordingSid} but enforces the call-scope from the URL path. 404 if the recording exists but is attached to a different call.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "conference_sid": "string",
  • "status": "in-progress",
  • "source": "OutboundAPI",
  • "channels": 1,
  • "duration": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "start_time": "string",
  • "price": "string",
  • "price_unit": "string",
  • "encryption_details": { },
  • "subresource_uris": { },
  • "media_url": "string",
  • "error_code": 0
}

Update a mid-call recording's status

Applies stop / pause / resume on the live recording. All three transitions return 200 + the post-mutation Recording resource. Tenant-scoped: a RecordingSid that belongs to a different account returns 404 without leaking existence.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema: application/x-www-form-urlencoded
required
Status
required
string
Enum: "stopped" "paused" "in-progress"

Responses

Response samples

Content type
application/json
{
  • "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "conference_sid": "string",
  • "status": "in-progress",
  • "source": "OutboundAPI",
  • "channels": 1,
  • "duration": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "start_time": "string",
  • "price": "string",
  • "price_unit": "string",
  • "encryption_details": { },
  • "subresource_uris": { },
  • "media_url": "string",
  • "error_code": 0
}

Delete a recording (row + local WAV + S3 object when present)

Removes the memdb row, unlinks the on-disk WAV, and (when RECORDING_S3_BUCKET is configured) issues an S3 DeleteObject on the archived copy. S3 deletion is best-effort: failure logs but does not fail the API call (the bucket lifecycle policy is the long-stop cleanup). Tenant-scoped — cross-tenant DELETE returns 404 without affecting the row.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Calls / Streams

List active media streams for the call

Returns 0 or 1 entries — the runtime supports a single active media fork per call, matching the slot model on the VoiceML tracker. Pagination envelope is the Twilio-compatible shape so SDK auto-paginators round-trip cleanly.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Responses

Response samples

Content type
application/json
{
  • "streams": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Start a media stream on the call (REST equivalent of `<Connect><Stream>`/`<Start><Stream>`)

Starts a media fork on the live call leg. Equivalent to <Connect><Stream> / <Start><Stream> in voice markup. Returns the new Stream resource with an MZ-prefixed sid.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Request Body schema: application/x-www-form-urlencoded
required
Url
required
string

wss:// endpoint for the customer's WebSocket server. Required.

Track
string
Enum: "inbound_track" "outbound_track" "both_tracks"

Accepted for SDK parity; not validated and (for Streams) not applied.

Name
string
StatusCallback
string
StatusCallbackMethod
string
Default: "POST"

Responses

Response samples

Content type
application/json
{
  • "sid": "MZxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Fetch a single stream by sid

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(MZ|SR|GT)[a-f0-9]{32}$

Twilio-compatible subresource SID — used by Streams (MZ prefix), Siprec (SR prefix), and Transcriptions (GT prefix). The regex covers all three subresources mounted under /Calls/{CallSid}/{Streams|Siprec|Transcriptions}/{Sid}.

Responses

Response samples

Content type
application/json
{
  • "sid": "MZxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Update a media stream — only Status=stopped is meaningful

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(MZ|SR|GT)[a-f0-9]{32}$

Twilio-compatible subresource SID — used by Streams (MZ prefix), Siprec (SR prefix), and Transcriptions (GT prefix). The regex covers all three subresources mounted under /Calls/{CallSid}/{Streams|Siprec|Transcriptions}/{Sid}.

Request Body schema: application/x-www-form-urlencoded
required
Status
required
string
Value: "stopped"

Responses

Response samples

Content type
application/json
{
  • "sid": "MZxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Calls / Siprec

List active SIPREC sessions for the call

Returns 0 or 1 entries — only one SIPREC mirror per call leg is supported. Pagination envelope is the Twilio-compatible shape.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Responses

Response samples

Content type
application/json
{
  • "siprec": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Start a SIPREC session on the call (REST equivalent of `<Start><Siprec>`)

Starts a SIPREC mirror against the configured connector profile on the live call leg. Returns the new Siprec resource with an SR-prefixed sid.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Request Body schema: application/x-www-form-urlencoded
optional
Name
string
ConnectorName
string

Names a per-tenant SIPREC connector; resolves to that connector's Session Recording Server SIP URI. Required — pure per-tenant BYO with no operator default, so an empty, unknown, or disabled connector starts no recording (fails closed).

Track
string
Enum: "inbound_track" "outbound_track" "both_tracks"

Accepted for SDK parity; not validated and (for Streams) not applied.

StatusCallback
string
StatusCallbackMethod
string
Default: "POST"

Responses

Response samples

Content type
application/json
{
  • "sid": "SRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "connector_name": "string",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Fetch a single SIPREC session by sid

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(MZ|SR|GT)[a-f0-9]{32}$

Twilio-compatible subresource SID — used by Streams (MZ prefix), Siprec (SR prefix), and Transcriptions (GT prefix). The regex covers all three subresources mounted under /Calls/{CallSid}/{Streams|Siprec|Transcriptions}/{Sid}.

Responses

Response samples

Content type
application/json
{
  • "sid": "SRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "connector_name": "string",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Stop a SIPREC session

Status=stopped hard-stops the recording: VoiceML detaches the media fork (RTP stops leaving the media server immediately) and BYEs the SRS leg, then clears its session-tracking entry. Every recording on the call leg is stopped. The stop is not resumable — start a new SIPREC session to record again.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(MZ|SR|GT)[a-f0-9]{32}$

Twilio-compatible subresource SID — used by Streams (MZ prefix), Siprec (SR prefix), and Transcriptions (GT prefix). The regex covers all three subresources mounted under /Calls/{CallSid}/{Streams|Siprec|Transcriptions}/{Sid}.

Request Body schema: application/x-www-form-urlencoded
required
Status
required
string
Value: "stopped"

Responses

Response samples

Content type
application/json
{
  • "sid": "SRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "connector_name": "string",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Calls / Transcriptions

List active transcriptions for the call

Returns 0 or 1 entries. Pagination envelope is the Twilio-compatible shape.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Responses

Response samples

Content type
application/json
{
  • "transcriptions": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Start real-time transcription on the call (REST equivalent of `<Start><Transcription>`)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Request Body schema: application/x-www-form-urlencoded
optional
Name
string
Track
string
Enum: "inbound_track" "outbound_track" "both_tracks"

Accepted for SDK parity; not validated and (for Streams) not applied.

LanguageCode
string
Default: "en-US"
TranscriptionEngine
string
Enum: "deepgram" "google" "aws" "azure"

Unknown values are accepted and fall back to the deployment default engine (Deepgram).

ProfanityFilter
boolean
PartialResults
boolean
Hints
string
StatusCallback
string
StatusCallbackMethod
string
Default: "POST"
StatusCallbackEvents
string

Comma-separated event filter.

Responses

Response samples

Content type
application/json
{
  • "sid": "GT1234567890abcdef1234567890abcdef",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "language_code": "string",
  • "transcription_engine": "deepgram",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Fetch a single transcription by sid

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(MZ|SR|GT)[a-f0-9]{32}$

Twilio-compatible subresource SID — used by Streams (MZ prefix), Siprec (SR prefix), and Transcriptions (GT prefix). The regex covers all three subresources mounted under /Calls/{CallSid}/{Streams|Siprec|Transcriptions}/{Sid}.

Responses

Response samples

Content type
application/json
{
  • "sid": "GT1234567890abcdef1234567890abcdef",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "language_code": "string",
  • "transcription_engine": "deepgram",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Update a transcription — only Status=stopped is meaningful

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(MZ|SR|GT)[a-f0-9]{32}$

Twilio-compatible subresource SID — used by Streams (MZ prefix), Siprec (SR prefix), and Transcriptions (GT prefix). The regex covers all three subresources mounted under /Calls/{CallSid}/{Streams|Siprec|Transcriptions}/{Sid}.

Request Body schema: application/x-www-form-urlencoded
required
Status
required
string
Value: "stopped"

Responses

Response samples

Content type
application/json
{
  • "sid": "GT1234567890abcdef1234567890abcdef",
  • "account_sid": "string",
  • "call_sid": "string",
  • "name": "string",
  • "language_code": "string",
  • "transcription_engine": "deepgram",
  • "status": "in-progress",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Calls / Events

List per-call lifecycle events (compat stub)

Twilio's fine-grained per-call event stream. VoiceML delivers equivalent data via StatusCallback (initiated / ringing / answered / completed); this endpoint is mounted as a stub returning an empty list so SDK helpers iterate cleanly. The canonical event source is the customer's StatusCallback URL. Page/PageSize are accepted for SDK ergonomics but have no effect on an empty list.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "total": 0,
  • "uri": "string"
}

Calls / Notifications

List per-call notifications (compat stub)

Twilio's per-call alert log. VoiceML doesn't track notifications as a separate stream — relevant operator-side events flow through metrics + structured logs. This endpoint is mounted as a stub so SDK helpers don't 404; the response is always an empty list. Page/PageSize and Log are accepted for SDK ergonomics but have no effect on an empty list.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Log
integer
Enum: 0 1

Twilio-compatible parameter — 0 = error-level only, 1 = warning-level + above. Accepted for SDK migration compatibility; has no effect since VoiceML's per-call notification stream is unimplemented (this endpoint is a stub returning an empty list).

MessageDate
string <date-time>

Twilio-compatible date filter — accept-but-no-op on empty notification stub.

MessageDate<
string <date-time>

Twilio-compatible date filter — accept-but-no-op on empty notification stub.

MessageDate>
string <date-time>

Twilio-compatible date filter — accept-but-no-op on empty notification stub.

Responses

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "total": 0,
  • "uri": "string"
}

Fetch a per-call notification (compat stub)

Per-call notification fetch. VoiceML does not persist a notification stream — the list endpoint is always empty and individual fetches return 404.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{ }

Calls / Payments

Start a <Pay> session on an existing call (REST equivalent of `<Pay>` voice markup)

Initiates a <Pay> session against the live call leg. Every <Pay> attribute is accepted and validated. The card-capture runtime is enabled per account — contact support to turn it on. IdempotencyKey is accepted and persisted for diagnostic visibility.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Request Body schema: application/x-www-form-urlencoded
optional
IdempotencyKey
string

Body-level dedup token. Accepted; replay dedup not enforced.

StatusCallback
string
BankAccountType
string
Enum: "consumer-checking" "consumer-savings" "commercial-checking"
ChargeAmount
string

Decimal 0 to 1,000,000 inclusive; 0 (or omitted) means tokenize-only.

Currency
string
Default: "usd"

Lowercased server-side (ISO 4217).

Description
string
Input
string
Value: "dtmf"
MinPostalCodeLength
integer
Default: 0
Parameter
string

Single-level JSON object passed to the payment connector. Accepted for parity but not yet wired — currently a no-op.

PaymentConnector
string
Default: "Default"
PaymentMethod
string
Enum: "credit-card" "ach-debit"
PostalCode
boolean
Default: true
SecurityCode
boolean
Default: true
Timeout
integer
Default: 5
TokenType
string
Default: "reusable"
Enum: "one-time" "reusable" "payment-method"
ValidCardTypes
string

Space-separated. Default: visa mastercard amex maestro discover optima jcb diners-club enroute.

RequireMatchingInputs
string

Comma-separated fields requiring matcher inputs. Accepted for parity but not yet wired — currently a no-op.

Confirmation
boolean

Accepted for parity but not yet wired — currently a no-op.

Responses

Response samples

Content type
application/json
{
  • "sid": "PK1234567890abcdef1234567890abcdef",
  • "account_sid": "string",
  • "call_sid": "string",
  • "api_version": "2010-04-01",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Update a Pay session — Status=complete or Status=cancel

Updates a <Pay> session against the live call leg. The card-capture runtime is enabled per account — contact support to turn it on.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Sid
required
string^(MZ|SR|GT)[a-f0-9]{32}$

Twilio-compatible subresource SID — used by Streams (MZ prefix), Siprec (SR prefix), and Transcriptions (GT prefix). The regex covers all three subresources mounted under /Calls/{CallSid}/{Streams|Siprec|Transcriptions}/{Sid}.

Request Body schema: application/x-www-form-urlencoded
optional
IdempotencyKey
string
StatusCallback
string
Capture
string
Enum: "payment-card-number" "expiration-date" "security-code" "postal-code" "bank-routing-number" "bank-account-number"
Status
string
Enum: "complete" "cancel"

Responses

Response samples

Content type
application/json
{
  • "sid": "PK1234567890abcdef1234567890abcdef",
  • "account_sid": "string",
  • "call_sid": "string",
  • "api_version": "2010-04-01",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Calls / UserDefinedMessages

Send a user-defined message on a live call (NOT IMPLEMENTED)

Twilio's chat-style messages on a live call. Real message-passing infrastructure (a websocket on the customer-facing leg) that's out of scope for VoiceML. Returns 501 with Twilio code 20501. The empty request body schema is declared so codegen tooling emits a method signature consistent with Twilio's SDK.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Request Body schema: application/x-www-form-urlencoded
optional
object

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Conferences

List active conferences for the account

Returns conferences currently active for this tenant. Live query — no caching, always reflects state at request time. Conferences appear once a first participant joins (typically via voice markup <Dial><Conference>) and disappear as soon as the last participant leaves.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
FriendlyName
string

Filter to conferences with this exact FriendlyName.

Status
string
Enum: "init" "in-progress" "completed"

Filter to conferences in this lifecycle state. VoiceML conferences are only ever in-progress (rooms vanish when the last participant leaves), so filtering by init or completed returns an empty list.

DateCreated
string <date-time>

Twilio-compatible parameter. VoiceML's conference list is a live query with no historical store — accepted but does not narrow the result set.

DateCreated<
string <date-time>

Twilio-compatible date filter — accept-but-no-op on live conference list.

DateCreated>
string <date-time>

Twilio-compatible date filter — accept-but-no-op on live conference list.

DateUpdated
string <date-time>

Twilio-compatible date filter — accept-but-no-op on live conference list.

DateUpdated<
string <date-time>

Twilio-compatible date filter — accept-but-no-op on live conference list.

DateUpdated>
string <date-time>

Twilio-compatible date filter — accept-but-no-op on live conference list.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "conferences": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a single conference

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "CFxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "friendly_name": "incident-42",
  • "status": "init",
  • "region": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "reason_conference_ended": "conference-ended-via-api",
  • "call_sid_ending_conference": "string",
  • "subresource_uris": {
    },
  • "member_count": 0
}

End an active conference

v1 supports only Status=completed — kicks every participant and tears down the room. Twilio's other update fields (Announce*) are not yet implemented.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema: application/x-www-form-urlencoded
required
Status
required
string
Value: "completed"

Responses

Response samples

Content type
application/json
{
  • "sid": "CFxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "friendly_name": "incident-42",
  • "status": "init",
  • "region": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "reason_conference_ended": "conference-ended-via-api",
  • "call_sid_ending_conference": "string",
  • "subresource_uris": {
    },
  • "member_count": 0
}

Conferences / Participants

List participants in a conference

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

query Parameters
Muted
boolean

Filter to participants with this Muted state.

Hold
boolean

Filter to participants with this Hold state.

Coaching
boolean

Filter to participants with this Coaching state.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "participants": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "total": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Dial a participant into a conference

Places an outbound call from From to To that joins the named conference on answer via inline voice markup. Returns immediately with status=queued while the leg is ringing.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

Request Body schema: application/x-www-form-urlencoded
required
From
required
string

Caller ID / originating endpoint (E.164 or Twilio client:/sip:/app: form).

To
required
string

Destination endpoint to dial into the conference.

Label
string
Muted
boolean
StartConferenceOnEnter
boolean
Default: true
EndConferenceOnExit
boolean
Default: false
Timeout
integer

Ring timeout in seconds (default 60).

StatusCallback
string <uri>
StatusCallbackMethod
string
Enum: "GET" "POST"
StatusCallbackEvent
string

Responses

Response samples

Content type
application/json
{
  • "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "conference_sid": "string",
  • "account_sid": "string",
  • "muted": true,
  • "hold": true,
  • "call_sid_to_coach": "string",
  • "coaching": true,
  • "queue_time": "string",
  • "start_conference_on_enter": true,
  • "end_conference_on_exit": true,
  • "status": "queued",
  • "label": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string"
}

Fetch a single participant

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Responses

Response samples

Content type
application/json
{
  • "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "conference_sid": "string",
  • "account_sid": "string",
  • "muted": true,
  • "hold": true,
  • "call_sid_to_coach": "string",
  • "coaching": true,
  • "queue_time": "string",
  • "start_conference_on_enter": true,
  • "end_conference_on_exit": true,
  • "status": "queued",
  • "label": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string"
}

Mute / unmute / hold a participant

At least one of Muted or Hold must be set. Twilio's HoldUrl (custom hold-music URL) and AnnounceUrl are not yet implemented.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Request Body schema: application/x-www-form-urlencoded
required
Muted
boolean

Mute / unmute the participant.

Hold
boolean

Place the participant on hold (default hold-music profile) or remove from hold.

Responses

Response samples

Content type
application/json
{
  • "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "conference_sid": "string",
  • "account_sid": "string",
  • "muted": true,
  • "hold": true,
  • "call_sid_to_coach": "string",
  • "coaching": true,
  • "queue_time": "string",
  • "start_conference_on_enter": true,
  • "end_conference_on_exit": true,
  • "status": "queued",
  • "label": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string"
}

Kick a participant out of the conference

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Conferences / Recordings

List recordings captured by a conference

Returns recordings created by <Dial><Conference record="record-from-start"> verbs that ran in this conference. Pagination envelope same as /Recordings.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

query Parameters
DateCreated
string <date-time>

Filter to recordings created on this UTC date (YYYY-MM-DD).

DateCreated<
string <date-time>

Filter to recordings created strictly before this UTC date.

DateCreated>
string <date-time>

Filter to recordings created strictly after this UTC date.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "recordings": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Start a recording on a live conference

Begins a recording on the named conference's mixed audio. The new Recording resource is returned with source = StartConferenceRecordingAPI and status = in-progress. Conference recordings are always mono (channels = 1).

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

Request Body schema: application/x-www-form-urlencoded
optional
RecordingStatusCallback
string
RecordingStatusCallbackMethod
string
Default: "POST"
RecordingStatusCallbackEvent
string

Comma-separated: in-progress,completed,absent

Responses

Response samples

Content type
application/json
{
  • "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "conference_sid": "string",
  • "status": "in-progress",
  • "source": "OutboundAPI",
  • "channels": 1,
  • "duration": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "start_time": "string",
  • "price": "string",
  • "price_unit": "string",
  • "encryption_details": { },
  • "subresource_uris": { },
  • "media_url": "string",
  • "error_code": 0
}

Fetch a conference-scoped recording

Same JSON resource as /Recordings/{RecordingSid} but enforces the conference scope from the URL path. 404 if the recording exists but is attached to a different conference.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "conference_sid": "string",
  • "status": "in-progress",
  • "source": "OutboundAPI",
  • "channels": 1,
  • "duration": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "start_time": "string",
  • "price": "string",
  • "price_unit": "string",
  • "encryption_details": { },
  • "subresource_uris": { },
  • "media_url": "string",
  • "error_code": 0
}

Update a conference-scoped recording's status

Same semantics as /Calls/{CallSid}/Recordings/{Sid} but enforces conference scope from the URL path.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema: application/x-www-form-urlencoded
required
Status
required
string
Enum: "stopped" "paused" "in-progress"

Responses

Response samples

Content type
application/json
{
  • "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "conference_sid": "string",
  • "status": "in-progress",
  • "source": "OutboundAPI",
  • "channels": 1,
  • "duration": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "start_time": "string",
  • "price": "string",
  • "price_unit": "string",
  • "encryption_details": { },
  • "subresource_uris": { },
  • "media_url": "string",
  • "error_code": 0
}

Delete a conference-scoped recording

Same semantics as /Recordings/{Sid} but enforces conference scope from the URL path.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

ConferenceSid
required
string^CF[a-f0-9]{32}$|^[A-Z]{2}[0-9a-f]+__.+$

Twilio-compatible Conference SID — literal CF + 32 hex chars (34 total). Server-generated lazily on first <Dial><Conference> dispatch (or on first appearance in a GET /Conferences list); cleared when the conference ends. The v0.19.x namespaced form (<AccountSid>__<friendly>) is still accepted on input for migration safety, but the response always emits the CF shape.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Queues

Create a queue

Create a named queue. Idempotent — POSTing the same FriendlyName a second time returns the existing queue rather than erroring (matches Twilio).

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
required
string <= 64 characters
MaxSize
integer >= 0
Default: 0

Responses

Response samples

Content type
application/json
{
  • "sid": "QU0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "support",
  • "current_size": 0,
  • "max_size": 0,
  • "average_wait_time": 0,
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List queues for the account (paged, FriendlyName ASC)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "queues": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a queue

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "QU0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "support",
  • "current_size": 0,
  • "max_size": 0,
  • "average_wait_time": 0,
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Update a queue (FriendlyName / MaxSize)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string <= 64 characters
MaxSize
integer >= 0

Responses

Response samples

Content type
application/json
{
  • "sid": "QU0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "support",
  • "current_size": 0,
  • "max_size": 0,
  • "average_wait_time": 0,
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Delete a queue

Refused with 409 if any members are still waiting — caller must drain the queue first (matches Twilio's behaviour).

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Queues / Members

List waiting members in a queue

Returned ordered by position; position 1 = longest waiting (front of queue).

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

QueueSid
required
string^QU[0-9a-f]{32}$

Twilio-compatible Queue SID — literal "QU" + 32 hex chars (34 total). Server-generated on POST /Queues.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "queue_members": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Peek the longest-waiting member

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

QueueSid
required
string^QU[0-9a-f]{32}$

Twilio-compatible Queue SID — literal "QU" + 32 hex chars (34 total). Server-generated on POST /Queues.

Responses

Response samples

Content type
application/json
{
  • "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "queue_sid": "string",
  • "date_enqueued": "string",
  • "wait_time": 0,
  • "position": 0,
  • "uri": "string"
}

Dequeue the front member to a voice markup URL

Pops the longest-waiting member and redirects their call to the URL in the body. The member's wait-loop fetches that URL and runs the returned voice markup on their leg as continuation.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

QueueSid
required
string^QU[0-9a-f]{32}$

Twilio-compatible Queue SID — literal "QU" + 32 hex chars (34 total). Server-generated on POST /Queues.

Request Body schema: application/x-www-form-urlencoded
required
Url
required
string <uri>

HTTPS-only.

Method
string
Default: "POST"
Enum: "GET" "POST"

Responses

Response samples

Content type
application/json
{
  • "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "queue_sid": "string",
  • "date_enqueued": "string",
  • "wait_time": 0,
  • "position": 0,
  • "uri": "string"
}

Fetch a specific member by CallSid

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

QueueSid
required
string^QU[0-9a-f]{32}$

Twilio-compatible Queue SID — literal "QU" + 32 hex chars (34 total). Server-generated on POST /Queues.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Responses

Response samples

Content type
application/json
{
  • "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "queue_sid": "string",
  • "date_enqueued": "string",
  • "wait_time": 0,
  • "position": 0,
  • "uri": "string"
}

Dequeue a specific member to a voice markup URL

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

QueueSid
required
string^QU[0-9a-f]{32}$

Twilio-compatible Queue SID — literal "QU" + 32 hex chars (34 total). Server-generated on POST /Queues.

CallSid
required
string^CA[a-f0-9]{32}$

Twilio-format Call SID (CA + 32 hex characters).

Request Body schema: application/x-www-form-urlencoded
required
Url
required
string <uri>
Method
string
Default: "POST"
Enum: "GET" "POST"

Responses

Response samples

Content type
application/json
{
  • "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "queue_sid": "string",
  • "date_enqueued": "string",
  • "wait_time": 0,
  • "position": 0,
  • "uri": "string"
}

Applications

Create an Application

Persistent named voice markup+callback bundle — referenced by <Dial><Application>AP…</Application></Dial>. The agent's Dial verb resolves the SID, fetches voice_url, and runs the returned voice markup on the call leg.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string
VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"
VoiceFallbackUrl
string <uri>
VoiceFallbackMethod
string
Enum: "GET" "POST"
VoiceCallerIdLookup
boolean
StatusCallback
string <uri>
StatusCallbackMethod
string
Enum: "GET" "POST"
StatusCallbackEvent
string

Comma-separated.

MessageStatusCallback
string <uri>

DLR (delivery-receipt) URL for outbound SMS sent via this Application (#450).

SmsStatusCallback
string <uri>

Legacy alias of MessageStatusCallback (#450).

Responses

Response samples

Content type
application/json
{
  • "sid": "AP0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "ivr-main",
  • "api_version": "string",
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_caller_id_lookup": true,
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "status_callback_event": "string",
  • "message_status_callback": "string",
  • "sms_status_callback": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List Applications for the account (paged, FriendlyName ASC)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
FriendlyName
string

Filter to Applications with this exact FriendlyName.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch an Application

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "AP0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "ivr-main",
  • "api_version": "string",
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_caller_id_lookup": true,
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "status_callback_event": "string",
  • "message_status_callback": "string",
  • "sms_status_callback": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Update an Application (partial — only set fields are touched)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string
VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"
VoiceFallbackUrl
string <uri>
VoiceFallbackMethod
string
Enum: "GET" "POST"
VoiceCallerIdLookup
boolean
StatusCallback
string <uri>
StatusCallbackMethod
string
Enum: "GET" "POST"
StatusCallbackEvent
string
MessageStatusCallback
string <uri>

DLR (delivery-receipt) URL for outbound SMS sent via this Application (#450).

SmsStatusCallback
string <uri>

Legacy alias of MessageStatusCallback (#450).

Responses

Response samples

Content type
application/json
{
  • "sid": "AP0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "ivr-main",
  • "api_version": "string",
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_caller_id_lookup": true,
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "status_callback_event": "string",
  • "message_status_callback": "string",
  • "sms_status_callback": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Delete an Application

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

IncomingPhoneNumbers

List DIDs assigned to the authenticated tenant

Returns every DID currently bound to the authenticated account. Tenant-scoped — only the caller's own rows are returned; the global admin list endpoint is on the private listener and not described here.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

PhoneNumber
string^\+[1-9]\d{1,14}$

Exact-match filter on the E.164 phone number. Twilio's canonical lookup pattern is GET /IncomingPhoneNumbers?PhoneNumber=+1... followed by GET /IncomingPhoneNumbers/{sid} using the sid from the list result. Twilio-compatible SDK clients issue this pattern; the filter is supported so the same call pattern works against VoiceML. Returns a 0-or-1-row envelope.

FriendlyName
string

Twilio-compatible parameter. VoiceML doesn't model per-DID FriendlyName on phone_numbers (the field is empty in every view), so this parameter is accepted but does not narrow or widen the result set. Declared for SDK migration compatibility.

Beta
boolean

Twilio-compatible parameter. VoiceML does not model the carrier-supplied "beta" flag (no upstream beta-status distinction), so this parameter is accepted but does not narrow or widen the result set. Declared for SDK migration compatibility.

Origin
string
Enum: "twilio" "hosted"

Twilio-compatible parameter. VoiceML treats every assigned DID as locally provisioned (no twilio/hosted origin distinction), so this parameter is accepted but does not narrow or widen the result set. Declared for SDK migration compatibility.

Responses

Response samples

Content type
application/json
{
  • "incoming_phone_numbers": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Assign a DID to the authenticated tenant

Tenant self-serve assignment of an E.164 DID. Idempotent on the same tenant — re-POSTing the same PhoneNumber rebinds its voice routing without erroring (matches Twilio's update semantics). Returns 409 when the number is already claimed by a different account.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema:
required
PhoneNumber
required
string

E.164 — leading +, 7-15 digits.

VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"
VoiceFallbackUrl
string <uri>
VoiceFallbackMethod
string
Enum: "GET" "POST"
SmsApplicationSid
string

Bind to an Application (AP+32hex) for default outbound-SMS DLR (#450).

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "phone_number": "+18005551234",
  • "friendly_name": "string",
  • "api_version": "2010-04-01",
  • "uri": "string",
  • "origin": "twilio",
  • "beta": true,
  • "capabilities": {
    },
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_application_sid": "string",
  • "voice_caller_id_lookup": true,
  • "voice_receive_mode": "voice",
  • "sms_url": "string",
  • "sms_method": "GET",
  • "sms_fallback_url": "string",
  • "sms_fallback_method": "GET",
  • "sms_application_sid": "string",
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "trunk_sid": "string",
  • "address_sid": "string",
  • "address_requirements": "none",
  • "identity_sid": "string",
  • "bundle_sid": "string",
  • "emergency_status": "Active",
  • "emergency_address_sid": "string",
  • "emergency_address_status": "registered",
  • "status": "string",
  • "type": "local",
  • "date_created": "string",
  • "date_updated": "string"
}

List local DIDs assigned to the authenticated tenant

Twilio type-specific list alias. Returns DIDs inferred as local (non-toll-free US numbers and all non-US numbers). Same pagination envelope as /IncomingPhoneNumbers.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

PhoneNumber
string^\+[1-9]\d{1,14}$
FriendlyName
string
Beta
boolean
Origin
string
Enum: "twilio" "hosted"

Responses

Response samples

Content type
application/json
{
  • "incoming_phone_numbers": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Assign a local DID to the authenticated tenant

Twilio type-specific create alias — same semantics as POST /IncomingPhoneNumbers.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
PhoneNumber
required
string
VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"

Responses

Response samples

Content type
application/json
{
  • "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "phone_number": "+18005551234",
  • "friendly_name": "string",
  • "api_version": "2010-04-01",
  • "uri": "string",
  • "origin": "twilio",
  • "beta": true,
  • "capabilities": {
    },
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_application_sid": "string",
  • "voice_caller_id_lookup": true,
  • "voice_receive_mode": "voice",
  • "sms_url": "string",
  • "sms_method": "GET",
  • "sms_fallback_url": "string",
  • "sms_fallback_method": "GET",
  • "sms_application_sid": "string",
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "trunk_sid": "string",
  • "address_sid": "string",
  • "address_requirements": "none",
  • "identity_sid": "string",
  • "bundle_sid": "string",
  • "emergency_status": "Active",
  • "emergency_address_sid": "string",
  • "emergency_address_status": "registered",
  • "status": "string",
  • "type": "local",
  • "date_created": "string",
  • "date_updated": "string"
}

List mobile DIDs assigned to the authenticated tenant

Twilio type-specific list alias. VoiceML does not track carrier mobile classification on BYO DIDs — this endpoint returns an empty page unless future metadata is added.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

PhoneNumber
string^\+[1-9]\d{1,14}$
FriendlyName
string
Beta
boolean
Origin
string
Enum: "twilio" "hosted"

Responses

Response samples

Content type
application/json
{
  • "incoming_phone_numbers": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Assign a mobile DID to the authenticated tenant

Twilio type-specific create alias — same semantics as POST /IncomingPhoneNumbers.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
PhoneNumber
required
string
VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"

Responses

Response samples

Content type
application/json
{
  • "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "phone_number": "+18005551234",
  • "friendly_name": "string",
  • "api_version": "2010-04-01",
  • "uri": "string",
  • "origin": "twilio",
  • "beta": true,
  • "capabilities": {
    },
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_application_sid": "string",
  • "voice_caller_id_lookup": true,
  • "voice_receive_mode": "voice",
  • "sms_url": "string",
  • "sms_method": "GET",
  • "sms_fallback_url": "string",
  • "sms_fallback_method": "GET",
  • "sms_application_sid": "string",
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "trunk_sid": "string",
  • "address_sid": "string",
  • "address_requirements": "none",
  • "identity_sid": "string",
  • "bundle_sid": "string",
  • "emergency_status": "Active",
  • "emergency_address_sid": "string",
  • "emergency_address_status": "registered",
  • "status": "string",
  • "type": "local",
  • "date_created": "string",
  • "date_updated": "string"
}

List toll-free DIDs assigned to the authenticated tenant

Twilio type-specific list alias. Returns US toll-free NPAs (800/833/844/855/866/877/888). Same pagination envelope as /IncomingPhoneNumbers.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

PhoneNumber
string^\+[1-9]\d{1,14}$
FriendlyName
string
Beta
boolean
Origin
string
Enum: "twilio" "hosted"

Responses

Response samples

Content type
application/json
{
  • "incoming_phone_numbers": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Assign a toll-free DID to the authenticated tenant

Twilio type-specific create alias — same semantics as POST /IncomingPhoneNumbers.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
PhoneNumber
required
string
VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"

Responses

Response samples

Content type
application/json
{
  • "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "phone_number": "+18005551234",
  • "friendly_name": "string",
  • "api_version": "2010-04-01",
  • "uri": "string",
  • "origin": "twilio",
  • "beta": true,
  • "capabilities": {
    },
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_application_sid": "string",
  • "voice_caller_id_lookup": true,
  • "voice_receive_mode": "voice",
  • "sms_url": "string",
  • "sms_method": "GET",
  • "sms_fallback_url": "string",
  • "sms_fallback_method": "GET",
  • "sms_application_sid": "string",
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "trunk_sid": "string",
  • "address_sid": "string",
  • "address_requirements": "none",
  • "identity_sid": "string",
  • "bundle_sid": "string",
  • "emergency_status": "Active",
  • "emergency_address_sid": "string",
  • "emergency_address_status": "registered",
  • "status": "string",
  • "type": "local",
  • "date_created": "string",
  • "date_updated": "string"
}

Fetch a single DID assigned to the authenticated tenant

Tenant-scoped — a phone number that exists but belongs to a different account 404s with the same shape as a nonexistent number (no enumeration leak).

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "phone_number": "+18005551234",
  • "friendly_name": "string",
  • "api_version": "2010-04-01",
  • "uri": "string",
  • "origin": "twilio",
  • "beta": true,
  • "capabilities": {
    },
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_application_sid": "string",
  • "voice_caller_id_lookup": true,
  • "voice_receive_mode": "voice",
  • "sms_url": "string",
  • "sms_method": "GET",
  • "sms_fallback_url": "string",
  • "sms_fallback_method": "GET",
  • "sms_application_sid": "string",
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "trunk_sid": "string",
  • "address_sid": "string",
  • "address_requirements": "none",
  • "identity_sid": "string",
  • "bundle_sid": "string",
  • "emergency_status": "Active",
  • "emergency_address_sid": "string",
  • "emergency_address_status": "registered",
  • "status": "string",
  • "type": "local",
  • "date_created": "string",
  • "date_updated": "string"
}

Update voice routing on an assigned DID

Only-set-fields-touched semantics. Tenant-scoped — a number assigned to a different account 404s.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema:
required
VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"
VoiceFallbackUrl
string <uri>
VoiceFallbackMethod
string
Enum: "GET" "POST"
SmsApplicationSid
string

Bind to an Application (AP+32hex) for default outbound-SMS DLR (#450).

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "phone_number": "+18005551234",
  • "friendly_name": "string",
  • "api_version": "2010-04-01",
  • "uri": "string",
  • "origin": "twilio",
  • "beta": true,
  • "capabilities": {
    },
  • "voice_url": "string",
  • "voice_method": "GET",
  • "voice_fallback_url": "string",
  • "voice_fallback_method": "GET",
  • "voice_application_sid": "string",
  • "voice_caller_id_lookup": true,
  • "voice_receive_mode": "voice",
  • "sms_url": "string",
  • "sms_method": "GET",
  • "sms_fallback_url": "string",
  • "sms_fallback_method": "GET",
  • "sms_application_sid": "string",
  • "status_callback": "string",
  • "status_callback_method": "GET",
  • "trunk_sid": "string",
  • "address_sid": "string",
  • "address_requirements": "none",
  • "identity_sid": "string",
  • "bundle_sid": "string",
  • "emergency_status": "Active",
  • "emergency_address_sid": "string",
  • "emergency_address_status": "registered",
  • "status": "string",
  • "type": "local",
  • "date_created": "string",
  • "date_updated": "string"
}

Release a DID from the authenticated tenant

Tenant-scoped — a number assigned to a different account 404s without affecting the row. Idempotent: 204 on success OR if the number was already gone.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Numbers / InboundProcessingRegion

Fetch a phone number's Inbound Processing Region config

Twilio Inbound Processing Region API (routes/v2). Keyed by the phone number (E.164) or its PN sid; the account is resolved from HTTP Basic auth. 404 when the number is not claimed by the authenticated account.

Authorizations:
basicAuth
path Parameters
PhoneNumber
required
string

The phone number in E.164 format (e.g. +18005551234) or its PN sid.

Responses

Response samples

Content type
application/json
{
  • "phone_number": "+18005551234",
  • "url": "http://example.com",
  • "sid": "QQ0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "voice_region": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Set a phone number's Inbound Processing Region

Updates the inbound processing region of a phone number already claimed by the authenticated account. Keyed by the phone number (E.164) or its PN sid; account resolved from HTTP Basic auth.

Authorizations:
basicAuth
path Parameters
PhoneNumber
required
string

The phone number in E.164 format (e.g. +18005551234) or its PN sid.

Request Body schema: application/x-www-form-urlencoded
VoiceRegion
string

Inbound Processing Region for voice.

FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "phone_number": "+18005551234",
  • "url": "http://example.com",
  • "sid": "QQ0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "voice_region": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Messages

Send an SMS or MMS

Sends Body to To via the configured SMS provider. When one or more MediaUrl values are supplied the message is an MMS, dispatched through the tenant's configured MMS provider (#473) and Body becomes optional. When the provider is not configured the row is still persisted with status=failed and error_code=21609 so the integrator can introspect the rejection through GET /Messages/{Sid}.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
To
required
string

Destination phone number (E.164).

From
string

Source phone number; falls back to the tenant's configured default sender.

Body
string

Message text. Required unless MediaUrl is supplied (MMS).

MediaUrl
Array of strings <uri> [ items <uri > ]

One or more media URLs to attach (#473). Repeatable; presence makes the message an MMS routed through the tenant's MMS provider.

MessagingServiceSid
string

Accepted for parity; not yet routed against.

StatusCallback
string <uri>

Per-message delivery-receipt (DLR) callback URL; overrides the Application-level default (#450).

StatusCallbackMethod
string
Enum: "GET" "POST"

HTTP method for the StatusCallback (#450).

Responses

Response samples

Content type
application/json
{
  • "sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "api_version": "string",
  • "to": "string",
  • "from": "string",
  • "body": "string",
  • "status": "queued",
  • "num_segments": "string",
  • "num_media": "string",
  • "direction": "outbound-api",
  • "price": "string",
  • "price_unit": "string",
  • "error_code": 0,
  • "error_message": "string",
  • "messaging_service_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "date_sent": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

List Messages for the account (paged, DateCreated DESC)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
To
string
From
string
DateSent
string <date-time-rfc-2822>
DateSent<
string <date-time-rfc-2822>
DateSent>
string <date-time-rfc-2822>
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a Message

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "api_version": "string",
  • "to": "string",
  • "from": "string",
  • "body": "string",
  • "status": "queued",
  • "num_segments": "string",
  • "num_media": "string",
  • "direction": "outbound-api",
  • "price": "string",
  • "price_unit": "string",
  • "error_code": 0,
  • "error_message": "string",
  • "messaging_service_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "date_sent": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Update a Message (Body redaction; Status=canceled rejected)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema: application/x-www-form-urlencoded
optional
Body
string

Pass empty string to redact. Non-empty Body is ignored — Twilio's documented redaction semantics.

Status
string
Value: "canceled"

Returns 21610 — outbound SMS is fire-and-forget, no cancel path.

Responses

Response samples

Content type
application/json
{
  • "sid": "SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "api_version": "string",
  • "to": "string",
  • "from": "string",
  • "body": "string",
  • "status": "queued",
  • "num_segments": "string",
  • "num_media": "string",
  • "direction": "outbound-api",
  • "price": "string",
  • "price_unit": "string",
  • "error_code": 0,
  • "error_message": "string",
  • "messaging_service_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "date_sent": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Delete a Message

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

List the Media items attached to a Message (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

MessageSid
required
string

Parent Message SID.

query Parameters
DateCreated
string <date-time-rfc-2822>

Filter to media created on this date.

DateCreated<
string <date-time-rfc-2822>

Filter to media created before this date.

DateCreated>
string <date-time-rfc-2822>

Filter to media created after this date.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "media_list": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a Media item

Returns the Media resource JSON by default. A request whose Accept header asks for the media bytes (e.g. image/*) receives a 302 redirect to a short-lived presigned URL for the stored bytes, or to the recorded external source URL when bytes are not stored locally (#473).

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

MessageSid
required
string

Parent Message SID.

Sid
required
string^ME[0-9a-f]{32}$

Media item SID.

Responses

Response samples

Content type
application/json
{
  • "sid": "ME0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "parent_sid": "string",
  • "content_type": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Delete a Media item

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

MessageSid
required
string

Parent Message SID.

Sid
required
string^ME[0-9a-f]{32}$

Media item SID.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Account

Fetch the authenticated account

Returns the authenticated account in the Twilio Account shape (status/type/owner_account_sid/friendly_name/date_created/ date_updated/uri/subresource_uris). The response ADDITIVELY embeds VoiceML extension keys (name, voice_url, tts_*, stt_*, aws_*, allow_cidr, created_at/updated_at). The account secret auth_token is never emitted on this surface; rotate it via POST /Accounts/{Sid}/RotateKey. Self-serve — an account may only read its own record.

Authorizations:
basicAuth
path Parameters
Sid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid (AC + 32 hex characters).

Responses

Response samples

Content type
application/json
{
  • "sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "friendly_name": "VoiceML account",
  • "status": "active",
  • "type": "Full",
  • "owner_account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Update the authenticated account

Updates the authenticated account. Accepts form-encoded or JSON bodies; only the fields present in the request are changed (only-set-fields-touched). FriendlyName maps to the Twilio friendly_name; the remaining fields configure VoiceML voice routing, BYO STT/TTS, AWS recording storage, and the IP allow-list. Returns the post-update Account resource in the same Twilio shape as the fetch. Self-serve — an account may only update its own record.

Authorizations:
basicAuth
path Parameters
Sid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid (AC + 32 hex characters).

Request Body schema:
optional
FriendlyName
string

Human-readable account name (Twilio friendly_name).

VoiceUrl
string <uri>

Default voice webhook URL for the account.

VoiceMethod
string
Enum: "GET" "POST"

HTTP method for VoiceUrl.

VoiceFallbackUrl
string <uri>

Fallback voice webhook URL.

VoiceFallbackMethod
string
Enum: "GET" "POST"

HTTP method for VoiceFallbackUrl.

SttFsVendor
string

BYO speech-to-text media-engine vendor name.

SttHttpUrl
string <uri>

BYO speech-to-text HTTP endpoint.

SttHttpToken
string

BYO speech-to-text bearer token.

TtsHttpUrl
string <uri>

BYO text-to-speech HTTP endpoint.

TtsHttpToken
string

BYO text-to-speech bearer token.

TtsEngineName
string

BYO text-to-speech engine name.

TtsDefaultVoice
string

Default TTS voice.

TtsDefaultLanguage
string

Default TTS language tag (e.g. en-US).

AwsBucket
string

S3 bucket for recording storage.

AwsRegion
string

AWS region for the recording bucket.

AwsPrefix
string

Key prefix within the recording bucket.

AwsAccessKeyId
string

AWS access key ID for recording storage.

AwsSecretAccessKey
string

AWS secret access key for recording storage.

AwsKmsKeyId
string

AWS KMS key ID for server-side encryption.

AllowCidr
Array of strings

IP allow-list, one CIDR prefix per entry (repeatable form param). An empty list explicitly clears the allow-list (wide-open).

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "friendly_name": "VoiceML account",
  • "status": "active",
  • "type": "Full",
  • "owner_account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Account / Balance

Fetch the account balance

Returns the account's current balance. VoiceML is operator-billed — there is no per-tenant runtime balance ledger — so the balance is reported as a static zero in the account's currency. The response mirrors Twilio's Balance resource exactly.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "balance": "string",
  • "currency": "string"
}

Account / OutgoingCallerIds

Create a ValidationRequest (start caller-ID verification)

Begins outbound caller-ID verification for PhoneNumber. Returns a ValidationRequest carrying the validation_code the caller must confirm. The verified number then appears as an OutgoingCallerId.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
PhoneNumber
required
string <phone-number>
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "phone_number": "+14155551234",
  • "friendly_name": "Main Office",
  • "validation_code": "123456",
  • "call_sid": "string"
}

List OutgoingCallerIds for the account (paged, FriendlyName ASC)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
PhoneNumber
string <phone-number>

Filter to the OutgoingCallerId with this exact PhoneNumber.

FriendlyName
string

Filter to OutgoingCallerIds with this exact FriendlyName.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "outgoing_caller_ids": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch an OutgoingCallerId

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "friendly_name": "Main Office",
  • "phone_number": "+14155551234",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Update an OutgoingCallerId (partial — only FriendlyName is mutable)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "friendly_name": "Main Office",
  • "phone_number": "+14155551234",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Delete an OutgoingCallerId

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Account / Transcriptions

List the account's transcriptions

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
DateCreated
string <date-time>

Filter to transcriptions created on this UTC date (YYYY-MM-DD).

DateCreated<
string <date-time>

Filter to transcriptions created strictly before this UTC date.

DateCreated>
string <date-time>

Filter to transcriptions created strictly after this UTC date.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "transcriptions": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a transcription by sid

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^TR[a-f0-9]{32}$

Twilio-format Transcription SID (TR + 32 hex).

Responses

Response samples

Content type
application/json
{
  • "sid": "TRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "status": "in-progress",
  • "recording_sid": "string",
  • "duration": "string",
  • "transcription_text": "string",
  • "type": "fast",
  • "price": "string",
  • "price_unit": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string"
}

Delete a transcription

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^TR[a-f0-9]{32}$

Twilio-format Transcription SID (TR + 32 hex).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Account / Exports

List available daily event-log archives (VoiceML extension)

VoiceML extension (not a Twilio resource). Lists the authenticated account's nightly event-log archives — calls, messages, recordings metadata, and payments — available for self-service download. Archives are produced once per day and retained for one year, after which an S3 lifecycle rule deletes them.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "uri": "string",
  • "exports": [
    ]
}

Download a daily event-log archive (VoiceML extension)

VoiceML extension (not a Twilio resource). Redirects (302) to a time-limited presigned URL for the account's archive on the given date.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Date
required
string^\d{4}-\d{2}-\d{2}$

Archive day (YYYY-MM-DD).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Notifications

List account notifications (compat stub)

Account-wide notification log. VoiceML delivers events via StatusCallback — this endpoint returns an empty list so SDK helpers do not 404.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

MessageDate
string <date-time>

Twilio-compatible date filter — accept-but-no-op on empty notification stub.

MessageDate<
string <date-time>

Twilio-compatible date filter — accept-but-no-op on empty notification stub.

MessageDate>
string <date-time>

Twilio-compatible date filter — accept-but-no-op on empty notification stub.

Log
integer
Enum: 0 1

Twilio-compatible parameter — accept-but-no-op on empty notification stub.

Responses

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "total": 0,
  • "uri": "string"
}

Fetch an account notification (compat stub)

Always 404 — VoiceML does not persist notifications.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{ }

SIP / Domains

Create a SIP Domain

Registers a SIP Domain — the SIP-ingress surface that routes inbound INVITEs to voice markup via voice_url. DomainName is required.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
DomainName
required
string
FriendlyName
string
VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"
VoiceFallbackUrl
string <uri>
VoiceFallbackMethod
string
Enum: "GET" "POST"
VoiceStatusCallbackUrl
string <uri>
VoiceStatusCallbackMethod
string
Enum: "GET" "POST"
SipRegistration
boolean
Secure
boolean
EmergencyCallingEnabled
boolean
ByocTrunkSid
string
EmergencyCallerSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "SD0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "sip-ingress",
  • "domain_name": "example.sip.voiceml.example.com",
  • "api_version": "string",
  • "auth_type": "string",
  • "voice_url": "http://example.com",
  • "voice_method": "GET",
  • "voice_fallback_url": "http://example.com",
  • "voice_fallback_method": "GET",
  • "voice_status_callback_url": "http://example.com",
  • "voice_status_callback_method": "GET",
  • "sip_registration": true,
  • "emergency_calling_enabled": true,
  • "secure": true,
  • "byoc_trunk_sid": "string",
  • "emergency_caller_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

List SIP Domains for the account (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
FriendlyName
string

Filter to SIP Domains with this exact FriendlyName.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Server-generated on POST /SIP/Domains.

Responses

Response samples

Content type
application/json
{
  • "sid": "SD0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "sip-ingress",
  • "domain_name": "example.sip.voiceml.example.com",
  • "api_version": "string",
  • "auth_type": "string",
  • "voice_url": "http://example.com",
  • "voice_method": "GET",
  • "voice_fallback_url": "http://example.com",
  • "voice_fallback_method": "GET",
  • "voice_status_callback_url": "http://example.com",
  • "voice_status_callback_method": "GET",
  • "sip_registration": true,
  • "emergency_calling_enabled": true,
  • "secure": true,
  • "byoc_trunk_sid": "string",
  • "emergency_caller_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Update a SIP Domain (partial — only set fields are touched)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Server-generated on POST /SIP/Domains.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string
VoiceUrl
string <uri>
VoiceMethod
string
Enum: "GET" "POST"
VoiceFallbackUrl
string <uri>
VoiceFallbackMethod
string
Enum: "GET" "POST"
VoiceStatusCallbackUrl
string <uri>
VoiceStatusCallbackMethod
string
Enum: "GET" "POST"
SipRegistration
boolean
Secure
boolean
EmergencyCallingEnabled
boolean
ByocTrunkSid
string
EmergencyCallerSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "SD0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "sip-ingress",
  • "domain_name": "example.sip.voiceml.example.com",
  • "api_version": "string",
  • "auth_type": "string",
  • "voice_url": "http://example.com",
  • "voice_method": "GET",
  • "voice_fallback_url": "http://example.com",
  • "voice_fallback_method": "GET",
  • "voice_status_callback_url": "http://example.com",
  • "voice_status_callback_method": "GET",
  • "sip_registration": true,
  • "emergency_calling_enabled": true,
  • "secure": true,
  • "byoc_trunk_sid": "string",
  • "emergency_caller_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Delete a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Server-generated on POST /SIP/Domains.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / Domains / InboundProcessingRegion

Fetch a SIP domain's Inbound Processing Region config

Twilio Inbound Processing Region API (routes/v2). Keyed by the domain name; the account is resolved from HTTP Basic auth. 404 when the named domain does not exist for the authenticated account.

Authorizations:
basicAuth
path Parameters
SipDomain
required
string

The registrable SIP domain name (e.g. example.sip.voiceml.example.com).

Responses

Response samples

Content type
application/json
{
  • "sip_domain": "example.sip.voiceml.example.com",
  • "url": "http://example.com",
  • "sid": "QQ0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "voice_region": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Set a SIP domain's Inbound Processing Region

Updates the inbound processing region and/or friendly name of an existing SIP domain (create the domain first via the 2010-04-01 SIP Domains API). Keyed by domain name; account resolved from HTTP Basic auth.

Authorizations:
basicAuth
path Parameters
SipDomain
required
string

The registrable SIP domain name (e.g. example.sip.voiceml.example.com).

Request Body schema: application/x-www-form-urlencoded
VoiceRegion
string

Inbound Processing Region for voice.

FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "sip_domain": "example.sip.voiceml.example.com",
  • "url": "http://example.com",
  • "sid": "QQ0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "voice_region": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

SIP / Domains / CredentialListMappings

Map a CredentialList onto a SIP Domain

Binds an existing CredentialList (CL…) to the Domain. The response echoes the mapped list's shape; the mapping's sid IS the CredentialList's sid.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Request Body schema: application/x-www-form-urlencoded
required
CredentialListSid
required
string^CL[0-9a-f]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List CredentialList mappings on a SIP Domain (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "credential_list_mappings": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a CredentialList mapping on a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Unmap a CredentialList from a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / Domains / IpAccessControlListMappings

Map an IpAccessControlList onto a SIP Domain

Binds an existing IpAccessControlList (AL…) to the Domain. The response echoes the mapped list's shape; the mapping's sid IS the IpAccessControlList's sid.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Request Body schema: application/x-www-form-urlencoded
required
IpAccessControlListSid
required
string^AL[0-9a-f]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List IpAccessControlList mappings on a SIP Domain (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "ip_access_control_list_mappings": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch an IpAccessControlList mapping on a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Unmap an IpAccessControlList from a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / Auth / Calls / CredentialListMappings

Map a CredentialList onto a SIP Domain's call authentication

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Request Body schema: application/x-www-form-urlencoded
required
CredentialListSid
required
string^CL[0-9a-f]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List call-auth CredentialList mappings on a SIP Domain (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "credential_list_mappings": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a call-auth CredentialList mapping on a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Unmap a call-auth CredentialList from a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / Auth / Calls / IpAccessControlListMappings

Map an IpAccessControlList onto a SIP Domain's call authentication

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Request Body schema: application/x-www-form-urlencoded
required
IpAccessControlListSid
required
string^AL[0-9a-f]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List call-auth IpAccessControlList mappings on a SIP Domain (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "ip_access_control_list_mappings": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a call-auth IpAccessControlList mapping on a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Unmap a call-auth IpAccessControlList from a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / Auth / Registrations / CredentialListMappings

Map a CredentialList onto a SIP Domain's registration authentication

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Request Body schema: application/x-www-form-urlencoded
required
CredentialListSid
required
string^CL[0-9a-f]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List registration-auth CredentialList mappings on a SIP Domain (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "credential_list_mappings": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a registration-auth CredentialList mapping on a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "string",
  • "domain_sid": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Unmap a registration-auth CredentialList from a SIP Domain

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

DomainSid
required
string^SD[0-9a-f]{32}$

Twilio-compatible SIP Domain SID — literal "SD" + 32 hex chars (34 total). Names the parent Domain in a Domain mapping sub-resource path. Matches Twilio's DomainSid path-parameter name for the nested mapping surfaces.

Sid
required
string^(CL|AL)[0-9a-f]{32}$

The mapped list's SID on a SIP Domain mapping leaf. A CredentialList mapping carries a CL… sid; an IpAccessControlList mapping carries an AL… sid. The mapping's own sid IS the mapped list's sid (Twilio semantics).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / CredentialLists

Create a SIP CredentialList

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "office-handsets",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

List SIP CredentialLists for the account (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
FriendlyName
string

Filter to CredentialLists with this exact FriendlyName.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "credential_lists": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a SIP CredentialList

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^CL[0-9a-f]{32}$

Twilio-compatible SIP CredentialList SID — literal "CL" + 32 hex chars (34 total). Server-generated on POST /SIP/CredentialLists. Also names the parent list in the Credentials sub-resource path.

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "office-handsets",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Update a SIP CredentialList (partial — only set fields are touched)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^CL[0-9a-f]{32}$

Twilio-compatible SIP CredentialList SID — literal "CL" + 32 hex chars (34 total). Server-generated on POST /SIP/CredentialLists. Also names the parent list in the Credentials sub-resource path.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "sid": "CL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "office-handsets",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Delete a SIP CredentialList

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^CL[0-9a-f]{32}$

Twilio-compatible SIP CredentialList SID — literal "CL" + 32 hex chars (34 total). Server-generated on POST /SIP/CredentialLists. Also names the parent list in the Credentials sub-resource path.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / CredentialLists / Credentials

Create a SIP Credential under a CredentialList

Username and Password are both required. Password is write-only — it is accepted here but never echoed back on any response.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CredentialListSid
required
string^CL[0-9a-f]{32}$

Twilio-compatible SIP CredentialList SID — literal "CL" + 32 hex chars (34 total). Names the parent CredentialList in the Credentials sub-resource path. Matches Twilio's CredentialListSid path-parameter name.

Request Body schema: application/x-www-form-urlencoded
required
Username
required
string
Password
required
string

Write-only — never returned on any response.

Responses

Response samples

Content type
application/json
{
  • "sid": "CR0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "credential_list_sid": "string",
  • "username": "alice",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List SIP Credentials under a CredentialList (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CredentialListSid
required
string^CL[0-9a-f]{32}$

Twilio-compatible SIP CredentialList SID — literal "CL" + 32 hex chars (34 total). Names the parent CredentialList in the Credentials sub-resource path. Matches Twilio's CredentialListSid path-parameter name.

query Parameters
Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "credentials": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a SIP Credential

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CredentialListSid
required
string^CL[0-9a-f]{32}$

Twilio-compatible SIP CredentialList SID — literal "CL" + 32 hex chars (34 total). Names the parent CredentialList in the Credentials sub-resource path. Matches Twilio's CredentialListSid path-parameter name.

Sid
required
string^CR[0-9a-f]{32}$

Twilio-compatible SIP Credential SID — literal "CR" + 32 hex chars (34 total). Server-generated on POST /SIP/CredentialLists/{CredentialListSid}/Credentials.

Responses

Response samples

Content type
application/json
{
  • "sid": "CR0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "credential_list_sid": "string",
  • "username": "alice",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Update a SIP Credential (rotate Password; Username is immutable)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CredentialListSid
required
string^CL[0-9a-f]{32}$

Twilio-compatible SIP CredentialList SID — literal "CL" + 32 hex chars (34 total). Names the parent CredentialList in the Credentials sub-resource path. Matches Twilio's CredentialListSid path-parameter name.

Sid
required
string^CR[0-9a-f]{32}$

Twilio-compatible SIP Credential SID — literal "CR" + 32 hex chars (34 total). Server-generated on POST /SIP/CredentialLists/{CredentialListSid}/Credentials.

Request Body schema: application/x-www-form-urlencoded
required
Password
string

Write-only — never returned on any response.

Responses

Response samples

Content type
application/json
{
  • "sid": "CR0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "credential_list_sid": "string",
  • "username": "alice",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Delete a SIP Credential

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

CredentialListSid
required
string^CL[0-9a-f]{32}$

Twilio-compatible SIP CredentialList SID — literal "CL" + 32 hex chars (34 total). Names the parent CredentialList in the Credentials sub-resource path. Matches Twilio's CredentialListSid path-parameter name.

Sid
required
string^CR[0-9a-f]{32}$

Twilio-compatible SIP Credential SID — literal "CR" + 32 hex chars (34 total). Server-generated on POST /SIP/CredentialLists/{CredentialListSid}/Credentials.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / IpAccessControlLists

Create a SIP IpAccessControlList

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "sid": "AL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "carrier-allowlist",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

List SIP IpAccessControlLists for the account (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
FriendlyName
string

Filter to IpAccessControlLists with this exact FriendlyName.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "ip_access_control_lists": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a SIP IpAccessControlList

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^AL[0-9a-f]{32}$

Twilio-compatible SIP IpAccessControlList SID — literal "AL" + 32 hex chars (34 total). Server-generated on POST /SIP/IpAccessControlLists. Also names the parent list in the IpAddresses sub-resource path.

Responses

Response samples

Content type
application/json
{
  • "sid": "AL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "carrier-allowlist",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Update a SIP IpAccessControlList (partial — only set fields are touched)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^AL[0-9a-f]{32}$

Twilio-compatible SIP IpAccessControlList SID — literal "AL" + 32 hex chars (34 total). Server-generated on POST /SIP/IpAccessControlLists. Also names the parent list in the IpAddresses sub-resource path.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "sid": "AL0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "friendly_name": "carrier-allowlist",
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string",
  • "subresource_uris": {
    }
}

Delete a SIP IpAccessControlList

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^AL[0-9a-f]{32}$

Twilio-compatible SIP IpAccessControlList SID — literal "AL" + 32 hex chars (34 total). Server-generated on POST /SIP/IpAccessControlLists. Also names the parent list in the IpAddresses sub-resource path.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

SIP / IpAccessControlLists / IpAddresses

Create a SIP IpAddress under an IpAccessControlList

FriendlyName and IpAddress are both required. CidrPrefixLength defaults to 32 (single host) when omitted.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

IpAccessControlListSid
required
string^AL[0-9a-f]{32}$

Twilio-compatible SIP IpAccessControlList SID — literal "AL" + 32 hex chars (34 total). Names the parent IpAccessControlList in the IpAddresses sub-resource path. Matches Twilio's IpAccessControlListSid path-parameter name.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
required
string
IpAddress
required
string
CidrPrefixLength
integer

Responses

Response samples

Content type
application/json
{
  • "sid": "IP0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "ip_access_control_list_sid": "string",
  • "friendly_name": "carrier-edge-1",
  • "ip_address": "203.0.113.10",
  • "cidr_prefix_length": 32,
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

List SIP IpAddresses under an IpAccessControlList (paged)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

IpAccessControlListSid
required
string^AL[0-9a-f]{32}$

Twilio-compatible SIP IpAccessControlList SID — literal "AL" + 32 hex chars (34 total). Names the parent IpAccessControlList in the IpAddresses sub-resource path. Matches Twilio's IpAccessControlListSid path-parameter name.

query Parameters
FriendlyName
string

Filter to IpAddresses with this exact FriendlyName.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "ip_addresses": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a SIP IpAddress

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

IpAccessControlListSid
required
string^AL[0-9a-f]{32}$

Twilio-compatible SIP IpAccessControlList SID — literal "AL" + 32 hex chars (34 total). Names the parent IpAccessControlList in the IpAddresses sub-resource path. Matches Twilio's IpAccessControlListSid path-parameter name.

Sid
required
string^IP[0-9a-f]{32}$

Twilio-compatible SIP IpAddress SID — literal "IP" + 32 hex chars (34 total). Server-generated on POST /SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.

Responses

Response samples

Content type
application/json
{
  • "sid": "IP0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "ip_access_control_list_sid": "string",
  • "friendly_name": "carrier-edge-1",
  • "ip_address": "203.0.113.10",
  • "cidr_prefix_length": 32,
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Update a SIP IpAddress (partial — only set fields are touched)

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

IpAccessControlListSid
required
string^AL[0-9a-f]{32}$

Twilio-compatible SIP IpAccessControlList SID — literal "AL" + 32 hex chars (34 total). Names the parent IpAccessControlList in the IpAddresses sub-resource path. Matches Twilio's IpAccessControlListSid path-parameter name.

Sid
required
string^IP[0-9a-f]{32}$

Twilio-compatible SIP IpAddress SID — literal "IP" + 32 hex chars (34 total). Server-generated on POST /SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.

Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
string
IpAddress
string
CidrPrefixLength
integer

Responses

Response samples

Content type
application/json
{
  • "sid": "IP0123456789abcdef0123456789abcdef",
  • "account_sid": "string",
  • "ip_access_control_list_sid": "string",
  • "friendly_name": "carrier-edge-1",
  • "ip_address": "203.0.113.10",
  • "cidr_prefix_length": 32,
  • "date_created": "string",
  • "date_updated": "string",
  • "uri": "string"
}

Delete a SIP IpAddress

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

IpAccessControlListSid
required
string^AL[0-9a-f]{32}$

Twilio-compatible SIP IpAccessControlList SID — literal "AL" + 32 hex chars (34 total). Names the parent IpAccessControlList in the IpAddresses sub-resource path. Matches Twilio's IpAccessControlListSid path-parameter name.

Sid
required
string^IP[0-9a-f]{32}$

Twilio-compatible SIP IpAddress SID — literal "IP" + 32 hex chars (34 total). Server-generated on POST /SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Voice trunking / IpRecords

Create an IpRecord

Creates a Voice v1 IpRecord (a standalone allowed source IP) for the authenticated account. IpAddress is required; CidrPrefixLength defaults to 32 (a single host).

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
IpAddress
required
string

The allowed source IPv4 address.

FriendlyName
string
CidrPrefixLength
integer

CIDR prefix length (0-32). Defaults to 32.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "IL0123456789abcdef0123456789abcdef",
  • "friendly_name": "carrier-a",
  • "ip_address": "203.0.113.10",
  • "cidr_prefix_length": 32,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

List IpRecords

Paginated list of the authenticated account's IpRecords.

Authorizations:
basicAuth
query Parameters
PageSize
integer

Maximum rows per page (default 50, max 1000).

Responses

Response samples

Content type
application/json
{
  • "ip_records": [
    ],
  • "meta": {}
}

Fetch an IpRecord

Authorizations:
basicAuth
path Parameters
Sid
required
string^IL[0-9a-fA-F]{32}$

The IpRecord sid.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "IL0123456789abcdef0123456789abcdef",
  • "friendly_name": "carrier-a",
  • "ip_address": "203.0.113.10",
  • "cidr_prefix_length": 32,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Update an IpRecord

Updates an IpRecord's FriendlyName. Only FriendlyName is mutable.

Authorizations:
basicAuth
path Parameters
Sid
required
string^IL[0-9a-fA-F]{32}$

The IpRecord sid.

Request Body schema: application/x-www-form-urlencoded
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "IL0123456789abcdef0123456789abcdef",
  • "friendly_name": "carrier-a",
  • "ip_address": "203.0.113.10",
  • "cidr_prefix_length": 32,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Delete an IpRecord

Authorizations:
basicAuth
path Parameters
Sid
required
string^IL[0-9a-fA-F]{32}$

The IpRecord sid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Voice trunking / SourceIpMappings

Create a SourceIpMapping

Maps an IpRecord to a SIP Domain so inbound calls from that source IP route to the domain. Both IpRecordSid and SipDomainSid are required.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
IpRecordSid
required
string

The IpRecord sid (IL...).

SipDomainSid
required
string

The SIP Domain sid (SD...).

Responses

Response samples

Content type
application/json
{
  • "sid": "IB0123456789abcdef0123456789abcdef",
  • "ip_record_sid": "string",
  • "sip_domain_sid": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

List SourceIpMappings

Paginated list of the authenticated account's SourceIpMappings.

Authorizations:
basicAuth
query Parameters
PageSize
integer

Maximum rows per page (default 50, max 1000).

Responses

Response samples

Content type
application/json
{}

Fetch a SourceIpMapping

Authorizations:
basicAuth
path Parameters
Sid
required
string^IB[0-9a-fA-F]{32}$

The SourceIpMapping sid.

Responses

Response samples

Content type
application/json
{
  • "sid": "IB0123456789abcdef0123456789abcdef",
  • "ip_record_sid": "string",
  • "sip_domain_sid": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Update a SourceIpMapping

Re-points a SourceIpMapping at a different SIP Domain. Only SipDomainSid is mutable.

Authorizations:
basicAuth
path Parameters
Sid
required
string^IB[0-9a-fA-F]{32}$

The SourceIpMapping sid.

Request Body schema: application/x-www-form-urlencoded
required
SipDomainSid
required
string

The SIP Domain sid (SD...).

Responses

Response samples

Content type
application/json
{
  • "sid": "IB0123456789abcdef0123456789abcdef",
  • "ip_record_sid": "string",
  • "sip_domain_sid": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Delete a SourceIpMapping

Authorizations:
basicAuth
path Parameters
Sid
required
string^IB[0-9a-fA-F]{32}$

The SourceIpMapping sid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Voice trunking / ByocTrunks

Create a ByocTrunk

Creates a bring-your-own-carrier trunk for the authenticated account. All fields optional.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
VoiceUrl
string
VoiceMethod
string
Enum: "GET" "POST"
VoiceFallbackUrl
string
VoiceFallbackMethod
string
Enum: "GET" "POST"
StatusCallbackUrl
string
StatusCallbackMethod
string
Enum: "GET" "POST"
CnamLookupEnabled
boolean
ConnectionPolicySid
string
FromDomainSid
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "BY0123456789abcdef0123456789abcdef",
  • "friendly_name": "carrier-x",
  • "voice_url": "http://example.com",
  • "voice_method": "GET",
  • "voice_fallback_url": "http://example.com",
  • "voice_fallback_method": "GET",
  • "status_callback_url": "http://example.com",
  • "status_callback_method": "GET",
  • "cnam_lookup_enabled": true,
  • "connection_policy_sid": "string",
  • "from_domain_sid": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

List ByocTrunks

Authorizations:
basicAuth
query Parameters
PageSize
integer

Maximum rows per page (default 50, max 1000).

Responses

Response samples

Content type
application/json
{}

Fetch a ByocTrunk

Authorizations:
basicAuth
path Parameters
Sid
required
string^BY[0-9a-fA-F]{32}$

The ByocTrunk sid.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "BY0123456789abcdef0123456789abcdef",
  • "friendly_name": "carrier-x",
  • "voice_url": "http://example.com",
  • "voice_method": "GET",
  • "voice_fallback_url": "http://example.com",
  • "voice_fallback_method": "GET",
  • "status_callback_url": "http://example.com",
  • "status_callback_method": "GET",
  • "cnam_lookup_enabled": true,
  • "connection_policy_sid": "string",
  • "from_domain_sid": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Update a ByocTrunk

Updates a ByocTrunk. Only set fields are changed.

Authorizations:
basicAuth
path Parameters
Sid
required
string^BY[0-9a-fA-F]{32}$

The ByocTrunk sid.

Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
VoiceUrl
string
VoiceMethod
string
Enum: "GET" "POST"
VoiceFallbackUrl
string
VoiceFallbackMethod
string
Enum: "GET" "POST"
StatusCallbackUrl
string
StatusCallbackMethod
string
Enum: "GET" "POST"
CnamLookupEnabled
boolean
ConnectionPolicySid
string
FromDomainSid
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "BY0123456789abcdef0123456789abcdef",
  • "friendly_name": "carrier-x",
  • "voice_url": "http://example.com",
  • "voice_method": "GET",
  • "voice_fallback_url": "http://example.com",
  • "voice_fallback_method": "GET",
  • "status_callback_url": "http://example.com",
  • "status_callback_method": "GET",
  • "cnam_lookup_enabled": true,
  • "connection_policy_sid": "string",
  • "from_domain_sid": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Delete a ByocTrunk

Authorizations:
basicAuth
path Parameters
Sid
required
string^BY[0-9a-fA-F]{32}$

The ByocTrunk sid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Voice trunking / ConnectionPolicies

Create a ConnectionPolicy

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "NY0123456789abcdef0123456789abcdef",
  • "friendly_name": "origination-policy",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": {
    }
}

List ConnectionPolicies

Authorizations:
basicAuth
query Parameters
PageSize
integer

Maximum rows per page (default 50, max 1000).

Responses

Response samples

Content type
application/json
{
  • "connection_policies": [
    ],
  • "meta": {}
}

Fetch a ConnectionPolicy

Authorizations:
basicAuth
path Parameters
ConnectionPolicySid
required
string^NY[0-9a-fA-F]{32}$

The ConnectionPolicy sid.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "NY0123456789abcdef0123456789abcdef",
  • "friendly_name": "origination-policy",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": {
    }
}

Update a ConnectionPolicy

Authorizations:
basicAuth
path Parameters
ConnectionPolicySid
required
string^NY[0-9a-fA-F]{32}$

The ConnectionPolicy sid.

Request Body schema: application/x-www-form-urlencoded
FriendlyName
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "sid": "NY0123456789abcdef0123456789abcdef",
  • "friendly_name": "origination-policy",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": {
    }
}

Delete a ConnectionPolicy

Authorizations:
basicAuth
path Parameters
ConnectionPolicySid
required
string^NY[0-9a-fA-F]{32}$

The ConnectionPolicy sid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Create a ConnectionPolicy Target

Authorizations:
basicAuth
path Parameters
ConnectionPolicySid
required
string^NY[0-9a-fA-F]{32}$

The parent ConnectionPolicy sid.

Request Body schema: application/x-www-form-urlencoded
required
Target
required
string

The SIP URI target.

FriendlyName
string
Priority
integer

Lower = higher priority. Default 10.

Weight
integer

Load-balancing weight among equal priorities. Default 10.

Enabled
boolean

Whether the target is active. Default true.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "connection_policy_sid": "string",
  • "sid": "NE0123456789abcdef0123456789abcdef",
  • "friendly_name": "string",
  • "target": "sip:edge@example.com",
  • "priority": 10,
  • "weight": 10,
  • "enabled": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

List ConnectionPolicy Targets

Authorizations:
basicAuth
path Parameters
ConnectionPolicySid
required
string^NY[0-9a-fA-F]{32}$

The parent ConnectionPolicy sid.

query Parameters
PageSize
integer

Maximum rows per page (default 50, max 1000).

Responses

Response samples

Content type
application/json
{
  • "targets": [
    ],
  • "meta": {}
}

Fetch a ConnectionPolicy Target

Authorizations:
basicAuth
path Parameters
ConnectionPolicySid
required
string^NY[0-9a-fA-F]{32}$

The parent ConnectionPolicy sid.

Sid
required
string^NE[0-9a-fA-F]{32}$

The Target sid.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "connection_policy_sid": "string",
  • "sid": "NE0123456789abcdef0123456789abcdef",
  • "friendly_name": "string",
  • "target": "sip:edge@example.com",
  • "priority": 10,
  • "weight": 10,
  • "enabled": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Update a ConnectionPolicy Target

Authorizations:
basicAuth
path Parameters
ConnectionPolicySid
required
string^NY[0-9a-fA-F]{32}$

The parent ConnectionPolicy sid.

Sid
required
string^NE[0-9a-fA-F]{32}$

The Target sid.

Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
Target
string
Priority
integer
Weight
integer
Enabled
boolean

Responses

Response samples

Content type
application/json
{
  • "account_sid": "string",
  • "connection_policy_sid": "string",
  • "sid": "NE0123456789abcdef0123456789abcdef",
  • "friendly_name": "string",
  • "target": "sip:edge@example.com",
  • "priority": 10,
  • "weight": 10,
  • "enabled": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Delete a ConnectionPolicy Target

Authorizations:
basicAuth
path Parameters
ConnectionPolicySid
required
string^NY[0-9a-fA-F]{32}$

The parent ConnectionPolicy sid.

Sid
required
string^NE[0-9a-fA-F]{32}$

The Target sid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Voice trunking / DialingPermissions

Fetch DialingPermissions Settings

Returns the authenticated account's dialing-permissions inheritance setting. Defaults to false when never set.

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{}

Update DialingPermissions Settings

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
DialingPermissionsInheritance
boolean

Whether subaccounts inherit the parent's dialing permissions.

Responses

Response samples

Content type
application/json
{}

Conversations

Create a Conversation

Creates a Conversation (a stateful messaging thread) for the authenticated account. All fields are optional; State defaults to active and Attributes to {}.

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
UniqueName
string
MessagingServiceSid
string

Messaging Service sid (MG...).

Attributes
string

JSON metadata string. Defaults to {}.

State
string
Enum: "initializing" "inactive" "active" "closed"
Timers.Inactive
string

ISO-8601 duration before the conversation is marked inactive.

Timers.Closed
string

ISO-8601 duration before the conversation is closed.

Bindings.Email.Address
string
Bindings.Email.Name
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "messaging_service_sid": "stringstringstringstringstringstri",
  • "sid": "CH0123456789abcdef0123456789abcdef",
  • "friendly_name": "Support thread",
  • "unique_name": "string",
  • "attributes": "{}",
  • "state": "initializing",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "timers": { },
  • "url": "http://example.com",
  • "links": { },
  • "bindings": { }
}

List Conversations

Paginated list of the authenticated account's Conversations.

Authorizations:
basicAuth
query Parameters
PageSize
integer

Maximum rows per page (default 50, max 1000).

Responses

Response samples

Content type
application/json
{
  • "conversations": [
    ],
  • "meta": {}
}

Fetch a Conversation

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

The Conversation sid.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "messaging_service_sid": "stringstringstringstringstringstri",
  • "sid": "CH0123456789abcdef0123456789abcdef",
  • "friendly_name": "Support thread",
  • "unique_name": "string",
  • "attributes": "{}",
  • "state": "initializing",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "timers": { },
  • "url": "http://example.com",
  • "links": { },
  • "bindings": { }
}

Update a Conversation

Updates a Conversation's mutable fields.

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

The Conversation sid.

Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
UniqueName
string
MessagingServiceSid
string
Attributes
string
State
string
Enum: "initializing" "inactive" "active" "closed"
Timers.Inactive
string
Timers.Closed
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "messaging_service_sid": "stringstringstringstringstringstri",
  • "sid": "CH0123456789abcdef0123456789abcdef",
  • "friendly_name": "Support thread",
  • "unique_name": "string",
  • "attributes": "{}",
  • "state": "initializing",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "timers": { },
  • "url": "http://example.com",
  • "links": { },
  • "bindings": { }
}

Delete a Conversation

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

The Conversation sid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Create a Conversation with initial Participants

Creates a conversation and its initial participants in one call. The Participant parameter is repeated; each value is a JSON object describing one participant (identity or messaging_binding).

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
UniqueName
string
MessagingServiceSid
string
Attributes
string
State
string
Enum: "initializing" "inactive" "active" "closed"
Timers.Inactive
string
Timers.Closed
string
Participant
Array of strings

Repeated; each a JSON participant spec.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "messaging_service_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "unique_name": "string",
  • "attributes": "string",
  • "state": "initializing",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "timers": { },
  • "links": { },
  • "bindings": { },
  • "url": "http://example.com"
}

Conversations / Messages

Create a Conversation Message

Adds a message to the conversation. The server assigns the next monotonic index. All fields are optional; Attributes defaults to {}.

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

The parent Conversation sid.

Request Body schema: application/x-www-form-urlencoded
Author
string
Body
string
Attributes
string
ContentSid
string

Content template sid (HX...).

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "IMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "index": 0,
  • "author": "+15551234567",
  • "body": "Hello",
  • "media": [
    ],
  • "attributes": "{}",
  • "participant_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "delivery": { },
  • "links": { },
  • "content_sid": "stringstringstringstringstringstri"
}

List Conversation Messages

Paginated list of the conversation's messages, ordered by index.

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

The parent Conversation sid.

query Parameters
PageSize
integer

Maximum rows per page (default 50, max 1000).

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "meta": {}
}

Fetch a Conversation Message

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

The parent Conversation sid.

MessageSid
required
string^IM[0-9a-fA-F]{32}$

The Message sid.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "IMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "index": 0,
  • "author": "+15551234567",
  • "body": "Hello",
  • "media": [
    ],
  • "attributes": "{}",
  • "participant_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "delivery": { },
  • "links": { },
  • "content_sid": "stringstringstringstringstringstri"
}

Update a Conversation Message

Updates a Message's Author, Body, or Attributes.

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

The parent Conversation sid.

MessageSid
required
string^IM[0-9a-fA-F]{32}$

The Message sid.

Request Body schema: application/x-www-form-urlencoded
Author
string
Body
string
Attributes
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "IMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "index": 0,
  • "author": "+15551234567",
  • "body": "Hello",
  • "media": [
    ],
  • "attributes": "{}",
  • "participant_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "delivery": { },
  • "links": { },
  • "content_sid": "stringstringstringstringstringstri"
}

Delete a Conversation Message

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

The parent Conversation sid.

MessageSid
required
string^IM[0-9a-fA-F]{32}$

The Message sid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

List Message Receipts

Paginated list of the message's per-channel delivery receipts (read-only).

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
MessageSid
required
string^IM[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "delivery_receipts": [
    ],
  • "meta": {}
}

Fetch a Message Receipt

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
MessageSid
required
string^IM[0-9a-fA-F]{32}$
Sid
required
string^DY[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "DY0123456789abcdef0123456789abcdef",
  • "message_sid": "stringstringstringstringstringstri",
  • "channel_message_sid": "stringstringstringstringstringstri",
  • "participant_sid": "stringstringstringstringstringstri",
  • "status": "read",
  • "error_code": 0,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Conversations / Participants

Create a Conversation Participant

Adds a participant to the conversation — a chat Identity or an SMS MessagingBinding.Address. Attributes defaults to {}.

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Identity
string
Attributes
string
RoleSid
string
MessagingBinding.Address
string
MessagingBinding.ProxyAddress
string
MessagingBinding.ProjectedAddress
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "MB0123456789abcdef0123456789abcdef",
  • "identity": "string",
  • "attributes": "{}",
  • "messaging_binding": { },
  • "role_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "last_read_message_index": 0,
  • "last_read_timestamp": "string"
}

List Conversation Participants

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "participants": [
    ],
  • "meta": {}
}

Fetch a Conversation Participant

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
ParticipantSid
required
string^MB[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "MB0123456789abcdef0123456789abcdef",
  • "identity": "string",
  • "attributes": "{}",
  • "messaging_binding": { },
  • "role_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "last_read_message_index": 0,
  • "last_read_timestamp": "string"
}

Update a Conversation Participant

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
ParticipantSid
required
string^MB[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Identity
string
Attributes
string
RoleSid
string
LastReadMessageIndex
integer
LastReadTimestamp
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "MB0123456789abcdef0123456789abcdef",
  • "identity": "string",
  • "attributes": "{}",
  • "messaging_binding": { },
  • "role_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "last_read_message_index": 0,
  • "last_read_timestamp": "string"
}

Delete a Conversation Participant

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
ParticipantSid
required
string^MB[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

List a participant's Conversations

Lists the conversations a participant belongs to, optionally filtered by Identity or messaging-binding Address.

Authorizations:
basicAuth
query Parameters
Identity
string
Address
string
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "conversations": [
    ],
  • "meta": {}
}

Conversations / Webhooks

Create a Conversation Scoped Webhook

Adds a conversation-scoped webhook. Target is required and must be one of webhook, trigger, or studio.

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
required
Target
required
string
Enum: "webhook" "trigger" "studio"
Configuration.Url
string
Configuration.Method
string
Enum: "GET" "POST"
Configuration.FlowSid
string
Configuration.ReplayAfter
integer

Responses

Response samples

Content type
application/json
{
  • "sid": "WH0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "target": "webhook",
  • "url": "http://example.com",
  • "configuration": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

List Conversation Scoped Webhooks

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "webhooks": [
    ],
  • "meta": {}
}

Fetch a Conversation Scoped Webhook

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
WebhookSid
required
string^WH[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "WH0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "target": "webhook",
  • "url": "http://example.com",
  • "configuration": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Update a Conversation Scoped Webhook

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
WebhookSid
required
string^WH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Configuration.Url
string
Configuration.Method
string
Enum: "GET" "POST"
Configuration.FlowSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "WH0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "target": "webhook",
  • "url": "http://example.com",
  • "configuration": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Delete a Conversation Scoped Webhook

Authorizations:
basicAuth
path Parameters
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
WebhookSid
required
string^WH[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Conversations / Roles

Create a Role

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
required
string
Type
required
string
Enum: "conversation" "service"
Permission
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "sid": "RL0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "conversation",
  • "permissions": [
    ],
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

List Roles

Authorizations:
basicAuth
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ],
  • "meta": {}
}

Fetch a Role

Authorizations:
basicAuth
path Parameters
Sid
required
string^RL[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "RL0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "conversation",
  • "permissions": [
    ],
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Update a Role

Authorizations:
basicAuth
path Parameters
Sid
required
string^RL[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
required
Permission
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "sid": "RL0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "conversation",
  • "permissions": [
    ],
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Delete a Role

Authorizations:
basicAuth
path Parameters
Sid
required
string^RL[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Conversations / Users

Create a User

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
Identity
required
string
FriendlyName
string
Attributes
string
RoleSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "USxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "role_sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "friendly_name": "string",
  • "attributes": "{}",
  • "is_online": true,
  • "is_notifiable": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": { }
}

List Users

Authorizations:
basicAuth
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "meta": {}
}

Fetch a User

Authorizations:
basicAuth
path Parameters
Sid
required
string^US[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "USxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "role_sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "friendly_name": "string",
  • "attributes": "{}",
  • "is_online": true,
  • "is_notifiable": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": { }
}

Update a User

Authorizations:
basicAuth
path Parameters
Sid
required
string^US[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
Attributes
string
RoleSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "USxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "role_sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "friendly_name": "string",
  • "attributes": "{}",
  • "is_online": true,
  • "is_notifiable": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": { }
}

Delete a User

Authorizations:
basicAuth
path Parameters
Sid
required
string^US[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

List a User's Conversations

Authorizations:
basicAuth
path Parameters
Sid
required
string^US[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "conversations": [
    ],
  • "meta": {}
}

Fetch a User's Conversation

Authorizations:
basicAuth
path Parameters
Sid
required
string^US[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "unread_messages_count": 0,
  • "last_read_message_index": 0,
  • "participant_sid": "stringstringstringstringstringstri",
  • "user_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "conversation_state": "inactive",
  • "timers": { },
  • "attributes": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "notification_level": "default",
  • "unique_name": "string",
  • "url": "http://example.com",
  • "links": { }
}

Update a User's Conversation state

Authorizations:
basicAuth
path Parameters
Sid
required
string^US[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
NotificationLevel
string
Enum: "default" "muted"
LastReadMessageIndex
integer
LastReadTimestamp
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "unread_messages_count": 0,
  • "last_read_message_index": 0,
  • "participant_sid": "stringstringstringstringstringstri",
  • "user_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "conversation_state": "inactive",
  • "timers": { },
  • "attributes": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "notification_level": "default",
  • "unique_name": "string",
  • "url": "http://example.com",
  • "links": { }
}

Remove a User from a Conversation

Authorizations:
basicAuth
path Parameters
Sid
required
string^US[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Conversations / Credentials

Create a push Credential

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
Type
required
string
Enum: "apn" "gcm" "fcm"
FriendlyName
string
Certificate
string
PrivateKey
string
Sandbox
boolean
ApiKey
string
Secret
string

Responses

Response samples

Content type
application/json
{
  • "sid": "CR0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "apn",
  • "sandbox": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

List push Credentials

Authorizations:
basicAuth
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "credentials": [
    ],
  • "meta": {}
}

Fetch a push Credential

Authorizations:
basicAuth
path Parameters
Sid
required
string^CR[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "CR0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "apn",
  • "sandbox": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Update a push Credential

Authorizations:
basicAuth
path Parameters
Sid
required
string^CR[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Type
string
Enum: "apn" "gcm" "fcm"
FriendlyName
string
Certificate
string
PrivateKey
string
Sandbox
boolean
ApiKey
string
Secret
string

Responses

Response samples

Content type
application/json
{
  • "sid": "CR0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "apn",
  • "sandbox": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Delete a push Credential

Authorizations:
basicAuth
path Parameters
Sid
required
string^CR[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Conversations / Configuration

Fetch the account's Conversations Configuration

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "default_chat_service_sid": "stringstringstringstringstringstri",
  • "default_messaging_service_sid": "stringstringstringstringstringstri",
  • "default_inactive_timer": "string",
  • "default_closed_timer": "string",
  • "url": "http://example.com",
  • "links": { }
}

Update the account's Conversations Configuration

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
DefaultChatServiceSid
string
DefaultMessagingServiceSid
string
DefaultInactiveTimer
string
DefaultClosedTimer
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "default_chat_service_sid": "stringstringstringstringstringstri",
  • "default_messaging_service_sid": "stringstringstringstringstringstri",
  • "default_inactive_timer": "string",
  • "default_closed_timer": "string",
  • "url": "http://example.com",
  • "links": { }
}

Fetch the account-global Conversation webhook config

Authorizations:
basicAuth

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "method": "GET",
  • "filters": [
    ],
  • "pre_webhook_url": "string",
  • "post_webhook_url": "string",
  • "target": "webhook",
  • "url": "http://example.com"
}

Update the account-global Conversation webhook config

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
Method
string
Enum: "GET" "POST"
Filters
Array of strings
PreWebhookUrl
string
PostWebhookUrl
string
Target
string
Enum: "webhook" "flex"

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "method": "GET",
  • "filters": [
    ],
  • "pre_webhook_url": "string",
  • "post_webhook_url": "string",
  • "target": "webhook",
  • "url": "http://example.com"
}

Create a Configuration Address

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
Type
required
string
Enum: "sms" "whatsapp" "messenger" "gbm" "email" "rcs" "apple" "chat"
Address
required
string
FriendlyName
string
AutoCreation.Enabled
boolean
AutoCreation.Type
string
Enum: "webhook" "studio" "default"
AutoCreation.WebhookUrl
string
AddressCountry
string

Responses

Response samples

Content type
application/json
{
  • "sid": "IG0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "type": "sms",
  • "address": "string",
  • "friendly_name": "string",
  • "auto_creation": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "address_country": "string"
}

List Configuration Addresses

Authorizations:
basicAuth
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ],
  • "meta": {}
}

Fetch a Configuration Address

Authorizations:
basicAuth
path Parameters
Sid
required
string^IG[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "IG0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "type": "sms",
  • "address": "string",
  • "friendly_name": "string",
  • "auto_creation": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "address_country": "string"
}

Update a Configuration Address

Authorizations:
basicAuth
path Parameters
Sid
required
string^IG[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
AutoCreation.Enabled
boolean
AutoCreation.Type
string
Enum: "webhook" "studio" "default"
AutoCreation.WebhookUrl
string

Responses

Response samples

Content type
application/json
{
  • "sid": "IG0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "type": "sms",
  • "address": "string",
  • "friendly_name": "string",
  • "auto_creation": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "address_country": "string"
}

Delete a Configuration Address

Authorizations:
basicAuth
path Parameters
Sid
required
string^IG[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Conversations / Services

Create a Conversation Service

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "IS0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": { }
}

List Conversation Services

Authorizations:
basicAuth
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "services": [
    ],
  • "meta": {}
}

Fetch a Conversation Service

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "IS0123456789abcdef0123456789abcdef",
  • "account_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": { }
}

Delete a Conversation Service

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Create a service-scoped Conversation

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
UniqueName
string
MessagingServiceSid
string
Attributes
string
State
string
Enum: "initializing" "inactive" "active" "closed"
Timers.Inactive
string
Timers.Closed
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "messaging_service_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "unique_name": "string",
  • "attributes": "string",
  • "state": "initializing",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "timers": { },
  • "url": "http://example.com",
  • "links": { },
  • "bindings": { }
}

List service-scoped Conversations

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "conversations": [
    ],
  • "meta": {}
}

Fetch a service-scoped Conversation

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "messaging_service_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "unique_name": "string",
  • "attributes": "string",
  • "state": "initializing",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "timers": { },
  • "url": "http://example.com",
  • "links": { },
  • "bindings": { }
}

Update a service-scoped Conversation

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
UniqueName
string
Attributes
string
State
string
Enum: "initializing" "inactive" "active" "closed"
Timers.Inactive
string
Timers.Closed
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "messaging_service_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "unique_name": "string",
  • "attributes": "string",
  • "state": "initializing",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "timers": { },
  • "url": "http://example.com",
  • "links": { },
  • "bindings": { }
}

Delete a service-scoped Conversation

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Create a service-scoped Conversation Message

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Author
string
Body
string
Attributes
string
ContentSid
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "index": 0,
  • "author": "string",
  • "body": "string",
  • "media": [
    ],
  • "attributes": "string",
  • "participant_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "delivery": { },
  • "links": { },
  • "content_sid": "stringstringstringstringstringstri"
}

List service-scoped Conversation Messages

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "meta": {}
}

Fetch a service-scoped Conversation Message

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
MessageSid
required
string^IM[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "index": 0,
  • "author": "string",
  • "body": "string",
  • "media": [
    ],
  • "attributes": "string",
  • "participant_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "delivery": { },
  • "links": { },
  • "content_sid": "stringstringstringstringstringstri"
}

Update a service-scoped Conversation Message

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
MessageSid
required
string^IM[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Author
string
Body
string
Attributes
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "index": 0,
  • "author": "string",
  • "body": "string",
  • "media": [
    ],
  • "attributes": "string",
  • "participant_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "delivery": { },
  • "links": { },
  • "content_sid": "stringstringstringstringstringstri"
}

Delete a service-scoped Conversation Message

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
MessageSid
required
string^IM[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Create a service-scoped Participant

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Identity
string
Attributes
string
RoleSid
string
MessagingBinding.Address
string
MessagingBinding.ProxyAddress
string
MessagingBinding.ProjectedAddress
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "attributes": "string",
  • "messaging_binding": { },
  • "role_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "last_read_message_index": 0,
  • "last_read_timestamp": "string"
}

List service-scoped Participants

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "participants": [
    ],
  • "meta": {}
}

Fetch a service-scoped Participant

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
ParticipantSid
required
string^MB[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "attributes": "string",
  • "messaging_binding": { },
  • "role_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "last_read_message_index": 0,
  • "last_read_timestamp": "string"
}

Update a service-scoped Participant

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
ParticipantSid
required
string^MB[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Attributes
string
RoleSid
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "attributes": "string",
  • "messaging_binding": { },
  • "role_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "last_read_message_index": 0,
  • "last_read_timestamp": "string"
}

Delete a service-scoped Participant

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
ParticipantSid
required
string^MB[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

List service-scoped Message Receipts

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
MessageSid
required
string^IM[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "delivery_receipts": [
    ],
  • "meta": {}
}

Fetch a service-scoped Message Receipt

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
MessageSid
required
string^IM[0-9a-fA-F]{32}$
Sid
required
string^DY[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "message_sid": "stringstringstringstringstringstri",
  • "channel_message_sid": "stringstringstringstringstringstri",
  • "participant_sid": "stringstringstringstringstringstri",
  • "status": "read",
  • "error_code": 0,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Create a service-scoped Scoped Webhook

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
required
Target
required
string
Enum: "webhook" "trigger" "studio"
Configuration.Url
string
Configuration.Method
string
Enum: "GET" "POST"
Configuration.FlowSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "target": "string",
  • "url": "http://example.com",
  • "configuration": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

List service-scoped Scoped Webhooks

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "webhooks": [
    ],
  • "meta": {}
}

Fetch a service-scoped Scoped Webhook

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
WebhookSid
required
string^WH[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "target": "string",
  • "url": "http://example.com",
  • "configuration": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Update a service-scoped Scoped Webhook

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
WebhookSid
required
string^WH[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
Configuration.Url
string
Configuration.Method
string
Enum: "GET" "POST"
Configuration.FlowSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "conversation_sid": "stringstringstringstringstringstri",
  • "target": "string",
  • "url": "http://example.com",
  • "configuration": { },
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Delete a service-scoped Scoped Webhook

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
ConversationSid
required
string^CH[0-9a-fA-F]{32}$
WebhookSid
required
string^WH[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Create a service-scoped Role

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
required
FriendlyName
required
string
Type
required
string
Enum: "conversation" "service"
Permission
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "conversation",
  • "permissions": [
    ],
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

List service-scoped Roles

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ],
  • "meta": {}
}

Fetch a service-scoped Role

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Sid
required
string^RL[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "conversation",
  • "permissions": [
    ],
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Update a service-scoped Role

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Sid
required
string^RL[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
required
Permission
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "type": "conversation",
  • "permissions": [
    ],
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com"
}

Delete a service-scoped Role

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Sid
required
string^RL[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Create a service-scoped User

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
required
Identity
required
string
FriendlyName
string
Attributes
string
RoleSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "role_sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "friendly_name": "string",
  • "attributes": "string",
  • "is_online": true,
  • "is_notifiable": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": { }
}

List service-scoped Users

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "meta": {}
}

Fetch a service-scoped User

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Sid
required
string^US[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "role_sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "friendly_name": "string",
  • "attributes": "string",
  • "is_online": true,
  • "is_notifiable": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": { }
}

Update a service-scoped User

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Sid
required
string^US[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
Attributes
string
RoleSid
string

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "role_sid": "stringstringstringstringstringstri",
  • "identity": "string",
  • "friendly_name": "string",
  • "attributes": "string",
  • "is_online": true,
  • "is_notifiable": true,
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "url": "http://example.com",
  • "links": { }
}

Delete a service-scoped User

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Sid
required
string^US[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Create a service-scoped Conversation with initial Participants

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
FriendlyName
string
UniqueName
string
MessagingServiceSid
string
Attributes
string
State
string
Enum: "initializing" "inactive" "active" "closed"
Timers.Inactive
string
Timers.Closed
string
Participant
Array of strings

Repeated; each a JSON participant spec.

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "messaging_service_sid": "stringstringstringstringstringstri",
  • "sid": "stringstringstringstringstringstri",
  • "friendly_name": "string",
  • "unique_name": "string",
  • "attributes": "string",
  • "state": "initializing",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "timers": { },
  • "links": { },
  • "bindings": { },
  • "url": "http://example.com"
}

List service-scoped Participant Conversations

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
query Parameters
Identity
string
Address
string
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "conversations": [
    ],
  • "meta": {}
}

List service-scoped User Conversations

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
UserSid
required
string^US[0-9a-fA-F]{32}$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "conversations": [
    ],
  • "meta": {}
}

List service-scoped push Bindings

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
query Parameters
BindingType
string
Enum: "apn" "gcm" "fcm" "twilsock"
Identity
string
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "bindings": [
    ],
  • "meta": {}
}

Fetch a service-scoped push Binding

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Sid
required
string^BS[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "sid": "stringstringstringstringstringstri",
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "credential_sid": "stringstringstringstringstringstri",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "endpoint": "string",
  • "identity": "string",
  • "binding_type": "apn",
  • "message_types": [
    ],
  • "url": "http://example.com"
}

Delete a service-scoped push Binding

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Sid
required
string^BS[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Fetch the per-service Configuration

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "default_conversation_creator_role_sid": "stringstringstringstringstringstri",
  • "default_conversation_role_sid": "stringstringstringstringstringstri",
  • "default_chat_service_role_sid": "stringstringstringstringstringstri",
  • "url": "http://example.com",
  • "links": { },
  • "reachability_enabled": true
}

Update the per-service Configuration

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
DefaultChatServiceRoleSid
string
DefaultConversationCreatorRoleSid
string
DefaultConversationRoleSid
string
ReachabilityEnabled
boolean

Responses

Response samples

Content type
application/json
{
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "default_conversation_creator_role_sid": "stringstringstringstringstringstri",
  • "default_conversation_role_sid": "stringstringstringstringstringstri",
  • "default_chat_service_role_sid": "stringstringstringstringstringstri",
  • "url": "http://example.com",
  • "links": { },
  • "reachability_enabled": true
}

Fetch the per-service push Notification configuration

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "new_message": { },
  • "added_to_conversation": { },
  • "removed_from_conversation": { },
  • "log_enabled": true,
  • "url": "http://example.com"
}

Update the per-service push Notification configuration

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
LogEnabled
boolean
NewMessage.Enabled
boolean
NewMessage.Template
string
NewMessage.Sound
string
NewMessage.BadgeCountEnabled
boolean
NewMessage.WithMedia.Enabled
boolean
NewMessage.WithMedia.Template
string
AddedToConversation.Enabled
boolean
AddedToConversation.Template
string
AddedToConversation.Sound
string
RemovedFromConversation.Enabled
boolean
RemovedFromConversation.Template
string
RemovedFromConversation.Sound
string

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "new_message": { },
  • "added_to_conversation": { },
  • "removed_from_conversation": { },
  • "log_enabled": true,
  • "url": "http://example.com"
}

Fetch the per-service Webhook configuration

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "pre_webhook_url": "string",
  • "post_webhook_url": "string",
  • "filters": [
    ],
  • "method": "GET",
  • "url": "http://example.com"
}

Update the per-service Webhook configuration

Authorizations:
basicAuth
path Parameters
ChatServiceSid
required
string^IS[0-9a-fA-F]{32}$
Request Body schema: application/x-www-form-urlencoded
PreWebhookUrl
string
PostWebhookUrl
string
Method
string
Enum: "GET" "POST"
Filters
Array of strings

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "chat_service_sid": "stringstringstringstringstringstri",
  • "pre_webhook_url": "string",
  • "post_webhook_url": "string",
  • "filters": [
    ],
  • "method": "GET",
  • "url": "http://example.com"
}

AI Assistants

List Assistants

Authorizations:
basicAuth
query Parameters
PageSize
integer
Page
integer
PageToken
string

Responses

Response samples

Content type
application/json
{
  • "assistants": [
    ],
  • "meta": {}
}

Create an Assistant

Authorizations:
basicAuth
Request Body schema: application/json
required
name
required
string
owner
string
personality_prompt
string
model
string

VoiceML extension: the BYO-LLM model backing the assistant (Phase 6).

object
segment_credential
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "owner": "string",
  • "personality_prompt": "string",
  • "model": "string",
  • "customer_ai": {
    },
  • "segment_credential": { }
}

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "customer_ai": { },
  • "id": "string",
  • "model": "string",
  • "name": "string",
  • "owner": "string",
  • "url": "string",
  • "personality_prompt": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Fetch an Assistant (with tools and knowledge)

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "customer_ai": { },
  • "id": "string",
  • "model": "string",
  • "name": "string",
  • "owner": "string",
  • "url": "string",
  • "personality_prompt": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "tools": [
    ],
  • "knowledge": [
    ]
}

Update an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
Request Body schema: application/json
name
string
owner
string
personality_prompt
string
model
string

VoiceML extension: the BYO-LLM model backing the assistant (Phase 6).

customer_ai
object
segment_credential
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "owner": "string",
  • "personality_prompt": "string",
  • "model": "string",
  • "customer_ai": { },
  • "segment_credential": { }
}

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "customer_ai": { },
  • "id": "string",
  • "model": "string",
  • "name": "string",
  • "owner": "string",
  • "url": "string",
  • "personality_prompt": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Delete an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Send a message to an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
Request Body schema: application/json
required
identity
required
string
body
required
string
session_id
string
webhook
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "identity": "string",
  • "body": "string",
  • "session_id": "string",
  • "webhook": "string",
  • "mode": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "flagged": true,
  • "aborted": true,
  • "session_id": "string",
  • "account_sid": "stringstringstringstringstringstri",
  • "body": "string",
  • "error": "string"
}

AI Assistants / Tools

List Tools

Authorizations:
basicAuth
query Parameters
AssistantId
string
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "tools": [
    ],
  • "meta": {}
}

Create a Tool

Authorizations:
basicAuth
Request Body schema: application/json
required
name
required
string
type
required
string
enabled
required
boolean
assistant_id
string
description
string
meta
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "enabled": true,
  • "assistant_id": "string",
  • "description": "string",
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "meta": { },
  • "name": "string",
  • "requires_auth": true,
  • "type": "string",
  • "url": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Fetch a Tool (with policies)

Authorizations:
basicAuth
path Parameters
id
required
string^aia_tool_.+$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "meta": { },
  • "name": "string",
  • "requires_auth": true,
  • "type": "string",
  • "url": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z",
  • "policies": [
    ]
}

Update a Tool

Authorizations:
basicAuth
path Parameters
id
required
string^aia_tool_.+$
Request Body schema: application/json
name
string
type
string
enabled
boolean
description
string
meta
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "enabled": true,
  • "description": "string",
  • "meta": { }
}

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "meta": { },
  • "name": "string",
  • "requires_auth": true,
  • "type": "string",
  • "url": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Delete a Tool

Authorizations:
basicAuth
path Parameters
id
required
string^aia_tool_.+$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

List Tools attached to an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "tools": [
    ],
  • "meta": {}
}

Attach a Tool to an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
toolId
required
string^aia_tool_.+$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Detach a Tool from an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
toolId
required
string^aia_tool_.+$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

AI Assistants / Knowledge

List Knowledge

Authorizations:
basicAuth
query Parameters
AssistantId
string
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "knowledge": [
    ],
  • "meta": {}
}

Create Knowledge

Authorizations:
basicAuth
Request Body schema: application/json
required
name
required
string
type
required
string
assistant_id
string
description
string
embedding_model
string
knowledge_source_details
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "assistant_id": "string",
  • "description": "string",
  • "embedding_model": "string",
  • "knowledge_source_details": { }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "account_sid": "stringstringstringstringstringstri",
  • "knowledge_source_details": { },
  • "name": "string",
  • "status": "string",
  • "type": "string",
  • "url": "string",
  • "embedding_model": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Fetch Knowledge

Authorizations:
basicAuth
path Parameters
id
required
string^aia_know_.+$

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "account_sid": "stringstringstringstringstringstri",
  • "knowledge_source_details": { },
  • "name": "string",
  • "status": "string",
  • "type": "string",
  • "url": "string",
  • "embedding_model": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Update Knowledge

Authorizations:
basicAuth
path Parameters
id
required
string^aia_know_.+$
Request Body schema: application/json
name
string
type
string
description
string
embedding_model
string
knowledge_source_details
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "description": "string",
  • "embedding_model": "string",
  • "knowledge_source_details": { }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "account_sid": "stringstringstringstringstringstri",
  • "knowledge_source_details": { },
  • "name": "string",
  • "status": "string",
  • "type": "string",
  • "url": "string",
  • "embedding_model": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

Delete Knowledge

Authorizations:
basicAuth
path Parameters
id
required
string^aia_know_.+$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Fetch Knowledge ingestion status

Authorizations:
basicAuth
path Parameters
id
required
string^aia_know_.+$

Responses

Response samples

Content type
application/json
{
  • "account_sid": "stringstringstringstringstringstri",
  • "status": "string",
  • "last_status": "string",
  • "date_updated": "2019-08-24T14:15:22Z"
}

List Knowledge chunks

Authorizations:
basicAuth
path Parameters
id
required
string^aia_know_.+$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "chunks": [
    ],
  • "meta": {}
}

List Knowledge attached to an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "knowledge": [
    ],
  • "meta": {}
}

Attach Knowledge to an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
knowledgeId
required
string^aia_know_.+$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Detach Knowledge from an Assistant

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
knowledgeId
required
string^aia_know_.+$

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

AI Assistants / Sessions

List Sessions

Authorizations:
basicAuth
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ],
  • "meta": {}
}

Fetch a Session

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "account_sid": "stringstringstringstringstringstri",
  • "assistant_id": "string",
  • "verified": true,
  • "identity": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

List a Session's Messages

Authorizations:
basicAuth
path Parameters
id
required
string
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "meta": {}
}

AI Assistants / Feedback

List an Assistant's Feedback

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
query Parameters
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "feedbacks": [
    ],
  • "meta": {}
}

Create Feedback

Authorizations:
basicAuth
path Parameters
id
required
string^aia_asst_.+$
Request Body schema: application/json
required
session_id
required
string
message_id
string
score
number <float>
text
string

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "message_id": "string",
  • "score": 0.1,
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "assistant_id": "string",
  • "id": "string",
  • "account_sid": "stringstringstringstringstringstri",
  • "user_sid": "stringstringstringstringstringstri",
  • "message_id": "string",
  • "score": 1,
  • "session_id": "string",
  • "text": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_updated": "2019-08-24T14:15:22Z"
}

AI Assistants / Policies

List Policies

Authorizations:
basicAuth
query Parameters
ToolId
string
KnowledgeId
string
PageSize
integer

Responses

Response samples

Content type
application/json
{
  • "policies": [
    ],
  • "meta": {}
}

Recordings

List recordings for the account

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

query Parameters
DateCreated
string <date-time>

Filter to recordings created on this UTC date (YYYY-MM-DD).

DateCreated<
string <date-time>

Filter to recordings created strictly before this UTC date.

DateCreated>
string <date-time>

Filter to recordings created strictly after this UTC date.

CallSid
string^CA[0-9a-fA-F]{32}$

Filter to recordings whose CallSid equals this value.

ConferenceSid
string^CF[0-9a-fA-F]{32}$

Filter to recordings whose ConferenceSid equals this value.

IncludeSoftDeleted
boolean

Twilio-compatible parameter. VoiceML hard-deletes recordings — there is no soft-delete store — so this parameter is accepted but does not change the result set.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "recordings": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "start": 0,
  • "end": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

List a recording's transcriptions

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

RecordingSid
required
string^RE[a-f0-9]{32}$

Twilio-format Recording SID (RE + 32 hex characters).

query Parameters
DateCreated
string <date-time>

Filter to transcriptions created on this UTC date (YYYY-MM-DD).

DateCreated<
string <date-time>

Filter to transcriptions created strictly before this UTC date.

DateCreated>
string <date-time>

Filter to transcriptions created strictly after this UTC date.

Page
integer >= 0
Default: 0

Zero-based page index.

PageSize
integer [ 1 .. 1000 ]
Default: 50

Page size. Max 1000; default 50.

PageToken
string

The page token. This is provided by the API.

Responses

Response samples

Content type
application/json
{
  • "transcriptions": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "num_pages": 0,
  • "total": 0,
  • "first_page_uri": "string",
  • "next_page_uri": "string",
  • "previous_page_uri": "string",
  • "uri": "string"
}

Fetch a recording's transcription by sid

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

RecordingSid
required
string^RE[a-f0-9]{32}$

Twilio-format Recording SID (RE + 32 hex characters).

Sid
required
string^TR[a-f0-9]{32}$

Twilio-format Transcription SID (TR + 32 hex).

Responses

Response samples

Content type
application/json
{
  • "sid": "TRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "status": "in-progress",
  • "recording_sid": "string",
  • "duration": "string",
  • "transcription_text": "string",
  • "type": "fast",
  • "price": "string",
  • "price_unit": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string"
}

Delete a recording's transcription

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

RecordingSid
required
string^RE[a-f0-9]{32}$

Twilio-format Recording SID (RE + 32 hex characters).

Sid
required
string^TR[a-f0-9]{32}$

Twilio-format Transcription SID (TR + 32 hex).

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Fetch recording metadata

Returns JSON metadata for the recording. The companion .wav path returns the audio bytes (or a 302/410 redirect depending on archival state); see recordings.fetchAudio.

Tenant-scoped: a RecordingSid that belongs to a different account returns 404 with the same shape as a nonexistent sid — no enumeration leak.

See docs/aws-recordings.md for the archival pipeline.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

query Parameters
IncludeSoftDeleted
boolean

Twilio-compatible parameter. VoiceML hard-deletes recordings — accepted but does not change fetch behaviour.

Responses

Response samples

Content type
application/json
{
  • "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "account_sid": "string",
  • "call_sid": "string",
  • "conference_sid": "string",
  • "status": "in-progress",
  • "source": "OutboundAPI",
  • "channels": 1,
  • "duration": "string",
  • "api_version": "string",
  • "uri": "string",
  • "date_created": "string",
  • "date_updated": "string",
  • "start_time": "string",
  • "price": "string",
  • "price_unit": "string",
  • "encryption_details": { },
  • "subresource_uris": { },
  • "media_url": "string",
  • "error_code": 0
}

Delete a recording (row + local WAV + S3 object when present)

Removes the memdb row, unlinks the on-disk WAV, and (when RECORDING_S3_BUCKET is configured) issues an S3 DeleteObject on the archived copy. S3 deletion is best-effort: failure logs but does not fail the API call (the bucket lifecycle policy is the long-stop cleanup). Tenant-scoped — cross-tenant DELETE returns 404 without affecting the row.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Fetch recording audio (WAV)

Returns the captured audio as audio/wav with one of three delivery shapes:

  • 200 OK — local file present (typical for the first RECORDING_LOCAL_GRACE window after the call ends).
  • 302 Found — local file cleaned up but archived to S3; Location header points at a presigned URL with TTL RECORDING_PRESIGN_TTL.
  • 410 Gone — local file gone AND no s3_key set (typically: archival not configured + cleanup ran, or archival failed and the WAV was lost).

Tenant-scoped: a RecordingSid that belongs to a different account returns 404 with the same shape as a nonexistent sid — no enumeration leak.

See docs/aws-recordings.md for the archival pipeline.

Authorizations:
basicAuth
path Parameters
AccountSid
required
string^AC[0-9a-f]{32}$

Twilio-format AccountSid: literal "AC" + 32 hex chars (34 total). Server-generated at account creation; the same value the customer's Twilio SDK validates in its constructor.

Sid
required
string^(CA(?:[0-9a-f]{32}|[0-9a-f]{8}-[0-9a-f]{4}-[...

Twilio generic resource identifier on fetch-by-id endpoints (CA/RE/AP/QU/CF/PN + 32 hex, or dashed CA form). Parameter name is always Sid per twilio-oai; the path segment position determines which prefix is valid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "more_info": "string",
  • "status": 0
}

Diagnostics

Deep liveness probe

Composite probe with two-tier severity. Hard checks (storage, disk free space, voice stack processes + required modules + SIP profile state) flip the LB-facing ok boolean. Soft checks (host CPU loadavg, memory pressure, workload percents, cluster health) surface in warnings only — the LB stays in rotation. Result cached 5 s on full success.

Responses

Response samples

Content type
application/json
{
  • "ok": true,
  • "warnings": [
    ]
}

OpenAPI spec (YAML)

Responses

OpenAPI spec (YAML, .yml alias)

Alias for /openapi.yaml. Same response, same content type.

Responses

OpenAPI spec (JSON)

Responses