Schemas

CreateCallRequest

To

string · pattern: ^\+?[0-9]{7,15}$ · required

Destination phone number. E.164 format, or 7-15 digits with an optional leading plus sign.

Example: +2341000000001

From

string · pattern: ^\+?[0-9]{7,15}$ · required

Caller ID to originate the call from. Must be a phone number owned by the account; an unowned number returns error 21210.

Example: +2341000000002

Url

string · uri

Absolute 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.

Example: https://example.com/oneml/answer

Twiml

string · maxLength: 4000

Inline 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.

Example: <Response><Say>Hello from PressOne</Say></Response>

Method

string · enum

HTTP method used to fetch Url. Any value other than GET is treated as POST.

Enum values:

GET

POST

Example: POST

Default: POST

StatusCallback

string · uri

Absolute http(s) URL notified about call status changes.

Example: https://example.com/status-callback

StatusCallbackMethod

string · enum

HTTP method used to call StatusCallback. Any value other than GET is treated as POST.

Enum values:

GET

POST

Example: POST

Default: POST

StatusCallbackEvent

string[]

Call lifecycle events that trigger StatusCallback. Repeat the parameter to request more than one event. Defaults to ["completed"] when omitted or empty. This list reflects the events the platform emits; other values are accepted but never match an emitted event.

Enum values:

initiated

ringing

answered

completed

Example: ["initiated","completed"]

Default: ["completed"]

Timeout

integer · min: 1 · max: 600

Seconds to let the destination ring before the call is treated as unanswered. Values outside 1-600 are clamped rather than rejected.

Example: 60

Default: 60

CallerId

string · pattern: ^\+?[0-9]{7,15}$

Overrides the caller ID presented on this call. Must be a phone number owned by the account (error 21210) and in the same format as To/From (error 13214).

Example: +2341000000003

TimeLimit

integer

Maximum call duration in seconds, measured from answer.

Example: 3600

SendDigits

string · maxLength: 32 · pattern: ^[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).

Example: 1234#

ApplicationSid

string

Not supported by this API. Providing ApplicationSid always fails the request with error 21605; use Url or Twiml instead.

Example: APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

UpdateCallRequest

JSON body accepted by the update-call endpoint. Unlike the rest of this API, fields are snake_case and the content type is `application/json`, not form-encoded.

voice_url

string · uri

New OneML webhook URL to redirect the live call to.

Example: https://example.com/oneml/redirect

voice_method

string

HTTP method used to fetch voice_url.

Example: POST

twiml

string

Inline OneML document to run instead of fetching voice_url.

Example: <Response><Hangup/></Response>

Call

sid

string

Unique identifier of this call.

Example: CA5388f7a5e04d0ed71cac5cdf1ea17a53

account_sid

string

SID of the account that owns this call.

Example: AC9ce1cd445308e3ec5080c6126288aa09

api_version

string

date_created

string

RFC 2822 formatted creation timestamp.

Example: Thu, 02 Jul 2026 12:00:00 +0000

date_updated

string

RFC 2822 formatted last-update timestamp.

Example: Thu, 02 Jul 2026 12:00:05 +0000

annotation

string | null

Reserved for future use. Always null in the current implementation.

Example: null

answered_by

string | null

Reserved for future use (answering-machine detection). Always null in the current implementation.

Example: null

caller_name

string | null

Reserved for future use (CNAM lookup). Always null in the current implementation.

Example: null

direction

string

Call direction, for example inbound, outbound-api, or outbound-dial.

Example: outbound-api

duration

string | null

Billed call duration in seconds. Null until the call has an associated CDR.

Example: 45

end_time

string | null

RFC 2822 formatted end timestamp. Null until the call ends.

Example: Thu, 02 Jul 2026 12:00:50 +0000

forwarded_from

string | null

Reserved for future use. Always null in the current implementation.

Example: null

from

string

from_formatted

string

Currently always identical to from.

Example: +2341000000002

group_sid

string | null

Reserved for future use. Always null in the current implementation.

Example: null

trunk_sid

string | null

Reserved for future use; this system does not model trunk SIDs. Always null in the current implementation.

Example: null

parent_call_sid

string | null

SID of the call that created this one, when applicable.

Example: null

queue_time

string

Milliseconds the call waited between being queued and initiated. "0" when not applicable.

Example: 0

phone_number_sid

string | null

SID of the DID used for this call, when known.

Example: PN9992109eed74a671cdc4e192a934d43e

price

string | null

Cost of the call, negative for a debit. Null until the call is priced.

Example: -0.0400

price_unit

string | null

Currency of price.

Example: USD

start_time

