Twilio Voice API is a communication service that allows developers to easily integrate voice calling functionality into their applications. With the Twilio Voice API, developers can make and receive phone calls, create interactive voice response systems, and implement features like call recording and transcription.
components:
schemas:
voice.v1.archived_call:
type: object
properties:
date:
type: string
format: date
nullable: true
description: The date
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
description: The call sid
url:
type: string
format: uri
nullable: true
description: The absolute URL of the resource.
voice.v1.byoc_trunk:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the BYOC Trunk resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^BY[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that that we created to identify the BYOC Trunk
resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
voice_url:
type: string
format: uri
nullable: true
description: >-
The URL we call using the `voice_method` when the BYOC Trunk
receives a call.
x-twilio:
pii:
handling: standard
deleteSla: 30
voice_method:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
nullable: true
description: 'The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.'
voice_fallback_url:
type: string
format: uri
nullable: true
description: >-
The URL that we call when an error occurs while retrieving or
executing the TwiML requested from `voice_url`.
x-twilio:
pii:
handling: standard
deleteSla: 30
voice_fallback_method:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
nullable: true
description: >-
The HTTP method we use to call `voice_fallback_url`. Can be: `GET`
or `POST`.
status_callback_url:
type: string
format: uri
nullable: true
description: >-
The URL that we call to pass status parameters (such as call ended)
to your application.
x-twilio:
pii:
handling: standard
deleteSla: 30
status_callback_method:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
nullable: true
description: >-
The HTTP method we use to call `status_callback_url`. Either `GET`
or `POST`.
cnam_lookup_enabled:
type: boolean
nullable: true
description: >-
Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If
enabled, all inbound calls to the BYOC Trunk from the United States
and Canada automatically perform a CNAM Lookup and display Caller ID
data on your phone. See [CNAM
Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more
information.
connection_policy_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^NY[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Connection Policy that Twilio will use when routing
traffic to your communications infrastructure.
from_domain_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^SD[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the SIP Domain that should be used in the `From` header
of originating calls sent to your SIP infrastructure. If your SIP
infrastructure allows users to "call back" an incoming call,
configure this with a [SIP
Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure
proper routing. If not configured, the from domain will default to
"sip.twilio.com".
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT that the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT that the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the resource.
voice.v1.connection_policy:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Connection Policy resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^NY[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Connection Policy
resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of related resources.
voice.v1.connection_policy.connection_policy_target:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Target resource.
connection_policy_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^NY[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Connection Policy that owns the Target.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^NE[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Target resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
target:
type: string
format: uri
nullable: true
description: >-
The SIP address you want Twilio to route your calls to. This must be
a `sip:` schema. `sips` is NOT supported.
x-twilio:
pii:
handling: standard
deleteSla: 30
priority:
type: integer
nullable: true
description: >-
The relative importance of the target. Can be an integer from 0 to
65535, inclusive, and the default is 10. The lowest number
represents the most important target.
weight:
type: integer
nullable: true
description: >-
The value that determines the relative share of the load the Target
should receive compared to other Targets with the same priority. Can
be an integer from 1 to 65535, inclusive, and the default is 10.
Targets with higher values receive more load than those with lower
ones with the same priority.
enabled:
type: boolean
nullable: true
description: Whether the target is enabled. The default is `true`.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the resource.
voice.v1.dialing_permissions:
type: object
properties: {}
voice.v1.dialing_permissions.dialing_permissions_country:
type: object
properties:
iso_code:
type: string
format: iso-country-code
nullable: true
description: >-
The [ISO country
code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
name:
type: string
nullable: true
description: The name of the country.
continent:
type: string
nullable: true
description: The name of the continent in which the country is located.
country_codes:
type: array
items:
type: string
nullable: true
description: >-
The E.164 assigned [country
codes(s)](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)
low_risk_numbers_enabled:
type: boolean
nullable: true
description: Whether dialing to low-risk numbers is enabled.
high_risk_special_numbers_enabled:
type: boolean
nullable: true
description: >-
Whether dialing to high-risk special services numbers is enabled.
These prefixes include number ranges allocated by the country and
include premium numbers, special services, shared cost, and others
high_risk_tollfraud_numbers_enabled:
type: boolean
nullable: true
description: >-
Whether dialing to high-risk [toll
fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html)
numbers is enabled. These prefixes include narrow number ranges that
have a high-risk of international revenue sharing fraud (IRSF)
attacks, also known as [toll
fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html).
These prefixes are collected from anti-fraud databases and verified
by analyzing calls on our network. These prefixes are not available
for download and are updated frequently
url:
type: string
format: uri
nullable: true
description: The absolute URL of this resource.
links:
type: object
format: uri-map
nullable: true
description: A list of URLs related to this resource.
voice.v1.dialing_permissions.dialing_permissions_country-instance:
type: object
properties:
iso_code:
type: string
format: iso-country-code
nullable: true
description: >-
The [ISO country
code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
name:
type: string
nullable: true
description: The name of the country.
continent:
type: string
nullable: true
description: The name of the continent in which the country is located.
country_codes:
type: array
items:
type: string
nullable: true
description: >-
The E.164 assigned [country
codes(s)](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)
low_risk_numbers_enabled:
type: boolean
nullable: true
description: Whether dialing to low-risk numbers is enabled.
high_risk_special_numbers_enabled:
type: boolean
nullable: true
description: >-
Whether dialing to high-risk special services numbers is enabled.
These prefixes include number ranges allocated by the country and
include premium numbers, special services, shared cost, and others
high_risk_tollfraud_numbers_enabled:
type: boolean
nullable: true
description: >-
Whether dialing to high-risk [toll
fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html)
numbers is enabled. These prefixes include narrow number ranges that
have a high-risk of international revenue sharing fraud (IRSF)
attacks, also known as [toll
fraud](https://www.twilio.com/blog/how-to-protect-your-account-from-toll-fraud-with-voice-dialing-geo-permissions-html).
These prefixes are collected from anti-fraud databases and verified
by analyzing calls on our network. These prefixes are not available
for download and are updated frequently
url:
type: string
format: uri
nullable: true
description: The absolute URL of this resource.
links:
type: object
format: uri-map
nullable: true
description: A list of URLs related to this resource.
voice.v1.dialing_permissions.dialing_permissions_country_bulk_update:
type: object
properties:
update_count:
type: integer
nullable: true
description: The number of countries updated
update_request:
type: string
nullable: true
description: >-
A bulk update request to change voice dialing country permissions
stored as a URL-encoded, JSON array of update objects. For example :
`[ { "iso_code": "GB", "low_risk_numbers_enabled": "true",
"high_risk_special_numbers_enabled":"true",
"high_risk_tollfraud_numbers_enabled": "false" } ]`
voice.v1.dialing_permissions.dialing_permissions_country.dialing_permissions_hrs_prefixes:
type: object
properties:
prefix:
type: string
nullable: true
description: >-
A prefix is a contiguous number range for a block of E.164 numbers
that includes the E.164 assigned country code. For example, a North
American Numbering Plan prefix like `+1510720` written like `+1(510)
720` matches all numbers inclusive from `+1(510) 720-0000` to
`+1(510) 720-9999`.
voice.v1.dialing_permissions.dialing_permissions_settings:
type: object
properties:
dialing_permissions_inheritance:
type: boolean
nullable: true
description: >-
`true` if the sub-account will inherit voice dialing permissions
from the Master Project; otherwise `false`.
url:
type: string
format: uri
nullable: true
description: The absolute URL of this resource.
voice.v1.ip_record:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the IP Record resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IL[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the IP Record
resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
ip_address:
type: string
nullable: true
description: An IP address in dotted decimal notation, IPv4 only.
x-twilio:
pii:
handling: standard
deleteSla: 30
cidr_prefix_length:
type: integer
nullable: true
description: >-
An integer representing the length of the
[CIDR](https://tools.ietf.org/html/rfc4632) prefix to use with this
IP address. By default the entire IP address is used, which for IPv4
is value 32.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT that the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT that the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the resource.
voice.v1.source_ip_mapping:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IB[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the IP Record
resource.
ip_record_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IL[0-9a-fA-F]{32}$
nullable: true
description: >-
The Twilio-provided string that uniquely identifies the IP Record
resource to map from.
sip_domain_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^SD[0-9a-fA-F]{32}$
nullable: true
description: The SID of the SIP Domain that the IP Record is mapped to.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT that the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT that the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the resource.
CreateByocTrunkRequest:
type: object
properties:
FriendlyName:
type: string
description: >-
A descriptive string that you create to describe the resource. It is
not unique and can be up to 255 characters long.
VoiceUrl:
type: string
format: uri
description: The URL we should call when the BYOC Trunk receives a call.
VoiceMethod:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
description: >-
The HTTP method we should use to call `voice_url`. Can be: `GET` or
`POST`.
VoiceFallbackUrl:
type: string
format: uri
description: >-
The URL that we should call when an error occurs while retrieving or
executing the TwiML from `voice_url`.
VoiceFallbackMethod:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
description: >-
The HTTP method we should use to call `voice_fallback_url`. Can be:
`GET` or `POST`.
StatusCallbackUrl:
type: string
format: uri
description: >-
The URL that we should call to pass status parameters (such as call
ended) to your application.
StatusCallbackMethod:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
description: >-
The HTTP method we should use to call `status_callback_url`. Can be:
`GET` or `POST`.
CnamLookupEnabled:
type: boolean
description: >-
Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If
enabled, all inbound calls to the BYOC Trunk from the United States
and Canada automatically perform a CNAM Lookup and display Caller ID
data on your phone. See [CNAM
Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more
information.
ConnectionPolicySid:
type: string
minLength: 34
maxLength: 34
pattern: ^NY[0-9a-fA-F]{32}$
description: >-
The SID of the Connection Policy that Twilio will use when routing
traffic to your communications infrastructure.
FromDomainSid:
type: string
minLength: 34
maxLength: 34
pattern: ^SD[0-9a-fA-F]{32}$
description: >-
The SID of the SIP Domain that should be used in the `From` header
of originating calls sent to your SIP infrastructure. If your SIP
infrastructure allows users to "call back" an incoming call,
configure this with a [SIP
Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure
proper routing. If not configured, the from domain will default to
"sip.twilio.com".
ListByocTrunkResponse:
type: object
properties:
byoc_trunks:
type: array
items:
$ref: '#/components/schemas/voice.v1.byoc_trunk'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
UpdateByocTrunkRequest:
type: object
properties:
FriendlyName:
type: string
description: >-
A descriptive string that you create to describe the resource. It is
not unique and can be up to 255 characters long.
VoiceUrl:
type: string
format: uri
description: The URL we should call when the BYOC Trunk receives a call.
VoiceMethod:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
description: The HTTP method we should use to call `voice_url`
VoiceFallbackUrl:
type: string
format: uri
description: >-
The URL that we should call when an error occurs while retrieving or
executing the TwiML requested by `voice_url`.
VoiceFallbackMethod:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
description: >-
The HTTP method we should use to call `voice_fallback_url`. Can be:
`GET` or `POST`.
StatusCallbackUrl:
type: string
format: uri
description: >-
The URL that we should call to pass status parameters (such as call
ended) to your application.
StatusCallbackMethod:
type: string
format: http-method
enum:
- HEAD
- GET
- POST
- PATCH
- PUT
- DELETE
description: >-
The HTTP method we should use to call `status_callback_url`. Can be:
`GET` or `POST`.
CnamLookupEnabled:
type: boolean
description: >-
Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If
enabled, all inbound calls to the BYOC Trunk from the United States
and Canada automatically perform a CNAM Lookup and display Caller ID
data on your phone. See [CNAM
Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more
information.
ConnectionPolicySid:
type: string
minLength: 34
maxLength: 34
pattern: ^NY[0-9a-fA-F]{32}$
description: >-
The SID of the Connection Policy that Twilio will use when routing
traffic to your communications infrastructure.
FromDomainSid:
type: string
minLength: 34
maxLength: 34
pattern: ^SD[0-9a-fA-F]{32}$
description: >-
The SID of the SIP Domain that should be used in the `From` header
of originating calls sent to your SIP infrastructure. If your SIP
infrastructure allows users to "call back" an incoming call,
configure this with a [SIP
Domain](https://www.twilio.com/docs/voice/api/sending-sip) to ensure
proper routing. If not configured, the from domain will default to
"sip.twilio.com".
CreateConnectionPolicyRequest:
type: object
properties:
FriendlyName:
type: string
description: >-
A descriptive string that you create to describe the resource. It is
not unique and can be up to 255 characters long.
ListConnectionPolicyResponse:
type: object
properties:
connection_policies:
type: array
items:
$ref: '#/components/schemas/voice.v1.connection_policy'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
UpdateConnectionPolicyRequest:
type: object
properties:
FriendlyName:
type: string
description: >-
A descriptive string that you create to describe the resource. It is
not unique and can be up to 255 characters long.
CreateConnectionPolicyTargetRequest:
type: object
required:
- Target
properties:
Target:
type: string
format: uri
description: >-
The SIP address you want Twilio to route your calls to. This must be
a `sip:` schema. `sips` is NOT supported.
FriendlyName:
type: string
description: >-
A descriptive string that you create to describe the resource. It is
not unique and can be up to 255 characters long.
Priority:
type: integer
description: >-
The relative importance of the target. Can be an integer from 0 to
65535, inclusive, and the default is 10. The lowest number
represents the most important target.
Weight:
type: integer
description: >-
The value that determines the relative share of the load the Target
should receive compared to other Targets with the same priority. Can
be an integer from 1 to 65535, inclusive, and the default is 10.
Targets with higher values receive more load than those with lower
ones with the same priority.
Enabled:
type: boolean
description: Whether the Target is enabled. The default is `true`.
ListConnectionPolicyTargetResponse:
type: object
properties:
targets:
type: array
items:
$ref: >-
#/components/schemas/voice.v1.connection_policy.connection_policy_target
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nullable: true
page:
type: integer
page_size:
type: integer
previous_page_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
key:
type: string
UpdateConnectionPolicyTargetRequest:
type: object
properties:
FriendlyName:
type: string
description: >-
A descriptive string that you create to describe the resource. It is
not unique and can be up to 255 characters long.
Target:
type: string
format: uri
description: >-
The SIP address you want Twilio to route your calls to. This must be
a `sip:` schema. `sips` is NOT supported.
Priority:
type: integer
description: >-
The relative importance of the target. Can be an integer from 0 to
65535, inclusive. The lowest number represents the most important
target.
Weight:
type: integer
description: >-
The value that determines the relative share of the load the Target
should receive compared to other Targets with the same priority. Can
be an integer from 1 to 65535, inclusive. Targets with higher values
receive more load than those with lower ones with the same priority.
Enabled:
type: boolean
description: Whether the Target is enabled.
ListDialingPermissionsCountryRespons
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/voice-openapi-original.yml