Schemas
CreateCallRequest
To^\+?[0-9]{7,15}$ · requiredDestination phone number. E.164 format, or 7 to 15 digits with an optional leading plus sign.
From^\+?[0-9]{7,15}$ · requiredCaller ID to originate the call from. Must be a phone number your Signals project owns; an unowned number returns error 21210.
UrlAbsolute http(s) URL fetched for a OneML document once the call connects. Required unless Twiml is given. If both Url and Twiml are present, Url is used and Twiml is ignored.
TwimlInline OneML document to run instead of fetching Url. Ignored if Url is also present. Must parse as valid OneML, or the request fails with error 12100.
MethodHTTP method used to fetch Url. Any value other than GET is treated as POST.
StatusCallbackAbsolute http(s) URL notified about call status changes.
StatusCallbackMethodHTTP method used to call StatusCallback. Any value other than GET is treated as POST.
StatusCallbackEventCall lifecycle events that trigger StatusCallback. Repeat the parameter to request more than one event. Defaults to ["completed"] when omitted or empty. Other values are accepted but never match an emitted event.
TimeoutSeconds to let the destination ring before the call is treated as unanswered. Values outside 1 to 600 are clamped rather than rejected.
CallerId^\+?[0-9]{7,15}$Overrides the caller ID presented on this call. Must be a phone number your project owns (error 21210) and in the same format as To and From (error 13214).
TimeLimitMaximum call duration in seconds, measured from answer.
SendDigits^[0-9A-Da-d#*wW]{0,3…DTMF digits to play after the call connects. At most 32 characters from 0-9, A-D, a-d, #, *, w and W (w inserts a 0.5 second pause).
ApplicationSidNot supported. Providing ApplicationSid always fails the request with error 21605; use Url or Twiml instead. A Signals voice application ID is not accepted here either.
UpdateCallRequest
UrlAbsolute HTTP or HTTPS OneML URL for an in-progress call.
MethodTwimlInline OneML for an in-progress call.
Statuscompleted ends an in-progress call; canceled requires a call that has not answered.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: Url | |
| type = object · requires: Twiml | |
| type = object · requires: Status |
UrlAbsolute HTTP or HTTPS OneML URL for an in-progress call.
MethodTwimlInline OneML for an in-progress call.
Statuscompleted ends an in-progress call; canceled requires a call that has not answered.
Call
sidUnique identifier of this call.
account_sidSID of the Voice Account that owns this call.
api_versiondate_createdRFC 2822 formatted creation timestamp.
date_updatedRFC 2822 formatted last-update timestamp.
annotationReserved. Always null.
answered_byReserved for answering-machine detection. Always null.
caller_nameReserved for caller name lookup. Always null.
directionCall direction, for example inbound, outbound-api or outbound-dial.
durationCall duration in seconds. Null until the call has ended and been recorded.
end_timeRFC 2822 formatted end timestamp. Null until the call ends.
forwarded_fromReserved. Always null.
fromfrom_formattedIdentical to from.
group_sidReserved. Always null.
trunk_sidReserved. Always null.
parent_call_sidSID of the call that created this one, when applicable.
queue_timeMilliseconds the call waited between being queued and initiated. "0" when not applicable.
phone_number_sidSID of the number used for this call, when known.
pricePrice field reported by the voice engine. Signals charges for the call appear in Signals usage, not in this field.
price_unitCurrency of price.
start_timeRFC 2822 formatted answer timestamp. Null until the call is answered.
statusCurrent call status.
Paths of resources related to this call.
toto_formattedIdentical to to.
uriPath of this call resource.
CallList
uriPath of this request, without query parameters.
pageCurrent page number.
page_sizeCalls per page.
first_page_uriPath of the first page.
next_page_uriPath of the next page. Omitted when there are no more results.
previous_page_uriPath of the previous page. Omitted on the first page.
Recording
sidUnique identifier of this recording.
account_sidSID of the Voice Account that owns this recording.
call_sidSID of the call this recording was captured during.
durationRecording duration in seconds. Omitted until the recording finishes.
formatMedia format of the recording, for example wav. Omitted until known.
date_createdISO 8601 creation timestamp.
date_updatedISO 8601 last-update timestamp.
uriPath of this recording resource.
RecordingList
uriPath of this request. This list is not paginated.
CallEventList
startZero-based position of the first event on this page.
endZero-based position of the last event on this page, or start when the page is empty.
pagepage_sizeuriPath of this page.
first_page_urinext_page_uriPath of the next page, or null on the last page.
previous_page_uriPath of the previous page, or null on the first page.
TwilioError
codeTwilio-compatible numeric error code.
messageHuman-readable error description.
more_infoReference URL for the error code.
statusHTTP status code of the response.
Problem
typetitlestatusdetailcodeStable machine-readable error code.
request_idIdentifier of this request, also returned in the X-Request-ID header.