string | null

RFC 2822 formatted answer timestamp. Null until the call is answered.

Example: Thu, 02 Jul 2026 12:00:05 +0000

status

string · enum

Current call status.

Enum values:

queued

ringing

in-progress

completed

busy

no-answer

canceled

failed

Example: in-progress

object

URIs of resources related to this call.

to

string

to_formatted

string

Currently always identical to to.

Example: +2341000000001

uri

string

Path of this call resource.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls/CA5388f7a5e04d0ed71cac5cdf1ea17a53.json

CallList

Call[]

uri

string

Path of this request, without query parameters.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls.json

page

integer

Current page number.

Example: 0

page_size

integer

Calls per page.

Example: 50

first_page_uri

string

Path of the first page.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls.json?page=0&page_size=50

next_page_uri

string

Path of the next page. Omitted from the response when there are no more results.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls.json?page=1&page_size=50

previous_page_uri

string

Path of the previous page. Omitted from the response on the first page.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls.json?page=0&page_size=50

Recording

sid

string

Unique identifier of this recording.

Example: REd947fbd985d13ecb4c31eca3186f20bb

account_sid

string

SID of the account that owns this recording.

Example: AC9ce1cd445308e3ec5080c6126288aa09

call_sid

string

SID of the call this recording was captured during.

Example: CA5388f7a5e04d0ed71cac5cdf1ea17a53

duration

integer

Recording duration in seconds. Omitted from the response until the recording finishes.

Example: 42

format

string

Media format of the recording, for example wav. Omitted from the response until known.

Example: wav

date_created

string · date-time

ISO 8601 creation timestamp.

Example: 2026-07-02T12:00:00Z

date_updated

string · date-time

ISO 8601 last-update timestamp.

Example: 2026-07-02T12:00:42Z

uri

string

Path of this recording resource.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Recordings/REd947fbd985d13ecb4c31eca3186f20bb.json

RecordingList

Recording[]

uri

string

Path of this request. This list is not paginated.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls/CA5388f7a5e04d0ed71cac5cdf1ea17a53/Recordings.json

Error

code

integer

PressOne/Twilio-compatible numeric error code.

Example: 21205

message

string

Human-readable error description.

Example: A valid 'Url' (absolute http(s)) or 'Twiml' must be provided.

more_info

string · uri

Reference URL for the error code.

Example: https://www.twilio.com/docs/errors/21205

status

integer

HTTP status code of the response.

Example: 400

CreateCallRequest

To

string · pattern: ^\+?[0-9]{7,15}$ · required

Destination phone number. E.164 format, or 7-15 digits with an optional leading plus sign.

Example: +2341000000001

From

string · pattern: ^\+?[0-9]{7,15}$ · required

Caller ID to originate the call from. Must be a phone number owned by the account; an unowned number returns error 21210.

Example: +2341000000002

Url

string · uri

Absolute 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.

Example: https://example.com/oneml/answer

Twiml

string · maxLength: 4000

Inline 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.

Example: <Response><Say>Hello from PressOne</Say></Response>

Method

string · enum

HTTP method used to fetch Url. Any value other than GET is treated as POST.

Enum values:

GET

POST

Example: POST

Default: POST

StatusCallback

string · uri

Absolute http(s) URL notified about call status changes.

Example: https://example.com/status-callback

StatusCallbackMethod

string · enum

HTTP method used to call StatusCallback. Any value other than GET is treated as POST.

Enum values:

GET

POST

Example: POST

Default: POST

StatusCallbackEvent

string[]

Enum values:

initiated

ringing

answered

completed

Example: ["initiated","completed"]

Default: ["completed"]

Timeout

integer · min: 1 · max: 600

Seconds to let the destination ring before the call is treated as unanswered. Values outside 1-600 are clamped rather than rejected.

Example: 60

Default: 60

CallerId

string · pattern: ^\+?[0-9]{7,15}$

Overrides the caller ID presented on this call. Must be a phone number owned by the account (error 21210) and in the same format as To/From (error 13214).

Example: +2341000000003

TimeLimit

integer

Maximum call duration in seconds, measured from answer.

Example: 3600

SendDigits

string · maxLength: 32 · pattern: ^[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).

Example: 1234#

ApplicationSid

string

Not supported by this API. Providing ApplicationSid always fails the request with error 21605; use Url or Twiml instead.

Example: APXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

UpdateCallRequest

JSON body accepted by the update-call endpoint. Unlike the rest of this API, fields are snake_case and the content type is `application/json`, not form-encoded.

voice_url

string · uri

New OneML webhook URL to redirect the live call to.

