Create trunk

POST /v1/Trunks

Represents a SIP trunk

application/x-www-form-urlencoded

Body

  • Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP 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.

  • DisasterRecoveryMethod string(http-method)

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

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

  • The URL we should call using the disaster_recovery_method if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See Disaster Recovery for more information.

  • The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and - and must end with pstn.twilio.com. See Termination Settings for more information.

  • A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • Secure boolean

    Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See Secure Trunking for more information.

  • Caller Id for transfer target. Can be: from-transferee (default) or from-transferor.

    Values are from-transferee or from-transferor.

  • The call transfer settings for the trunk. Can be: enable-all, sip-only and disable-all. See Transfer for more information.

    Values are disable-all, enable-all, or sip-only.

Responses

  • 201

    Created

    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}$.

    • auth_type string | null

      The types of authentication mapped to the domain

    • auth_type_set array[string] | null

      Reserved

    • cnam_lookup_enabled boolean | null

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

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • disaster_recovery_method string(http-method) | null

      The HTTP method we use to call the disaster_recovery_url

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

    • disaster_recovery_url string(uri) | null

      The HTTP URL that we call if an error occurs while sending SIP traffic towards your configured Origination URL

    • domain_name string | null

      The unique address you reserve on Twilio to which you route your SIP traffic

    • friendly_name string | null

      The string that you assigned to describe the resource

    • The recording settings for the trunk

    • secure boolean | null

      Whether Secure Trunking is enabled for the trunk

    • sid string | null

      The unique string that identifies the resource

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

    • transfer_caller_id string | null

      Caller Id for transfer target

      Values are from-transferee or from-transferor.

    • transfer_mode string | null

      The call transfer settings for the trunk

      Values are disable-all, enable-all, or sip-only.

    • url string(uri) | null

      The absolute URL of the resource

POST /v1/Trunks
curl \
 -X POST https://trunking.twilio.com/v1/Trunks \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'CnamLookupEnabled=true&DisasterRecoveryMethod=HEAD&DisasterRecoveryUrl=https%3A%2F%2Fexample.com&DomainName=string&FriendlyName=string&Secure=true&TransferCallerId=from-transferee&TransferMode=disable-all'
Request example
{
  "CnamLookupEnabled": true,
  "DisasterRecoveryMethod": "HEAD",
  "DisasterRecoveryUrl": "https://example.com",
  "DomainName": "string",
  "FriendlyName": "string",
  "Secure": true,
  "TransferCallerId": "from-transferee",
  "TransferMode": "disable-all"
}
Response examples (201)
{
  "account_sid": "string",
  "auth_type": "string",
  "auth_type_set": [
    "string"
  ],
  "cnam_lookup_enabled": true,
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "disaster_recovery_method": "HEAD",
  "disaster_recovery_url": "https://example.com",
  "domain_name": "string",
  "friendly_name": "string",
  "links": {},
  "secure": true,
  "sid": "string",
  "transfer_caller_id": "from-transferee",
  "transfer_mode": "disable-all",
  "url": "https://example.com"
}