Update byoc trunk

POST /v1/ByocTrunks/{Sid}

BYOC Trunks allow you to bring your own voice carrier to Twilio, enabling your calls to use our Programmable Voice APIs.

Path parameters

  • Sid string Required

    The Twilio-provided string that uniquely identifies the BYOC Trunk resource to update.

application/x-www-form-urlencoded

Body

  • CnamLookupEnabled boolean

    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.

  • ConnectionPolicySid string

    The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^NY[0-9a-fA-F]{32}$.

  • FriendlyName string

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

  • FromDomainSid string

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SD[0-9a-fA-F]{32}$.

  • StatusCallbackMethod string(http-method)

    The HTTP method we should use to call status_callback_url. Can be: GET or POST.

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • StatusCallbackUrl string(uri)

    The URL that we should call to pass status parameters (such as call ended) to your application.

  • VoiceFallbackMethod string(http-method)

    The HTTP method we should use to call voice_fallback_url. Can be: GET or POST.

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • VoiceFallbackUrl string(uri)

    The URL that we should call when an error occurs while retrieving or executing the TwiML requested by voice_url.

  • VoiceMethod string(http-method)

    The HTTP method we should use to call voice_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • VoiceUrl string(uri)

    The URL we should call when the BYOC Trunk receives a call.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • cnam_lookup_enabled boolean | null

      Whether Caller ID Name (CNAM) lookup is enabled for the trunk

    • connection_policy_sid string | null

      Origination Connection Policy (to your Carrier)

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^NY[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT that the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT that the resource was last updated

    • friendly_name string | null

      The string that you assigned to describe the resource

    • from_domain_sid string | null

      The SID of the SIP Domain that should be used in the From header of originating calls

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SD[0-9a-fA-F]{32}$.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BY[0-9a-fA-F]{32}$.

    • status_callback_method string(http-method) | null

      The HTTP method we use to call status_callback_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • status_callback_url string(uri) | null

      The URL that we call with status updates

    • url string(uri) | null

      The absolute URL of the resource

    • voice_fallback_method string(http-method) | null

      The HTTP method used with voice_fallback_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • voice_fallback_url string(uri) | null

      The URL we call when an error occurs while executing TwiML

    • voice_method string(http-method) | null

      The HTTP method to use with voice_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • voice_url string(uri) | null

      The URL we call when receiving a call
POST /v1/ByocTrunks/{Sid} 
curl \
 -X POST https://voice.twilio.com/v1/ByocTrunks/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'CnamLookupEnabled=true&ConnectionPolicySid=string&FriendlyName=string&FromDomainSid=string&StatusCallbackMethod=HEAD&StatusCallbackUrl=https%3A%2F%2Fexample.com&VoiceFallbackMethod=HEAD&VoiceFallbackUrl=https%3A%2F%2Fexample.com&VoiceMethod=HEAD&VoiceUrl=https%3A%2F%2Fexample.com'
Request example 
{
  "CnamLookupEnabled": true,
  "ConnectionPolicySid": "string",
  "FriendlyName": "string",
  "FromDomainSid": "string",
  "StatusCallbackMethod": "HEAD",
  "StatusCallbackUrl": "https://example.com",
  "VoiceFallbackMethod": "HEAD",
  "VoiceFallbackUrl": "https://example.com",
  "VoiceMethod": "HEAD",
  "VoiceUrl": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "cnam_lookup_enabled": true,
  "connection_policy_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "from_domain_sid": "string",
  "sid": "string",
  "status_callback_method": "HEAD",
  "status_callback_url": "https://example.com",
  "url": "https://example.com",
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_url": "https://example.com"
}