Download OpenAPI specification:Download
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:
:AccountSid (the URL path parameter, Twilio-format
AC + 32 hex chars). Same value the Twilio SDK validates in its
constructor — migration-compatible.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.
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).
| 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. |
| 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. |
{- "calls": [
- {
- "sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "api_version": "2010-04-01",
- "to": "+14155550100",
- "to_formatted": "string",
- "from": "+14155550101",
- "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",
- "group_sid": "string",
- "queue_time": "string",
- "trunk_sid": "string",
- "annotation": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}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.
| 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. |
| 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 |
| Twiml | string Inline voice markup body — alternative to |
| ApplicationSid | string References a stored Application resource. Its |
| FallbackUrl | string URL to fetch voice markup from if the primary |
| 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 Subset of |
| RecordingChannels | string Enum: "mono" "dual" Recording channel layout: |
| RecordingTrack | string Enum: "inbound" "outbound" "both"
|
| Trim | string Enum: "trim-silence" "do-not-trim" Trims leading and trailing silence from the |
| Timeout | integer >= 1 Default: 60 Originate timeout (seconds). |
| TimeLimit | integer Max call duration in seconds. An explicit |
| SendDigits | string DTMF burst played after answer — charset |
| CallerId | string Twilio compatibility — accepted but ignored. VoiceML always uses |
| 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 |
| 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. |
{- "sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "api_version": "2010-04-01",
- "to": "+14155550100",
- "to_formatted": "string",
- "from": "+14155550101",
- "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",
- "group_sid": "string",
- "queue_time": "string",
- "trunk_sid": "string",
- "annotation": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}| 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
( |
{- "sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "api_version": "2010-04-01",
- "to": "+14155550100",
- "to_formatted": "string",
- "from": "+14155550101",
- "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",
- "group_sid": "string",
- "queue_time": "string",
- "trunk_sid": "string",
- "annotation": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}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.| 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
( |
| Status | string Enum: "completed" "canceled" |
| Twiml | string Inline voice markup body. Wins over |
| 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 |
{- "sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "api_version": "2010-04-01",
- "to": "+14155550100",
- "to_formatted": "string",
- "from": "+14155550101",
- "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",
- "group_sid": "string",
- "queue_time": "string",
- "trunk_sid": "string",
- "annotation": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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 ( |
| 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. |
{- "recordings": [
- {
- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}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.
| 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 ( |
| RecordingMaxDuration | integer Cap recording length in seconds. 0 = no limit. |
| RecordingChannels | string Enum: "mono" "dual"
|
| RecordingTrack | string Enum: "inbound" "outbound" "both"
|
| PlayBeep | boolean Default: true Twilio-compatible; accepted but currently a no-op on this REST endpoint (the |
| RecordingStatusCallback | string |
| RecordingStatusCallbackMethod | string Default: "POST" |
| RecordingStatusCallbackEvent | string
|
{- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}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.
| 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 ( |
| 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
( |
{- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}Applies stop / pause / resume on the live recording.
All three transitions return 200 + the Recording resource
reporting the status moved to (stopped, paused,
in-progress); duration is null except on a stop, which
reports the recorded length. A recording no longer running is
refused with 400 / 21220. Twilio.CURRENT in place of the sid
names the call's one active recording (400 / 21220 when none,
400 / 16108 when more than one). Tenant-scoped: a RecordingSid
that belongs to a different account returns 404 without leaking
existence.
| 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 ( |
| 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
( |
| Status required | string Enum: "stopped" "paused" "in-progress" |
| PauseBehavior | string With |
{- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}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.
| 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 ( |
| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| 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 ( |
| Url required | string wss:// endpoint for the customer's WebSocket server. Required. |
| Track | string Enum: "inbound_track" "outbound_track" "both_tracks" Accepted for SDK compatibility; not validated and (for Streams) not applied. |
| Name | string |
| StatusCallback | string |
| StatusCallbackMethod | string Default: "POST" |
{- "sid": "MZxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "name": "string",
- "status": "in-progress",
- "date_updated": "string",
- "uri": "string"
}| 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 ( |
| Sid required | string^(MZ|SR|GT)[a-f0-9]{32}$ Twilio-compatible subresource SID — used by Streams ( |
| Status required | string Value: "stopped" |
{- "sid": "MZxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "name": "string",
- "status": "in-progress",
- "date_updated": "string",
- "uri": "string"
}Starts a SIPREC mirror against the configured connector profile on the live call leg. Returns the new Siprec resource with an SR-prefixed sid.
| 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 ( |
| 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 compatibility; not validated and (for Streams) not applied. |
| StatusCallback | string |
| StatusCallbackMethod | string Default: "POST" |
{- "sid": "SRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "name": "string",
- "status": "in-progress",
- "date_updated": "string",
- "uri": "string"
}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.
| 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 ( |
| Sid required | string^(MZ|SR|GT)[a-f0-9]{32}$ Twilio-compatible subresource SID — used by Streams ( |
| Status required | string Value: "stopped" |
{- "sid": "SRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "name": "string",
- "status": "in-progress",
- "date_updated": "string",
- "uri": "string"
}| 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 ( |
| Name | string |
| Track | string Enum: "inbound_track" "outbound_track" "both_tracks" Accepted for SDK compatibility; 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 |
| SpeechModel | string Engine-specific model hint (e.g. Deepgram's |
| EnableAutomaticPunctuation | boolean |
| IntelligenceService | string Accepted for Twilio compatibility; VoiceML has no Conversation Intelligence, so a set value logs a 32655 Notification and transcription proceeds. |
| StatusCallbackUrl | string <uri> Transcription lifecycle webhook (Twilio's REST name; no StatusCallback alias). |
| StatusCallbackMethod | string Default: "POST" |
| StatusCallbackEvents | string Comma-separated event filter. |
{- "sid": "GT1234567890abcdef1234567890abcdef",
- "account_sid": "string",
- "call_sid": "string",
- "name": "string",
- "status": "in-progress",
- "date_updated": "string",
- "uri": "string"
}| 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 ( |
| Sid required | string^(MZ|SR|GT)[a-f0-9]{32}$ Twilio-compatible subresource SID — used by Streams ( |
| Status required | string Value: "stopped" |
{- "sid": "GT1234567890abcdef1234567890abcdef",
- "account_sid": "string",
- "call_sid": "string",
- "name": "string",
- "status": "in-progress",
- "date_updated": "string",
- "uri": "string"
}Twilio's fine-grained per-call event stream. Populated from the call event log: one row per REST request/response against this call (create + each update).
| 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 ( |
| 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. |
{- "events": [
- {
- "request": {
- "method": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}, - "url": "string"
}, - "response": {
- "content_type": "string",
- "date_created": "string",
- "request_duration": 0,
- "response_body": "string",
- "response_code": 0
}
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}Twilio's per-call alert log. Populated from the call event log: rows are emitted whenever the voice markup document fetch or parse fails, using Twilio's own error-dictionary codes (11200 HTTP retrieval failure, 12100 document parse failure).
| 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 ( |
| 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 0 = error-level only, 1 = warning-level + above. |
| MessageDate | string <date-time> Filter to notifications logged on this UTC date. |
| MessageDate< | string <date-time> Filter to notifications logged strictly before this UTC date. |
| MessageDate> | string <date-time> Filter to notifications logged strictly after this UTC date. |
{- "notifications": [
- {
- "sid": "string",
- "account_sid": "string",
- "call_sid": "string",
- "api_version": "string",
- "error_code": "string",
- "log": "string",
- "message_date": "string",
- "message_text": "string",
- "more_info": "string",
- "request_method": "string",
- "request_url": "string",
- "uri": "string",
- "date_created": "string",
- "date_updated": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 ( |
| 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
( |
{- "sid": "string",
- "account_sid": "string",
- "call_sid": "string",
- "api_version": "string",
- "error_code": "string",
- "log": "string",
- "message_date": "string",
- "message_text": "string",
- "more_info": "string",
- "request_method": "string",
- "request_url": "string",
- "uri": "string",
- "date_created": "string",
- "date_updated": "string"
}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.
| 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 ( |
| 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; |
| 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 Twilio compatibility 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 Twilio compatibility but not yet wired — currently a no-op. |
| Confirmation | boolean Accepted for Twilio compatibility but not yet wired — currently a no-op. |
{- "sid": "PK1234567890abcdef1234567890abcdef",
- "account_sid": "string",
- "call_sid": "string",
- "api_version": "2010-04-01",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}Updates a <Pay> session against the live call leg. The card-capture runtime is enabled per account — contact support to turn it on.
| 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 ( |
| Sid required | string^(MZ|SR|GT)[a-f0-9]{32}$ Twilio-compatible subresource SID — used by Streams ( |
| 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" |
{- "sid": "PK1234567890abcdef1234567890abcdef",
- "account_sid": "string",
- "call_sid": "string",
- "api_version": "2010-04-01",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}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.
| 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 ( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| 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. |
| 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 |
| 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. |
{- "conferences": [
- {
- "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": {
- "property1": "string",
- "property2": "string"
}, - "member_count": 0
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
( |
{- "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": {
- "property1": "string",
- "property2": "string"
}, - "member_count": 0
}v1 supports only Status=completed — kicks every participant
and tears down the room. Twilio's other update fields
(Announce*) are not yet implemented.
| 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
( |
| Status required | string Value: "completed" |
{- "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": {
- "property1": "string",
- "property2": "string"
}, - "member_count": 0
}| 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 |
| 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. |
{- "participants": [
- {
- "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",
- "uri": "string",
- "date_created": "string",
- "date_updated": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}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.
| 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 |
| 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 |
| ConferenceStatusCallback | string <uri> Participant's conference lifecycle webhook. |
| ConferenceStatusCallbackMethod | string Default: "POST" Enum: "GET" "POST" |
| ConferenceStatusCallbackEvent | string Default: "start end" Space- or comma-separated conference event filter. |
{- "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",
- "uri": "string",
- "date_created": "string",
- "date_updated": "string"
}| 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 |
| CallSid required | string^CA[a-f0-9]{32}$ Twilio-format Call SID ( |
{- "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",
- "uri": "string",
- "date_created": "string",
- "date_updated": "string"
}At least one of Muted or Hold must be set. Twilio's
HoldUrl (custom hold-music URL) and AnnounceUrl are
not yet implemented.
| 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 |
| CallSid required | string^CA[a-f0-9]{32}$ Twilio-format Call SID ( |
| Muted | boolean Mute / unmute the participant. |
| Hold | boolean Place the participant on hold (default hold-music profile) or remove from hold. |
{- "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",
- "uri": "string",
- "date_created": "string",
- "date_updated": "string"
}| 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 |
| CallSid required | string^CA[a-f0-9]{32}$ Twilio-format Call SID ( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}Returns recordings created by <Dial><Conference record="record-from-start">
verbs that ran in this conference. Pagination envelope same as
/Recordings.
| 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 |
| 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. |
{- "recordings": [
- {
- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}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).
| 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 |
| RecordingStatusCallback | string |
| RecordingStatusCallbackMethod | string Default: "POST" |
| RecordingStatusCallbackEvent | string
|
{- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}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.
| 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 |
| 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
( |
{- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}Same semantics as /Calls/{CallSid}/Recordings/{Sid} but enforces
conference scope from the URL path.
| 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 |
| 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
( |
| Status required | string Enum: "stopped" "paused" "in-progress" |
| PauseBehavior | string With |
{- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}Same semantics as /Recordings/{Sid} but enforces conference
scope from the URL path.
| 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 |
| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}Create a named queue. Idempotent — POSTing the same FriendlyName a second time returns the existing queue rather than erroring (matches Twilio).
| 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. |
| FriendlyName required | string <= 64 characters |
| MaxSize | integer >= 0 Default: 0 |
{- "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"
}| 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. |
| 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. |
{- "queues": [
- {
- "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"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
( |
{- "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"
}| 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
( |
| FriendlyName | string <= 64 characters |
| MaxSize | integer >= 0 |
{- "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"
}Refused with 409 if any members are still waiting — caller must drain the queue first (matches Twilio's behaviour).
| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}Returned ordered by position; position 1 = longest waiting (front of queue).
| 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 |
| 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. |
{- "queue_members": [
- {
- "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "queue_sid": "string",
- "date_enqueued": "string",
- "wait_time": 0,
- "position": 0,
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 |
{- "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "queue_sid": "string",
- "date_enqueued": "string",
- "wait_time": 0,
- "position": 0,
- "uri": "string"
}Pops the longest-waiting member and redirects their call to the
URL in the body. The member's
| 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 |
| Url required | string <uri> HTTPS-only. |
| Method | string Default: "POST" Enum: "GET" "POST" |
{- "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "queue_sid": "string",
- "date_enqueued": "string",
- "wait_time": 0,
- "position": 0,
- "uri": "string"
}| 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 |
| CallSid required | string^CA[a-f0-9]{32}$ Twilio-format Call SID ( |
{- "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "queue_sid": "string",
- "date_enqueued": "string",
- "wait_time": 0,
- "position": 0,
- "uri": "string"
}| 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 |
| CallSid required | string^CA[a-f0-9]{32}$ Twilio-format Call SID ( |
| Url required | string <uri> |
| Method | string Default: "POST" Enum: "GET" "POST" |
{- "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "queue_sid": "string",
- "date_enqueued": "string",
- "wait_time": 0,
- "position": 0,
- "uri": "string"
}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.
| 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. |
| 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. |
| SmsStatusCallback | string <uri> Legacy alias of MessageStatusCallback. |
| SmsUrl | string <uri> Inbound-SMS webhook URL for this Application. |
| SmsMethod | string Enum: "GET" "POST" |
| SmsFallbackUrl | string <uri> Called when requesting/executing the voice markup at SmsUrl fails. |
| SmsFallbackMethod | string Enum: "GET" "POST" |
| PublicApplicationConnectEnabled | boolean |
{- "sid": "AP0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "ivr-main",
- "api_version": "string",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "voice_caller_id_lookup": true,
- "status_callback": "string",
- "status_callback_method": "GET",
- "message_status_callback": "string",
- "sms_status_callback": "string",
- "sms_method": "GET",
- "sms_fallback_method": "GET",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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. |
| 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. |
{- "applications": [
- {
- "sid": "AP0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "ivr-main",
- "api_version": "string",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "voice_caller_id_lookup": true,
- "status_callback": "string",
- "status_callback_method": "GET",
- "message_status_callback": "string",
- "sms_status_callback": "string",
- "sms_method": "GET",
- "sms_fallback_method": "GET",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
( |
{- "sid": "AP0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "ivr-main",
- "api_version": "string",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "voice_caller_id_lookup": true,
- "status_callback": "string",
- "status_callback_method": "GET",
- "message_status_callback": "string",
- "sms_status_callback": "string",
- "sms_method": "GET",
- "sms_fallback_method": "GET",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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
( |
| 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. |
| SmsStatusCallback | string <uri> Legacy alias of MessageStatusCallback. |
| SmsUrl | string <uri> Inbound-SMS webhook URL for this Application. |
| SmsMethod | string Enum: "GET" "POST" |
| SmsFallbackUrl | string <uri> Called when requesting/executing the voice markup at SmsUrl fails. |
| SmsFallbackMethod | string Enum: "GET" "POST" |
| PublicApplicationConnectEnabled | boolean |
{- "sid": "AP0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "ivr-main",
- "api_version": "string",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "voice_caller_id_lookup": true,
- "status_callback": "string",
- "status_callback_method": "GET",
- "message_status_callback": "string",
- "sms_status_callback": "string",
- "sms_method": "GET",
- "sms_fallback_method": "GET",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| 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. |
| 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 A partial number, where |
| FriendlyName | string The whole friendly name (the formatted number), matched case-insensitively; a prefix or suffix does not match. |
| Beta | boolean Excludes nothing: no number is a beta number. |
| Origin | string Enum: "twilio" "hosted"
|
{- "incoming_phone_numbers": [
- {
- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}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.
| 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. |
| PhoneNumber required | string E.164 — leading |
| VoiceUrl | string <uri> |
| VoiceMethod | string Enum: "GET" "POST" |
| VoiceFallbackUrl | string <uri> |
| VoiceFallbackMethod | string Enum: "GET" "POST" |
| SmsUrl | string <uri> Inbound-SMS webhook URL for this number. |
| SmsMethod | string Enum: "GET" "POST" |
| SmsFallbackUrl | string <uri> Called when requesting/executing the voice markup at SmsUrl fails. |
| SmsFallbackMethod | string Enum: "GET" "POST" |
| SmsApplicationSid | string^AP[0-9a-fA-F]{32}$ Binds the number to an Application whose |
| VoiceApplicationSid | string^AP[0-9a-fA-F]{32}$ Binds the number to an Application whose voice config wins outright over the number's own Voice* fields. |
| StatusCallback | string <uri> Number-level lifecycle webhook for INBOUND calls to this DID; the session default fires the completed event — no event selector exists. |
| StatusCallbackMethod | string Enum: "GET" "POST" |
{- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}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.
| 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. |
| 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" |
{- "incoming_phone_numbers": [
- {
- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}Twilio type-specific create alias — same semantics as
POST /IncomingPhoneNumbers.
| 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. |
| PhoneNumber required | string |
| VoiceUrl | string <uri> |
| VoiceMethod | string Enum: "GET" "POST" |
{- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}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.
| 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. |
| 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" |
{- "incoming_phone_numbers": [
- {
- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}Twilio type-specific create alias — same semantics as
POST /IncomingPhoneNumbers.
| 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. |
| PhoneNumber required | string |
| VoiceUrl | string <uri> |
| VoiceMethod | string Enum: "GET" "POST" |
{- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}Twilio type-specific list alias. Returns US toll-free NPAs
(800/833/844/855/866/877/888). Same pagination envelope as
/IncomingPhoneNumbers.
| 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. |
| 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" |
{- "incoming_phone_numbers": [
- {
- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}Twilio type-specific create alias — same semantics as
POST /IncomingPhoneNumbers.
| 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. |
| PhoneNumber required | string |
| VoiceUrl | string <uri> |
| VoiceMethod | string Enum: "GET" "POST" |
{- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}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).
| 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
( |
{- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}Only-set-fields-touched semantics. Tenant-scoped — a number assigned to a different account 404s.
| 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
( |
| VoiceUrl | string <uri> |
| VoiceMethod | string Enum: "GET" "POST" |
| VoiceFallbackUrl | string <uri> |
| VoiceFallbackMethod | string Enum: "GET" "POST" |
| SmsUrl | string <uri> Inbound-SMS webhook URL for this number. |
| SmsMethod | string Enum: "GET" "POST" |
| SmsFallbackUrl | string <uri> Called when requesting/executing the voice markup at SmsUrl fails. |
| SmsFallbackMethod | string Enum: "GET" "POST" |
| SmsApplicationSid | string^AP[0-9a-fA-F]{32}$ Binds the number to an Application whose |
| VoiceApplicationSid | string^AP[0-9a-fA-F]{32}$ Binds the number to an Application whose voice config wins outright over the number's own Voice* fields. |
| StatusCallback | string <uri> Number-level lifecycle webhook for INBOUND calls to this DID; the session default fires the completed event — no event selector exists. |
| StatusCallbackMethod | string Enum: "GET" "POST" |
{- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "phone_number": "+14155550100",
- "friendly_name": "string",
- "api_version": "2010-04-01",
- "uri": "string",
- "origin": "twilio",
- "beta": true,
- "capabilities": {
- "voice": true,
- "sms": true,
- "mms": true,
- "fax": true
}, - "voice_method": "GET",
- "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",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}, - "type": "local",
- "date_created": "string",
- "date_updated": "string"
}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.
| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| PhoneNumber required | string The phone number in E.164 format (e.g. +14155550100) or its PN sid. |
{- "phone_number": "+14155550100",
- "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"
}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.
| PhoneNumber required | string The phone number in E.164 format (e.g. +14155550100) or its PN sid. |
| VoiceRegion | string Inbound Processing Region for voice. |
| FriendlyName | string |
{- "phone_number": "+14155550100",
- "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"
}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
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}.
| 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. |
| 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. Repeatable; presence makes the message an MMS routed through the tenant's MMS provider. |
| MessagingServiceSid | string Accepted for Twilio compatibility; not yet routed against. |
| ValidityPeriod | integer [ 1 .. 36000 ] Seconds the message may stay queued before failing with 30001 (Twilio's |
| StatusCallback | string <uri> Per-message delivery-receipt (DLR) callback URL; overrides the Application-level default. |
| StatusCallbackMethod | string Enum: "GET" "POST" HTTP method for the StatusCallback. |
| SendAt | string <date-time> Schedule the message for a future UTC time. Requires ScheduleType and MessagingServiceSid. |
| ScheduleType | string Value: "fixed"
|
{- "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": {
- "media": "string",
- "feedback": "string"
}
}| 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. |
| 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. |
{- "messages": [
- {
- "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": {
- "media": "string",
- "feedback": "string"
}
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
( |
{- "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": {
- "media": "string",
- "feedback": "string"
}
}| 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
( |
| 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. |
{- "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": {
- "media": "string",
- "feedback": "string"
}
}| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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. |
| 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. |
{- "media_list": [
- {
- "sid": "ME0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "parent_sid": "string",
- "content_type": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}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.
| 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. |
{- "sid": "ME0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "parent_sid": "string",
- "content_type": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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. |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}Unique to Messaging Service — Conversation Service has no update verb, so this method has no path collision.
| ChatServiceSid required | string^(IS|MG)[0-9a-fA-F]{32}$ IS = Conversation Service, MG = Messaging Service. |
| FriendlyName | string |
| InboundRequestUrl | string |
| InboundMethod | string Enum: "GET" "POST" |
| FallbackUrl | string |
| FallbackMethod | string Enum: "GET" "POST" |
| StatusCallback | string |
| StickySender | boolean |
| MmsConverter | boolean |
| SmartEncoding | boolean |
| ScanMessageContent | string Enum: "inherit" "enable" "disable" |
| FallbackToLongCode | boolean |
| AreaCodeGeomatch | boolean |
| SynchronousValidation | boolean |
| ValidityPeriod | integer |
| Usecase | string |
| UseInboundWebhookOnNumber | boolean |
{- "sid": "MGxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "inbound_request_url": "string",
- "inbound_method": "GET",
- "fallback_url": "string",
- "fallback_method": "GET",
- "status_callback": "string",
- "sticky_sender": true,
- "mms_converter": true,
- "smart_encoding": true,
- "scan_message_content": "inherit",
- "fallback_to_long_code": true,
- "area_code_geomatch": true,
- "synchronous_validation": true,
- "validity_period": 0,
- "usecase": "string",
- "use_inbound_webhook_on_number": true,
- "advanced_opt_out": true
}Adds an account-owned IncomingPhoneNumber (by PN sid) to the service's pool. A number belongs to at most one service: re-adding it to the same service is 409/21710, adding it under another service is 409/21712. Twilio answers 200 on the add.
| ChatServiceSid required | string^MG[0-9a-fA-F]{32}$ |
| PhoneNumberSid required | string The IncomingPhoneNumber's PN sid. |
{- "sid": "string",
- "account_sid": "string",
- "service_sid": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "phone_number": "string",
- "country_code": "US",
- "capabilities": [
- "Voice"
], - "url": "string"
}| ChatServiceSid required | string^MG[0-9a-fA-F]{32}$ |
| Page | integer >= 0 Default: 0 Zero-based page index. |
| PageSize | integer [ 1 .. 1000 ] Default: 50 Page size. Max 1000; default 50. |
{- "phone_numbers": [
- {
- "sid": "string",
- "account_sid": "string",
- "service_sid": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "phone_number": "string",
- "country_code": "US",
- "capabilities": [
- "Voice"
], - "url": "string"
}
], - "meta": { }
}| ChatServiceSid required | string^MG[0-9a-fA-F]{32}$ |
| Sid required | string The pool entry's PN sid. |
{- "sid": "string",
- "account_sid": "string",
- "service_sid": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "phone_number": "string",
- "country_code": "US",
- "capabilities": [
- "Voice"
], - "url": "string"
}| ChatServiceSid required | string^MG[0-9a-fA-F]{32}$ |
| Sid required | string The pool entry's PN sid. |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| Sid required | string^AC[0-9a-f]{32}$ Twilio-format AccountSid ( |
{- "sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "friendly_name": "VoiceML account",
- "status": "active",
- "type": "Full",
- "owner_account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}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 shape as
the fetch. Self-serve — an account may only update its own record.
| Sid required | string^AC[0-9a-f]{32}$ Twilio-format AccountSid ( |
| FriendlyName | string Human-readable account name (Twilio friendly_name). |
| VoiceUrl | string <uri> Default voice webhook URL for the account. No web server needed — host your VoiceML documents free on voiceml.org's CDN. |
| 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). |
{- "sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "friendly_name": "VoiceML account",
- "status": "active",
- "type": "Full",
- "owner_account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}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.
| 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. |
{- "account_sid": "string",
- "balance": "string",
- "currency": "string"
}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.
| 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. |
| PhoneNumber required | string <phone-number> |
| FriendlyName | string |
| CallDelay | integer [ 0 .. 60 ] Seconds to wait before placing the verification call; out-of-range values are a 400 (error 21454). |
| Extension | string DTMF extension dialed after the verification call connects. |
| StatusCallback | string <uri> Fires at the end of the verification call with VerificationStatus (success|failed) and OutgoingCallerIdSid on success. |
| StatusCallbackMethod | string Enum: "GET" "POST" |
{- "account_sid": "string",
- "phone_number": "+14155550102",
- "friendly_name": "Main Office",
- "validation_code": "123456",
- "call_sid": "string"
}| 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. |
| PhoneNumber | string The whole number, in E.164, without the |
| FriendlyName | string The whole FriendlyName, matched case-insensitively, as on Twilio. |
| 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. |
{- "outgoing_caller_ids": [
- {
- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "friendly_name": "Main Office",
- "phone_number": "+14155550102",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
( |
{- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "friendly_name": "Main Office",
- "phone_number": "+14155550102",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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
( |
| FriendlyName | string |
{- "sid": "PNxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "friendly_name": "Main Office",
- "phone_number": "+14155550102",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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. |
| 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. |
{- "transcriptions": [
- {
- "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"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 ( |
{- "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"
}| 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 ( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| 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. |
{- "account_sid": "string",
- "uri": "string",
- "exports": [
- {
- "date": "string",
- "size": 0,
- "uri": "string"
}
]
}VoiceML extension (not a Twilio resource). Redirects (302) to a time-limited presigned URL for the account's archive on the given date.
| 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). |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}One UsageRecord per usage category over the requested window.
StartDate/EndDate are inclusive YYYY-MM-DD dates in GMT, or
offsets such as -30days (resolved against the end bound) /
+30days (resolved against the start bound). The window clamps
to the account's creation day; an empty window is a 404. This is
the same resource as /Usage/Records/AllTime.json.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}Same as the root /Usage/Records list: one record per category over the [account-creation, today] window, clamped by StartDate/EndDate.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}One record per category per UTC day in the window, newest day first.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}One record per category over the full previous UTC calendar month.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}One record per category per UTC calendar month in the window, newest month first; partial months clamp to the window.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}One record per category over [this month start, today], UTC.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}One record per category for the current UTC day.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}One record per category per year in the window, newest year first; partial years clamp to the window.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}One record per category for the previous UTC day.
| 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. |
| Category | string Only this category's records are returned. An unknown category is a 400 (error 20001). |
| StartDate | string <date> Window start (inclusive). |
| EndDate | string <date> Window end (inclusive). |
| IncludeSubaccounts | boolean Accepted for Twilio compatibility; VoiceML accounts have no subaccounts, so the flag does not change the result. |
| 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. |
{- "usage_records": [
- {
- "account_sid": "string",
- "api_version": "string",
- "as_of": "string",
- "category": "calls",
- "count": "string",
- "count_unit": "string",
- "description": "string",
- "end_date": "2019-08-24",
- "price": "string",
- "price_unit": "string",
- "start_date": "2019-08-24",
- "subresource_uris": {
- "all_time": "string",
- "daily": "string",
- "last_month": "string",
- "monthly": "string",
- "this_month": "string",
- "today": "string",
- "yearly": "string",
- "yesterday": "string"
}, - "uri": "string",
- "usage": "string",
- "usage_unit": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}{- "countries": [
- {
- "country": "string",
- "iso_country": "string",
- "url": "string"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| IsoCountry required | string |
{- "country": "string",
- "iso_country": "string",
- "outbound_prefix_prices": [
- {
- "prefixes": [
- "string"
], - "base_price": "string",
- "current_price": "string",
- "friendly_name": "string"
}
], - "inbound_call_prices": [
- {
- "base_price": "string",
- "current_price": "string",
- "number_type": "local"
}
], - "price_unit": "string",
- "url": "string"
}| Number required | string |
{- "number": "string",
- "country": "string",
- "iso_country": "string",
- "outbound_call_price": {
- "base_price": "string",
- "current_price": "string"
}, - "inbound_call_price": {
- "base_price": "string",
- "current_price": "string",
- "number_type": "local"
}, - "price_unit": "string",
- "url": "string"
}{- "countries": [
- {
- "country": "string",
- "iso_country": "string",
- "url": "string"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}SMS pricing only — Twilio's real Messaging Pricing schema has no distinct MMS field; MMS pricing is not exposed via this endpoint, same scope as Twilio's own API.
| IsoCountry required | string |
{- "country": "string",
- "iso_country": "string",
- "outbound_sms_prices": [
- {
- "carrier": "string",
- "mcc": "string",
- "mnc": "string",
- "prices": [
- {
- "base_price": "string",
- "current_price": "string",
- "number_type": "local"
}
]
}
], - "inbound_sms_prices": [
- {
- "base_price": "string",
- "current_price": "string",
- "number_type": "local"
}
], - "price_unit": "string",
- "url": "string"
}| IsoCountry required | string |
{- "country": "string",
- "iso_country": "string",
- "phone_number_prices": [
- {
- "number_type": "local",
- "base_price": "string",
- "current_price": "string"
}
], - "price_unit": "string",
- "url": "string"
}{- "countries": [
- {
- "country": "string",
- "iso_country": "string",
- "url": "string"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| IsoCountry required | string |
{- "country": "string",
- "iso_country": "string",
- "outbound_prefix_prices": [
- {
- "origination_prefixes": [
- "string"
], - "destination_prefixes": [
- "string"
], - "base_price": "string",
- "current_price": "string",
- "friendly_name": "string"
}
], - "inbound_call_prices": [
- {
- "base_price": "string",
- "current_price": "string",
- "number_type": "local"
}
], - "price_unit": "string",
- "url": "string"
}| DestinationNumber required | string |
| OriginationNumber | string |
{- "destination_number": "string",
- "origination_number": "string",
- "country": "string",
- "iso_country": "string",
- "outbound_call_prices": [
- {
- "origination_prefixes": [
- "string"
], - "base_price": "string",
- "current_price": "string"
}
], - "inbound_call_price": {
- "base_price": "string",
- "current_price": "string",
- "number_type": "local"
}, - "price_unit": "string",
- "url": "string"
}{- "countries": [
- {
- "country": "string",
- "iso_country": "string",
- "url": "string"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}VoiceML bills trunking identically to voice (same underlying rate); exposed as its own resource for Twilio SDK compatibility.
| IsoCountry required | string |
{- "country": "string",
- "iso_country": "string",
- "terminating_prefix_prices": [
- {
- "origination_prefixes": [
- "string"
], - "destination_prefixes": [
- "string"
], - "base_price": "string",
- "current_price": "string",
- "friendly_name": "string"
}
], - "originating_call_prices": [
- {
- "base_price": "string",
- "current_price": "string",
- "number_type": "local"
}
], - "price_unit": "string",
- "url": "string"
}| DestinationNumber required | string |
| OriginationNumber | string |
{- "destination_number": "string",
- "origination_number": "string",
- "country": "string",
- "iso_country": "string",
- "terminating_prefix_prices": [
- {
- "origination_prefixes": [
- "string"
], - "destination_prefixes": [
- "string"
], - "base_price": "string",
- "current_price": "string",
- "friendly_name": "string"
}
], - "originating_call_price": {
- "base_price": "string",
- "current_price": "string",
- "number_type": "local"
}, - "price_unit": "string",
- "url": "string"
}Account-wide notification log. Populated from the call event log; this is the account-scoped view across all calls.
| 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. |
| 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> Filter to notifications logged on this UTC date. |
| MessageDate< | string <date-time> Filter to notifications logged strictly before this UTC date. |
| MessageDate> | string <date-time> Filter to notifications logged strictly after this UTC date. |
| Log | integer Enum: 0 1 0 = error-level only, 1 = warning-level + above. |
{- "notifications": [
- {
- "sid": "string",
- "account_sid": "string",
- "call_sid": "string",
- "api_version": "string",
- "error_code": "string",
- "log": "string",
- "message_date": "string",
- "message_text": "string",
- "more_info": "string",
- "request_method": "string",
- "request_url": "string",
- "uri": "string",
- "date_created": "string",
- "date_updated": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
( |
{- "sid": "string",
- "account_sid": "string",
- "call_sid": "string",
- "api_version": "string",
- "error_code": "string",
- "log": "string",
- "message_date": "string",
- "message_text": "string",
- "more_info": "string",
- "request_method": "string",
- "request_url": "string",
- "uri": "string",
- "date_created": "string",
- "date_updated": "string"
}Registers a SIP Domain — the SIP-ingress surface that routes
inbound INVITEs to voice markup via voice_url. DomainName is
required.
| 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. |
| 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 |
{- "sid": "SD0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "sip-ingress",
- "domain_name": "example.sip.voiceml.example.com",
- "api_version": "string",
- "auth_type": "string",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "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": {
- "property1": "string",
- "property2": "string"
}
}| 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. |
| 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. |
{- "domains": [
- {
- "sid": "SD0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "sip-ingress",
- "domain_name": "example.sip.voiceml.example.com",
- "api_version": "string",
- "auth_type": "string",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "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": {
- "property1": "string",
- "property2": "string"
}
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 |
{- "sid": "SD0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "sip-ingress",
- "domain_name": "example.sip.voiceml.example.com",
- "api_version": "string",
- "auth_type": "string",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "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": {
- "property1": "string",
- "property2": "string"
}
}| 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 |
| 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 |
{- "sid": "SD0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "sip-ingress",
- "domain_name": "example.sip.voiceml.example.com",
- "api_version": "string",
- "auth_type": "string",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "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": {
- "property1": "string",
- "property2": "string"
}
}| 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 |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| SipDomain required | string The registrable SIP domain name (e.g. example.sip.voiceml.example.com). |
{- "sip_domain": "example.sip.voiceml.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"
}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.
| SipDomain required | string The registrable SIP domain name (e.g. example.sip.voiceml.example.com). |
| VoiceRegion | string Inbound Processing Region for voice. |
| FriendlyName | string |
{- "sip_domain": "example.sip.voiceml.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"
}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.
| 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 |
| CredentialListSid required | string^CL[0-9a-f]{32}$ |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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. |
{- "credential_list_mappings": [
- {
- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| 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 |
| IpAccessControlListSid required | string^AL[0-9a-f]{32}$ |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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. |
{- "ip_access_control_list_mappings": [
- {
- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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 |
| CredentialListSid required | string^CL[0-9a-f]{32}$ |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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. |
{- "credential_list_mappings": [
- {
- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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 |
| IpAccessControlListSid required | string^AL[0-9a-f]{32}$ |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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. |
{- "ip_access_control_list_mappings": [
- {
- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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 |
| CredentialListSid required | string^CL[0-9a-f]{32}$ |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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. |
{- "credential_list_mappings": [
- {
- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "string",
- "domain_sid": "string",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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 |
| 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 |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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. |
| FriendlyName | string |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "office-handsets",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}| 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. |
| 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. |
{- "credential_lists": [
- {
- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "office-handsets",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "office-handsets",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}| 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 |
| FriendlyName | string |
{- "sid": "CL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "office-handsets",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}| 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 |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}Username and Password are both required. Password is
write-only — it is accepted here but never echoed back on any
response.
| 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
|
| Username required | string |
| Password required | string Write-only — never returned on any response. |
{- "sid": "CR0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "credential_list_sid": "string",
- "username": "alice",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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
|
| 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. |
{- "credentials": [
- {
- "sid": "CR0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "credential_list_sid": "string",
- "username": "alice",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
|
| Sid required | string^CR[0-9a-f]{32}$ Twilio-compatible SIP Credential SID — literal "CR" + 32 hex
chars (34 total). Server-generated on
|
{- "sid": "CR0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "credential_list_sid": "string",
- "username": "alice",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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
|
| Sid required | string^CR[0-9a-f]{32}$ Twilio-compatible SIP Credential SID — literal "CR" + 32 hex
chars (34 total). Server-generated on
|
| Password | string Write-only — never returned on any response. |
{- "sid": "CR0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "credential_list_sid": "string",
- "username": "alice",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string"
}| 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
|
| Sid required | string^CR[0-9a-f]{32}$ Twilio-compatible SIP Credential SID — literal "CR" + 32 hex
chars (34 total). Server-generated on
|
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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. |
| FriendlyName | string |
{- "sid": "AL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "carrier-allowlist",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}| 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. |
| 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. |
{- "ip_access_control_lists": [
- {
- "sid": "AL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "carrier-allowlist",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
|
{- "sid": "AL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "carrier-allowlist",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}| 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
|
| FriendlyName | string |
{- "sid": "AL0123456789abcdef0123456789abcdef",
- "account_sid": "string",
- "friendly_name": "carrier-allowlist",
- "date_created": "string",
- "date_updated": "string",
- "uri": "string",
- "subresource_uris": {
- "property1": "string",
- "property2": "string"
}
}| 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
|
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}FriendlyName and IpAddress are both required.
CidrPrefixLength defaults to 32 (single host) when omitted.
| 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
|
| FriendlyName required | string |
| IpAddress required | string |
| CidrPrefixLength | integer |
{- "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"
}| 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
|
| 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. |
{- "ip_addresses": [
- {
- "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"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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
|
| Sid required | string^IP[0-9a-f]{32}$ Twilio-compatible SIP IpAddress SID — literal "IP" + 32 hex
chars (34 total). Server-generated on
|
{- "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"
}| 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
|
| Sid required | string^IP[0-9a-f]{32}$ Twilio-compatible SIP IpAddress SID — literal "IP" + 32 hex
chars (34 total). Server-generated on
|
| FriendlyName | string |
| IpAddress | string |
| CidrPrefixLength | integer |
{- "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"
}| 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
|
| Sid required | string^IP[0-9a-f]{32}$ Twilio-compatible SIP IpAddress SID — literal "IP" + 32 hex
chars (34 total). Server-generated on
|
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}VoiceML extension: every AOR registered under the account's SIP Domains, with its contacts and, when the endpoint is on a call, the active call (direction, remote party, since). Not part of Twilio's API surface.
| 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. |
| 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. |
{- "registrations": [
- {
- "aor": "string",
- "username": "string",
- "domain": "string",
- "domain_sid": "string",
- "status": "registered",
- "caller_id": "string",
- "user_agent": "string",
- "last_registered": "string",
- "contacts": [
- {
- "contact": "string",
- "received": "string",
- "socket": "string",
- "user_agent": "string",
- "expires_at": "string",
- "registered": true
}
], - "active_call": {
- "call_sid": "string",
- "direction": "string",
- "remote": "string",
- "since": "string"
}
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}Creates a Voice v1 IpRecord (a standalone allowed source IP) for
the authenticated account. IpAddress is required;
CidrPrefixLength defaults to 32 (a single host).
| IpAddress required | string The allowed source IPv4 address. |
| FriendlyName | string |
| CidrPrefixLength | integer CIDR prefix length (0-32). Defaults to 32. |
{- "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",
}Paginated list of the authenticated account's IpRecords.
| PageSize | integer Maximum rows per page (default 50, max 1000). |
{- "ip_records": [
- {
- "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",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| Sid required | string^IL[0-9a-fA-F]{32}$ The IpRecord sid. |
{- "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",
}Updates an IpRecord's FriendlyName. Only FriendlyName is mutable.
| Sid required | string^IL[0-9a-fA-F]{32}$ The IpRecord sid. |
| FriendlyName | string |
{- "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",
}Maps an IpRecord to a SIP Domain so inbound calls from that source
IP route to the domain. Both IpRecordSid and SipDomainSid are
required.
| IpRecordSid required | string The IpRecord sid (IL...). |
| SipDomainSid required | string The SIP Domain sid (SD...). |
{- "sid": "IB0123456789abcdef0123456789abcdef",
- "ip_record_sid": "string",
- "sip_domain_sid": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}Paginated list of the authenticated account's SourceIpMappings.
| PageSize | integer Maximum rows per page (default 50, max 1000). |
{- "source_ip_mappings": [
- {
- "sid": "IB0123456789abcdef0123456789abcdef",
- "ip_record_sid": "string",
- "sip_domain_sid": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| Sid required | string^IB[0-9a-fA-F]{32}$ The SourceIpMapping sid. |
{- "sid": "IB0123456789abcdef0123456789abcdef",
- "ip_record_sid": "string",
- "sip_domain_sid": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}Re-points a SourceIpMapping at a different SIP Domain. Only SipDomainSid is mutable.
| Sid required | string^IB[0-9a-fA-F]{32}$ The SourceIpMapping sid. |
| SipDomainSid required | string The SIP Domain sid (SD...). |
{- "sid": "IB0123456789abcdef0123456789abcdef",
- "ip_record_sid": "string",
- "sip_domain_sid": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}Creates a bring-your-own-carrier trunk for the authenticated account. All fields optional.
| 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 |
{- "account_sid": "string",
- "sid": "BY0123456789abcdef0123456789abcdef",
- "friendly_name": "carrier-x",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "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",
}| PageSize | integer Maximum rows per page (default 50, max 1000). |
{- "byoc_trunks": [
- {
- "account_sid": "string",
- "sid": "BY0123456789abcdef0123456789abcdef",
- "friendly_name": "carrier-x",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "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",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| Sid required | string^BY[0-9a-fA-F]{32}$ The ByocTrunk sid. |
{- "account_sid": "string",
- "sid": "BY0123456789abcdef0123456789abcdef",
- "friendly_name": "carrier-x",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "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",
}Updates a ByocTrunk. Only set fields are changed.
| Sid required | string^BY[0-9a-fA-F]{32}$ The ByocTrunk sid. |
| 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 |
{- "account_sid": "string",
- "sid": "BY0123456789abcdef0123456789abcdef",
- "friendly_name": "carrier-x",
- "voice_method": "GET",
- "voice_fallback_method": "GET",
- "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",
}| FriendlyName | string |
{- "account_sid": "string",
- "sid": "NY0123456789abcdef0123456789abcdef",
- "friendly_name": "origination-policy",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "links": {
- "property1": "string",
- "property2": "string"
}
}| PageSize | integer Maximum rows per page (default 50, max 1000). |
{- "connection_policies": [
- {
- "account_sid": "string",
- "sid": "NY0123456789abcdef0123456789abcdef",
- "friendly_name": "origination-policy",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "links": {
- "property1": "string",
- "property2": "string"
}
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ConnectionPolicySid required | string^NY[0-9a-fA-F]{32}$ The ConnectionPolicy sid. |
{- "account_sid": "string",
- "sid": "NY0123456789abcdef0123456789abcdef",
- "friendly_name": "origination-policy",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "links": {
- "property1": "string",
- "property2": "string"
}
}| ConnectionPolicySid required | string^NY[0-9a-fA-F]{32}$ The ConnectionPolicy sid. |
| FriendlyName | string |
{- "account_sid": "string",
- "sid": "NY0123456789abcdef0123456789abcdef",
- "friendly_name": "origination-policy",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "links": {
- "property1": "string",
- "property2": "string"
}
}| ConnectionPolicySid required | string^NY[0-9a-fA-F]{32}$ The parent ConnectionPolicy sid. |
| 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. |
{- "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",
}| ConnectionPolicySid required | string^NY[0-9a-fA-F]{32}$ The parent ConnectionPolicy sid. |
| PageSize | integer Maximum rows per page (default 50, max 1000). |
{- "targets": [
- {
- "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",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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. |
{- "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",
}| 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. |
| FriendlyName | string |
| Target | string |
| Priority | integer |
| Weight | integer |
| Enabled | boolean |
{- "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",
}| 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. |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| DialingPermissionsInheritance | boolean Whether subaccounts inherit the parent's dialing permissions. |
{- "dialing_permissions_inheritance": true,
}Creates a Conversation (a stateful messaging thread) for the
authenticated account. All fields are optional; State defaults to
active and Attributes to {}.
| 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 |
{- "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": { },
- "links": { },
- "bindings": { }
}Paginated list of the authenticated account's Conversations.
| PageSize | integer Maximum rows per page (default 50, max 1000). |
{- "conversations": [
- {
- "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": { },
- "links": { },
- "bindings": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ The Conversation sid. |
{- "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": { },
- "links": { },
- "bindings": { }
}Updates a Conversation's mutable fields.
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ The Conversation sid. |
| FriendlyName | string |
| UniqueName | string |
| MessagingServiceSid | string |
| Attributes | string |
| State | string Enum: "initializing" "inactive" "active" "closed" |
| Timers.Inactive | string |
| Timers.Closed | string |
{- "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": { },
- "links": { },
- "bindings": { }
}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).
| 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. |
{- "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": { },
}Adds a message to the conversation. The server assigns the next
monotonic index. All fields are optional; Attributes defaults
to {}.
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ The parent Conversation sid. |
| Author | string |
| Body | string |
| Attributes | string |
| ContentSid | string Content template sid (HX...). |
{- "account_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "sid": "IMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "index": 0,
- "author": "+14155550103",
- "body": "Hello",
- "media": [
- { }
], - "attributes": "{}",
- "participant_sid": "stringstringstringstringstringstri",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "delivery": { },
- "links": { },
- "content_sid": "stringstringstringstringstringstri"
}Paginated list of the conversation's messages, ordered by index.
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ The parent Conversation sid. |
| PageSize | integer Maximum rows per page (default 50, max 1000). |
{- "messages": [
- {
- "account_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "sid": "IMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "index": 0,
- "author": "+14155550103",
- "body": "Hello",
- "media": [
- { }
], - "attributes": "{}",
- "participant_sid": "stringstringstringstringstringstri",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "delivery": { },
- "links": { },
- "content_sid": "stringstringstringstringstringstri"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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. |
{- "account_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "sid": "IMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "index": 0,
- "author": "+14155550103",
- "body": "Hello",
- "media": [
- { }
], - "attributes": "{}",
- "participant_sid": "stringstringstringstringstringstri",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "delivery": { },
- "links": { },
- "content_sid": "stringstringstringstringstringstri"
}Updates a Message's Author, Body, or Attributes.
| 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. |
| Author | string |
| Body | string |
| Attributes | string |
{- "account_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "sid": "IMxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "index": 0,
- "author": "+14155550103",
- "body": "Hello",
- "media": [
- { }
], - "attributes": "{}",
- "participant_sid": "stringstringstringstringstringstri",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "delivery": { },
- "links": { },
- "content_sid": "stringstringstringstringstringstri"
}| 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. |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}Paginated list of the message's per-channel delivery receipts (read-only).
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| MessageSid required | string^IM[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "delivery_receipts": [
- {
- "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",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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}$ |
{- "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",
}Adds a participant to the conversation — a chat Identity or an SMS
MessagingBinding.Address. Attributes defaults to {}.
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| Identity | string |
| Attributes | string |
| RoleSid | string |
| MessagingBinding.Address | string |
| MessagingBinding.ProxyAddress | string |
| MessagingBinding.ProjectedAddress | string |
{- "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",
- "last_read_message_index": 0,
- "last_read_timestamp": "string"
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "participants": [
- {
- "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",
- "last_read_message_index": 0,
- "last_read_timestamp": "string"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| ParticipantSid required | string^MB[0-9a-fA-F]{32}$ |
{- "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",
- "last_read_message_index": 0,
- "last_read_timestamp": "string"
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| ParticipantSid required | string^MB[0-9a-fA-F]{32}$ |
| Identity | string |
| Attributes | string |
| RoleSid | string |
| LastReadMessageIndex | integer |
| LastReadTimestamp | string |
{- "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",
- "last_read_message_index": 0,
- "last_read_timestamp": "string"
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| ParticipantSid required | string^MB[0-9a-fA-F]{32}$ |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}Lists the conversations a participant belongs to, optionally filtered
by Identity or messaging-binding Address.
| Identity | string |
| Address | string |
| PageSize | integer |
{- "conversations": [
- {
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "participant_sid": "stringstringstringstringstringstri",
- "participant_user_sid": "stringstringstringstringstringstri",
- "participant_identity": "string",
- "participant_messaging_binding": { },
- "conversation_sid": "stringstringstringstringstringstri",
- "conversation_unique_name": "string",
- "conversation_friendly_name": "string",
- "conversation_attributes": "string",
- "conversation_date_created": "2019-08-24T14:15:22Z",
- "conversation_date_updated": "2019-08-24T14:15:22Z",
- "conversation_created_by": "string",
- "conversation_state": "inactive",
- "conversation_timers": { },
- "links": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}Adds a conversation-scoped webhook. Target is required and must be
one of webhook, trigger, or studio.
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| Target required | string Enum: "webhook" "trigger" "studio" |
| Configuration.Url | string |
| Configuration.Method | string Enum: "GET" "POST" |
| Configuration.FlowSid | string |
| Configuration.ReplayAfter | integer |
{- "sid": "WH0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "target": "webhook",
- "configuration": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "webhooks": [
- {
- "sid": "WH0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "target": "webhook",
- "configuration": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| WebhookSid required | string^WH[0-9a-fA-F]{32}$ |
{- "sid": "WH0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "target": "webhook",
- "configuration": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| WebhookSid required | string^WH[0-9a-fA-F]{32}$ |
| Configuration.Url | string |
| Configuration.Method | string Enum: "GET" "POST" |
| Configuration.FlowSid | string |
{- "sid": "WH0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "target": "webhook",
- "configuration": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| WebhookSid required | string^WH[0-9a-fA-F]{32}$ |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| FriendlyName required | string |
| Type required | string Enum: "conversation" "service" |
| Permission required | Array of strings |
{- "sid": "RL0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "type": "conversation",
- "permissions": [
- "string"
], - "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}{- "roles": [
- {
- "sid": "RL0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "type": "conversation",
- "permissions": [
- "string"
], - "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}{- "sid": "RL0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "type": "conversation",
- "permissions": [
- "string"
], - "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}| Sid required | string^RL[0-9a-fA-F]{32}$ |
| Permission required | Array of strings |
{- "sid": "RL0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "type": "conversation",
- "permissions": [
- "string"
], - "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}| Identity required | string |
| FriendlyName | string |
| Attributes | string |
| RoleSid | string |
{- "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",
- "links": { }
}{- "users": [
- {
- "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",
- "links": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}{- "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",
- "links": { }
}| Sid required | string^US[0-9a-fA-F]{32}$ |
| FriendlyName | string |
| Attributes | string |
| RoleSid | string |
{- "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",
- "links": { }
}| Sid required | string^US[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "conversations": [
- {
- "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",
- "links": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| Sid required | string^US[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
{- "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",
- "links": { }
}| Sid required | string^US[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| NotificationLevel | string Enum: "default" "muted" |
| LastReadMessageIndex | integer |
| LastReadTimestamp | string |
{- "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",
- "links": { }
}| Type required | string Enum: "apn" "gcm" "fcm" |
| FriendlyName | string |
| Certificate | string |
| PrivateKey | string |
| Sandbox | boolean |
| ApiKey | string |
| Secret | string |
{- "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",
}{- "credentials": [
- {
- "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",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| Sid required | string^CR[0-9a-fA-F]{32}$ |
{- "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",
}| Sid required | string^CR[0-9a-fA-F]{32}$ |
| Type | string Enum: "apn" "gcm" "fcm" |
| FriendlyName | string |
| Certificate | string |
| PrivateKey | string |
| Sandbox | boolean |
| ApiKey | string |
| Secret | string |
{- "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",
}{- "account_sid": "stringstringstringstringstringstri",
- "default_chat_service_sid": "stringstringstringstringstringstri",
- "default_messaging_service_sid": "stringstringstringstringstringstri",
- "default_inactive_timer": "string",
- "default_closed_timer": "string",
- "links": { }
}| DefaultChatServiceSid | string |
| DefaultMessagingServiceSid | string |
| DefaultInactiveTimer | string |
| DefaultClosedTimer | string |
{- "account_sid": "stringstringstringstringstringstri",
- "default_chat_service_sid": "stringstringstringstringstringstri",
- "default_messaging_service_sid": "stringstringstringstringstringstri",
- "default_inactive_timer": "string",
- "default_closed_timer": "string",
- "links": { }
}{- "account_sid": "stringstringstringstringstringstri",
- "method": "GET",
- "filters": [
- "string"
], - "pre_webhook_url": "string",
- "post_webhook_url": "string",
- "target": "webhook",
}| Method | string Enum: "GET" "POST" |
| Filters | Array of strings |
| PreWebhookUrl | string |
| PostWebhookUrl | string |
| Target | string Enum: "webhook" "flex" |
{- "account_sid": "stringstringstringstringstringstri",
- "method": "GET",
- "filters": [
- "string"
], - "pre_webhook_url": "string",
- "post_webhook_url": "string",
- "target": "webhook",
}| 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 |
{- "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",
- "address_country": "string"
}{- "addresses": [
- {
- "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",
- "address_country": "string"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| Sid required | string^IG[0-9a-fA-F]{32}$ |
{- "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",
- "address_country": "string"
}| Sid required | string^IG[0-9a-fA-F]{32}$ |
| FriendlyName | string |
| AutoCreation.Enabled | boolean |
| AutoCreation.Type | string Enum: "webhook" "studio" "default" |
| AutoCreation.WebhookUrl | string |
{- "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",
- "address_country": "string"
}Shared path (see ServicesSharedResponse) — dispatches by Host header to either Conversation Service (conversations.twilio.com) or Messaging Service (messaging.twilio.com).
| FriendlyName required | string |
| InboundRequestUrl | string Messaging Service only. |
| InboundMethod | string Enum: "GET" "POST" Messaging Service only. |
| FallbackUrl | string Messaging Service only. |
| FallbackMethod | string Enum: "GET" "POST" Messaging Service only. |
| StatusCallback | string Messaging Service only. |
| StickySender | boolean Messaging Service only. |
| MmsConverter | boolean Messaging Service only. |
| SmartEncoding | boolean Messaging Service only. |
| ScanMessageContent | string Enum: "inherit" "enable" "disable" Messaging Service only. |
| FallbackToLongCode | boolean Messaging Service only. |
| AreaCodeGeomatch | boolean Messaging Service only. |
| SynchronousValidation | boolean Messaging Service only. |
| ValidityPeriod | integer Messaging Service only. |
| Usecase | string Messaging Service only. |
| UseInboundWebhookOnNumber | boolean Messaging Service only. |
{- "sid": "IS0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "links": { }
}Shared path (see ServicesSharedListResponse) — dispatches by Host header, same as create.
| PageSize | integer |
{- "services": [
- {
- "sid": "IS0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "links": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ChatServiceSid required | string^(IS|MG)[0-9a-fA-F]{32}$ IS = Conversation Service, MG = Messaging Service. |
{- "sid": "IS0123456789abcdef0123456789abcdef",
- "account_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
- "links": { }
}| ChatServiceSid required | string^(IS|MG)[0-9a-fA-F]{32}$ IS = Conversation Service, MG = Messaging Service. |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| FriendlyName | string |
| UniqueName | string |
| MessagingServiceSid | string |
| Attributes | string |
| State | string Enum: "initializing" "inactive" "active" "closed" |
| Timers.Inactive | string |
| Timers.Closed | string |
{- "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": { }
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "conversations": [
- {
- "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": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
{- "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": { }
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| FriendlyName | string |
| UniqueName | string |
| Attributes | string |
| State | string Enum: "initializing" "inactive" "active" "closed" |
| Timers.Inactive | string |
| Timers.Closed | string |
{- "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": { }
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| Author | string |
| Body | string |
| Attributes | string |
| ContentSid | string |
{- "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",
- "delivery": { },
- "links": { },
- "content_sid": "stringstringstringstringstringstri"
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "messages": [
- {
- "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",
- "delivery": { },
- "links": { },
- "content_sid": "stringstringstringstringstringstri"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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}$ |
{- "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",
- "delivery": { },
- "links": { },
- "content_sid": "stringstringstringstringstringstri"
}| 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}$ |
| Author | string |
| Body | string |
| Attributes | string |
{- "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",
- "delivery": { },
- "links": { },
- "content_sid": "stringstringstringstringstringstri"
}| 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}$ |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| Identity | string |
| Attributes | string |
| RoleSid | string |
| MessagingBinding.Address | string |
| MessagingBinding.ProxyAddress | string |
| MessagingBinding.ProjectedAddress | string |
{- "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",
- "last_read_message_index": 0,
- "last_read_timestamp": "string"
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "participants": [
- {
- "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",
- "last_read_message_index": 0,
- "last_read_timestamp": "string"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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}$ |
{- "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",
- "last_read_message_index": 0,
- "last_read_timestamp": "string"
}| 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}$ |
| Attributes | string |
| RoleSid | string |
{- "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",
- "last_read_message_index": 0,
- "last_read_timestamp": "string"
}| 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}$ |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| 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}$ |
| PageSize | integer |
{- "delivery_receipts": [
- {
- "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",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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}$ |
{- "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",
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| Target required | string Enum: "webhook" "trigger" "studio" |
| Configuration.Url | string |
| Configuration.Method | string Enum: "GET" "POST" |
| Configuration.FlowSid | string |
{- "sid": "stringstringstringstringstringstri",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "target": "string",
- "configuration": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| ConversationSid required | string^CH[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "webhooks": [
- {
- "sid": "stringstringstringstringstringstri",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "target": "string",
- "configuration": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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}$ |
{- "sid": "stringstringstringstringstringstri",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "target": "string",
- "configuration": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}| 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}$ |
| Configuration.Url | string |
| Configuration.Method | string Enum: "GET" "POST" |
| Configuration.FlowSid | string |
{- "sid": "stringstringstringstringstringstri",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "conversation_sid": "stringstringstringstringstringstri",
- "target": "string",
- "configuration": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}| 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}$ |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| FriendlyName required | string |
| Type required | string Enum: "conversation" "service" |
| Permission required | Array of strings |
{- "sid": "stringstringstringstringstringstri",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "type": "conversation",
- "permissions": [
- "string"
], - "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "roles": [
- {
- "sid": "stringstringstringstringstringstri",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "type": "conversation",
- "permissions": [
- "string"
], - "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| Sid required | string^RL[0-9a-fA-F]{32}$ |
{- "sid": "stringstringstringstringstringstri",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "type": "conversation",
- "permissions": [
- "string"
], - "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| Sid required | string^RL[0-9a-fA-F]{32}$ |
| Permission required | Array of strings |
{- "sid": "stringstringstringstringstringstri",
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "friendly_name": "string",
- "type": "conversation",
- "permissions": [
- "string"
], - "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z",
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| Identity required | string |
| FriendlyName | string |
| Attributes | string |
| RoleSid | string |
{- "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",
- "links": { }
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "users": [
- {
- "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",
- "links": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| Sid required | string^US[0-9a-fA-F]{32}$ |
{- "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",
- "links": { }
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| Sid required | string^US[0-9a-fA-F]{32}$ |
| FriendlyName | string |
| Attributes | string |
| RoleSid | string |
{- "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",
- "links": { }
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| 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. |
{- "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": { },
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| Identity | string |
| Address | string |
| PageSize | integer |
{- "conversations": [
- {
- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "participant_sid": "stringstringstringstringstringstri",
- "participant_user_sid": "stringstringstringstringstringstri",
- "participant_identity": "string",
- "participant_messaging_binding": { },
- "conversation_sid": "stringstringstringstringstringstri",
- "conversation_unique_name": "string",
- "conversation_friendly_name": "string",
- "conversation_attributes": "string",
- "conversation_date_created": "2019-08-24T14:15:22Z",
- "conversation_date_updated": "2019-08-24T14:15:22Z",
- "conversation_created_by": "string",
- "conversation_state": "inactive",
- "conversation_timers": { },
- "links": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| UserSid required | string^US[0-9a-fA-F]{32}$ |
| PageSize | integer |
{- "conversations": [
- {
- "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",
- "links": { }
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| BindingType | string Enum: "apn" "gcm" "fcm" "twilsock" |
| Identity | string |
| PageSize | integer |
{- "bindings": [
- {
- "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": [
- "string"
],
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| Sid required | string^BS[0-9a-fA-F]{32}$ |
{- "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": [
- "string"
],
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
{- "chat_service_sid": "stringstringstringstringstringstri",
- "default_conversation_creator_role_sid": "stringstringstringstringstringstri",
- "default_conversation_role_sid": "stringstringstringstringstringstri",
- "default_chat_service_role_sid": "stringstringstringstringstringstri",
- "links": { },
- "reachability_enabled": true
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| DefaultChatServiceRoleSid | string |
| DefaultConversationCreatorRoleSid | string |
| DefaultConversationRoleSid | string |
| ReachabilityEnabled | boolean |
{- "chat_service_sid": "stringstringstringstringstringstri",
- "default_conversation_creator_role_sid": "stringstringstringstringstringstri",
- "default_conversation_role_sid": "stringstringstringstringstringstri",
- "default_chat_service_role_sid": "stringstringstringstringstringstri",
- "links": { },
- "reachability_enabled": true
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
{- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "new_message": { },
- "added_to_conversation": { },
- "removed_from_conversation": { },
- "log_enabled": true,
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| 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 |
{- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "new_message": { },
- "added_to_conversation": { },
- "removed_from_conversation": { },
- "log_enabled": true,
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
{- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "pre_webhook_url": "string",
- "post_webhook_url": "string",
- "filters": [
- "string"
], - "method": "GET",
}| ChatServiceSid required | string^IS[0-9a-fA-F]{32}$ |
| PreWebhookUrl | string |
| PostWebhookUrl | string |
| Method | string Enum: "GET" "POST" |
| Filters | Array of strings |
{- "account_sid": "stringstringstringstringstringstri",
- "chat_service_sid": "stringstringstringstringstringstri",
- "pre_webhook_url": "string",
- "post_webhook_url": "string",
- "filters": [
- "string"
], - "method": "GET",
}| PageSize | integer |
| Page | integer |
| PageToken | string |
{- "assistants": [
- {
- "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"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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 |
{- "name": "string",
- "owner": "string",
- "personality_prompt": "string",
- "model": "string",
- "customer_ai": {
- "perception_engine_enabled": true,
- "personalization_engine_enabled": true
}, - "segment_credential": { }
}{- "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"
}| id required | string^aia_asst_.+$ |
{- "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": [
- {
- "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"
}
], - "knowledge": [
- {
- "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"
}
]
}| id required | string^aia_asst_.+$ |
| 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 |
{- "name": "string",
- "owner": "string",
- "personality_prompt": "string",
- "model": "string",
- "customer_ai": { },
- "segment_credential": { }
}{- "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"
}| id required | string^aia_asst_.+$ |
| identity required | string |
| body required | string |
| session_id | string |
| webhook | string |
| mode | string |
{- "identity": "string",
- "body": "string",
- "session_id": "string",
- "webhook": "string",
- "mode": "string"
}{- "status": "string",
- "flagged": true,
- "aborted": true,
- "session_id": "string",
- "account_sid": "stringstringstringstringstringstri",
- "body": "string",
- "error": "string"
}{- "tools": [
- {
- "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"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| name required | string |
| type required | string |
| enabled required | boolean |
| assistant_id | string |
| description | string |
| meta | object |
{- "name": "string",
- "type": "string",
- "enabled": true,
- "assistant_id": "string",
- "description": "string",
- "meta": { }
}{- "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"
}| id required | string^aia_tool_.+$ |
{- "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": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "account_sid": "stringstringstringstringstringstri",
- "user_sid": "stringstringstringstringstringstri",
- "type": "string",
- "policy_details": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}
]
}| id required | string^aia_tool_.+$ |
| name | string |
| type | string |
| enabled | boolean |
| description | string |
| meta | object |
{- "name": "string",
- "type": "string",
- "enabled": true,
- "description": "string",
- "meta": { }
}{- "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"
}| id required | string^aia_asst_.+$ |
| PageSize | integer |
{- "tools": [
- {
- "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"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}{- "knowledge": [
- {
- "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"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| name required | string |
| type required | string |
| assistant_id | string |
| description | string |
| embedding_model | string |
| knowledge_source_details | object |
{- "name": "string",
- "type": "string",
- "assistant_id": "string",
- "description": "string",
- "embedding_model": "string",
- "knowledge_source_details": { }
}{- "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"
}{- "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"
}| id required | string^aia_know_.+$ |
| name | string |
| type | string |
| description | string |
| embedding_model | string |
| knowledge_source_details | object |
{- "name": "string",
- "type": "string",
- "description": "string",
- "embedding_model": "string",
- "knowledge_source_details": { }
}{- "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"
}| id required | string^aia_know_.+$ |
{- "account_sid": "stringstringstringstringstringstri",
- "status": "string",
- "last_status": "string",
- "date_updated": "2019-08-24T14:15:22Z"
}| id required | string^aia_know_.+$ |
| PageSize | integer |
{- "chunks": [
- {
- "account_sid": "stringstringstringstringstringstri",
- "content": "string",
- "metadata": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| id required | string^aia_asst_.+$ |
| PageSize | integer |
{- "knowledge": [
- {
- "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"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}{- "sessions": [
- {
- "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"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}{- "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"
}| id required | string |
| PageSize | integer |
{- "messages": [
- {
- "id": "string",
- "account_sid": "stringstringstringstringstringstri",
- "assistant_id": "string",
- "session_id": "string",
- "identity": "string",
- "role": "string",
- "content": { },
- "meta": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| id required | string^aia_asst_.+$ |
| PageSize | integer |
{- "feedbacks": [
- {
- "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"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| id required | string^aia_asst_.+$ |
| session_id required | string |
| message_id | string |
| score | number <float> |
| text | string |
{- "session_id": "string",
- "message_id": "string",
- "score": 0.1,
- "text": "string"
}{- "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"
}| ToolId | string |
| KnowledgeId | string |
| PageSize | integer |
{- "policies": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "account_sid": "stringstringstringstringstringstri",
- "user_sid": "stringstringstringstringstringstri",
- "type": "string",
- "policy_details": { },
- "date_created": "2019-08-24T14:15:22Z",
- "date_updated": "2019-08-24T14:15:22Z"
}
], - "meta": {
- "page": 0,
- "page_size": 0,
- "key": "string"
}
}| 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. |
| 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. |
{- "recordings": [
- {
- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 ( |
| 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. |
{- "transcriptions": [
- {
- "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"
}
], - "page": 0,
- "page_size": 0,
- "start": 0,
- "end": 0,
- "first_page_uri": "string",
- "next_page_uri": "string",
- "previous_page_uri": "string",
- "uri": "string"
}| 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 ( |
| Sid required | string^TR[a-f0-9]{32}$ Twilio-format Transcription SID ( |
{- "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"
}| 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 ( |
| Sid required | string^TR[a-f0-9]{32}$ Twilio-format Transcription SID ( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| 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
( |
| IncludeSoftDeleted | boolean Twilio-compatible parameter. VoiceML hard-deletes recordings — accepted but does not change fetch behaviour. |
{- "sid": "RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
- "account_sid": "string",
- "call_sid": "string",
- "conference_sid": "string",
- "status": "in-progress",
- "source": "OutboundAPI",
- "channels": 1,
- "duration": "string",
- "track": "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
}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.
| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
| 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
( |
{- "code": 0,
- "message": "string",
- "more_info": "string",
- "status": 0
}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.
{- "ok": true,
- "warnings": [
- {
- "check": "memdb",
- "detail": "memdb ping: connection refused"
}
]
}