ByocTrunk Resource
The ByocTrunks resource describes a trunk that can be configured to send/receive traffic to/from a PSTN Carrier.
ByocTrunk properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created the BYOC Trunk resource. |
sid
|
The unique string that that we created to identify the BYOC Trunk resource. |
friendly_name
|
The string that you assigned to describe the resource. |
voice_url
|
The URL we call using the |
voice_method
|
The HTTP method we use to call |
voice_fallback_url
|
The URL that we call when an error occurs while retrieving or executing the TwiML requested from |
voice_fallback_method
|
The HTTP method we use to call |
status_callback_url
|
The URL that we call to pass status parameters (such as call ended) to your application. |
status_callback_method
|
The HTTP method we use to call |
cnam_lookup_enabled
|
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 for more information. |
connection_policy_sid
|
The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure. |
from_domain_sid
|
The SID of the SIP Domain that should be used in the |
date_created
|
The date and time in GMT that the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT that the resource was last updated specified in RFC 2822 format. |
url
|
The absolute URL of the resource. |
Create a ByocTrunk resource
https://voice.twilio.com/v1/ByocTrunks
Parameters
| Parameters in REST API format | |
|---|---|
friendly_name
Optional
|
A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. |
voice_url
Optional
|
The URL we should call when the BYOC Trunk receives a call. |
voice_method
Optional
|
The HTTP method we should use to call |
voice_fallback_url
Optional
|
The URL that we should call when an error occurs while retrieving or executing the TwiML from |
voice_fallback_method
Optional
|
The HTTP method we should use to call |
status_callback_url
Optional
|
The URL that we should call to pass status parameters (such as call ended) to your application. |
status_callback_method
Optional
|
The HTTP method we should use to call |
cnam_lookup_enabled
Optional
|
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 for more information. |
connection_policy_sid
Optional
|
The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure. |
from_domain_sid
Optional
|
The SID of the SIP Domain that should be used in the |
Example 1
Fetch a ByocTrunk resource
https://voice.twilio.com/v1/ByocTrunks/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The Twilio-provided string that uniquely identifies the BYOC Trunk resource to fetch. |
Example 1
Read multiple ByocTrunk resources
https://voice.twilio.com/v1/ByocTrunks
Example 1
Update a ByocTrunk resource
https://voice.twilio.com/v1/ByocTrunks/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The Twilio-provided string that uniquely identifies the BYOC Trunk resource to update. |
friendly_name
Optional
|
A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. |
voice_url
Optional
|
The URL we should call when the BYOC Trunk receives a call. |
voice_method
Optional
|
The HTTP method we should use to call |
voice_fallback_url
Optional
|
The URL that we should call when an error occurs while retrieving or executing the TwiML requested by |
voice_fallback_method
Optional
|
The HTTP method we should use to call |
status_callback_url
Optional
|
The URL that we should call to pass status parameters (such as call ended) to your application. |
status_callback_method
Optional
|
The HTTP method we should use to call |
cnam_lookup_enabled
Optional
|
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 for more information. |
connection_policy_sid
Optional
|
The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure. |
from_domain_sid
Optional
|
The SID of the SIP Domain that should be used in the |
Example 1
Delete a ByocTrunk resource
https://voice.twilio.com/v1/ByocTrunks/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The Twilio-provided string that uniquely identifies the BYOC Trunk resource to delete. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
