The ByocTrunks
resource describes a trunk that can be configured to send/receive traffic to/from a PSTN Carrier.
voice_url
type: string<uri>The URL we call using the voice_method
when the BYOC Trunk receives a call.
voice_method
type: enum<http-method>The HTTP method we use to call voice_url
. Can be: GET
or POST
.
GET
POST
voice_fallback_url
type: string<uri>The URL that we call when an error occurs while retrieving or executing the TwiML requested from voice_url
.
voice_fallback_method
type: enum<http-method>The HTTP method we use to call voice_fallback_url
. Can be: GET
or POST
.
GET
POST
status_callback_url
type: string<uri>The URL that we call to pass status parameters (such as call ended) to your application.
status_callback_method
type: enum<http-method>The HTTP method we use to call status_callback_url
. Either GET
or POST
.
GET
POST
cnam_lookup_enabled
type: booleanWhether 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 for more information.
connection_policy_sid
type: SID<NY>The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure.
from_domain_sid
type: SID<SD>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 to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com".
date_created
type: string<date-time>The date and time in GMT that the resource was created specified in RFC 2822 format.
date_updated
type: string<date-time>The date and time in GMT that the resource was last updated specified in RFC 2822 format.
POST https://voice.twilio.com/v1/ByocTrunks
FriendlyName
type: stringA descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.
VoiceUrl
type: string<uri>The URL we should call when the BYOC Trunk receives a call.
VoiceMethod
type: enum<http-method>The HTTP method we should use to call voice_url
. Can be: GET
or POST
.
GET
POST
VoiceFallbackUrl
type: string<uri>The URL that we should call when an error occurs while retrieving or executing the TwiML from voice_url
.
VoiceFallbackMethod
type: enum<http-method>The HTTP method we should use to call voice_fallback_url
. Can be: GET
or POST
.
GET
POST
StatusCallbackUrl
type: string<uri>The URL that we should call to pass status parameters (such as call ended) to your application.
StatusCallbackMethod
type: enum<http-method>The HTTP method we should use to call status_callback_url
. Can be: GET
or POST
.
GET
POST
CnamLookupEnabled
type: booleanWhether 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 for more information.
ConnectionPolicySid
type: SID<NY>The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure.
FromDomainSid
type: SID<SD>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 to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com".
GET https://voice.twilio.com/v1/ByocTrunks/{Sid}
Sid
type: SID<BY>The Twilio-provided string that uniquely identifies the BYOC Trunk resource to fetch.
GET https://voice.twilio.com/v1/ByocTrunks
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
POST https://voice.twilio.com/v1/ByocTrunks/{Sid}
Sid
type: SID<BY>The Twilio-provided string that uniquely identifies the BYOC Trunk resource to update.
FriendlyName
type: stringA descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.
VoiceUrl
type: string<uri>The URL we should call when the BYOC Trunk receives a call.
VoiceMethod
type: enum<http-method>The HTTP method we should use to call voice_url
GET
POST
VoiceFallbackUrl
type: string<uri>The URL that we should call when an error occurs while retrieving or executing the TwiML requested by voice_url
.
VoiceFallbackMethod
type: enum<http-method>The HTTP method we should use to call voice_fallback_url
. Can be: GET
or POST
.
GET
POST
StatusCallbackUrl
type: string<uri>The URL that we should call to pass status parameters (such as call ended) to your application.
StatusCallbackMethod
type: enum<http-method>The HTTP method we should use to call status_callback_url
. Can be: GET
or POST
.
GET
POST
CnamLookupEnabled
type: booleanWhether 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 for more information.
ConnectionPolicySid
type: SID<NY>The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure.
FromDomainSid
type: SID<SD>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 to ensure proper routing. If not configured, the from domain will default to "sip.twilio.com".
DELETE https://voice.twilio.com/v1/ByocTrunks/{Sid}
Sid
type: SID<BY>The Twilio-provided string that uniquely identifies the BYOC Trunk resource to delete.