Example: https://example.com/oneml/redirect

voice_method

string

HTTP method used to fetch voice_url.

Example: POST

twiml

string

Inline OneML document to run instead of fetching voice_url.

Example: <Response><Hangup/></Response>

Call

sid

string

Unique identifier of this call.

Example: CA5388f7a5e04d0ed71cac5cdf1ea17a53

account_sid

string

SID of the account that owns this call.

Example: AC9ce1cd445308e3ec5080c6126288aa09

api_version

string

date_created

string

RFC 2822 formatted creation timestamp.

Example: Thu, 02 Jul 2026 12:00:00 +0000

date_updated

string

RFC 2822 formatted last-update timestamp.

Example: Thu, 02 Jul 2026 12:00:05 +0000

annotation

string | null

Reserved for future use. Always null in the current implementation.

Example: null

answered_by

string | null

Reserved for future use (answering-machine detection). Always null in the current implementation.

Example: null

caller_name

string | null

Reserved for future use (CNAM lookup). Always null in the current implementation.

Example: null

direction

string

Call direction, for example inbound, outbound-api, or outbound-dial.

Example: outbound-api

duration

string | null

Billed call duration in seconds. Null until the call has an associated CDR.

Example: 45

end_time

string | null

RFC 2822 formatted end timestamp. Null until the call ends.

Example: Thu, 02 Jul 2026 12:00:50 +0000

forwarded_from

string | null

Reserved for future use. Always null in the current implementation.

Example: null

from

string

from_formatted

string

Currently always identical to from.

Example: +2341000000002

group_sid

string | null

Reserved for future use. Always null in the current implementation.

Example: null

trunk_sid

string | null

Reserved for future use; this system does not model trunk SIDs. Always null in the current implementation.

Example: null

parent_call_sid

string | null

SID of the call that created this one, when applicable.

Example: null

queue_time

string

Milliseconds the call waited between being queued and initiated. "0" when not applicable.

Example: 0

phone_number_sid

string | null

SID of the DID used for this call, when known.

Example: PN9992109eed74a671cdc4e192a934d43e

price

string | null

Cost of the call, negative for a debit. Null until the call is priced.

Example: -0.0400

price_unit

string | null

Currency of price.

Example: USD

start_time

string | null

RFC 2822 formatted answer timestamp. Null until the call is answered.

Example: Thu, 02 Jul 2026 12:00:05 +0000

status

string · enum

Current call status.

Enum values:

queued

ringing

in-progress

completed

busy

no-answer

canceled

failed

Example: in-progress

object

URIs of resources related to this call.

to

string

to_formatted

string

Currently always identical to to.

Example: +2341000000001

uri

string

Path of this call resource.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls/CA5388f7a5e04d0ed71cac5cdf1ea17a53.json

CallList

Call[]

uri

string

Path of this request, without query parameters.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls.json

page

integer

Current page number.

Example: 0

page_size

integer

Calls per page.

Example: 50

first_page_uri

string

Path of the first page.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls.json?page=0&page_size=50

next_page_uri

string

Path of the next page. Omitted from the response when there are no more results.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls.json?page=1&page_size=50

previous_page_uri

string

Path of the previous page. Omitted from the response on the first page.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Calls.json?page=0&page_size=50

Recording

sid

string

Unique identifier of this recording.

Example: REd947fbd985d13ecb4c31eca3186f20bb

account_sid

string

SID of the account that owns this recording.

Example: AC9ce1cd445308e3ec5080c6126288aa09

call_sid

string

SID of the call this recording was captured during.

Example: CA5388f7a5e04d0ed71cac5cdf1ea17a53

duration

integer

Recording duration in seconds. Omitted from the response until the recording finishes.

Example: 42

format

string

Media format of the recording, for example wav. Omitted from the response until known.

Example: wav

date_created

string · date-time

ISO 8601 creation timestamp.

Example: 2026-07-02T12:00:00Z

date_updated

string · date-time

ISO 8601 last-update timestamp.

Example: 2026-07-02T12:00:42Z

uri

string

Path of this recording resource.

Example: /2010-04-01/Accounts/AC9ce1cd445308e3ec5080c6126288aa09/Recordings/REd947fbd985d13ecb4c31eca3186f20bb.json

Error

code

integer

PressOne/Twilio-compatible numeric error code.

Example: 21205

message

string

Human-readable error description.

Example: A valid 'Url' (absolute http(s)) or 'Twiml' must be provided.

more_info

string · uri

Reference URL for the error code.

Example: https://www.twilio.com/docs/errors/21205

status

integer

HTTP status code of the response.

Example: 400