Create trunk

POST /v1/Trunks

Represents a SIP trunk

application/x-www-form-urlencoded

Body

  • FriendlyName string

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

  • DomainName string

    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.

  • DisasterRecoveryUrl string(uri)

    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.

  • DisasterRecoveryMethod string(http-method)

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

    Values are GET or POST.

  • TransferMode string

    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.

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

  • CnamLookupEnabled boolean

    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.

  • TransferCallerId string

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

    Values are from-transferee or from-transferor.

Responses

  • 201 application/json

    Created

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

      The SID of the Account that created the Trunk resource.

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

    • domain_name string | null

      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.

    • disaster_recovery_method string(http-method) | null

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

      Values are GET or POST.

    • disaster_recovery_url string(uri) | null

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

    • friendly_name string | null

      The string that you assigned to describe the resource.

    • secure boolean | null

      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.

    • recording

      The recording settings for the trunk. Can be: do-not-record, record-from-ringing, record-from-answer. If set to record-from-ringing or record-from-answer, all calls going through the trunk will be recorded. The only way to change recording parameters is on a sub-resource of a Trunk after it has been created. e.g./Trunks/[Trunk_SID]/Recording -XPOST -d'Mode=record-from-answer'. See Recording for more information.

    • transfer_mode string

      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.

    • transfer_caller_id string

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

      Values are from-transferee or from-transferor.

    • cnam_lookup_enabled boolean | null

      Whether Caller ID Name (CNAM) lookup is 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.

    • auth_type string | null

      The types of authentication mapped to the domain. Can be: IP_ACL and CREDENTIAL_LIST. If both are mapped, the values are returned in a comma delimited list. If empty, the domain will not receive any traffic.

    • symmetric_rtp_enabled boolean | null

      Whether Symmetric RTP is enabled for the trunk. When Symmetric RTP is disabled, Twilio will send RTP to the destination negotiated in the SDP. Disabling Symmetric RTP is considered to be more secure and therefore recommended. See Symmetric RTP for more information.

    • auth_type_set array[string] | null

      Reserved.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • sid string | null

      The unique string that we created to identify the Trunk resource.

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

    • url string(uri) | null

      The absolute URL of the resource.

POST /v1/Trunks
curl \
 --request POST 'https://trunking.twilio.com/v1/Trunks' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Secure=false&DomainName=test.pstn.twilio.com&FriendlyName=friendly_name&TransferMode=disable-all&TransferCallerId=from-transferee&CnamLookupEnabled=false&DisasterRecoveryUrl=http%3A%2F%2Fdisaster-recovery.com&DisasterRecoveryMethod=GET'
Request example
{"Secure"=>false, "DomainName"=>"test.pstn.twilio.com", "FriendlyName"=>"friendly_name", "TransferMode"=>"disable-all", "TransferCallerId"=>"from-transferee", "CnamLookupEnabled"=>false, "DisasterRecoveryUrl"=>"http://disaster-recovery.com", "DisasterRecoveryMethod"=>"GET"}
Response examples (201)
{
  "sid": "TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "phone_numbers": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers",
    "credential_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/CredentialLists",
    "origination_urls": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OriginationUrls",
    "ip_access_control_lists": "https://trunking.twilio.com/v1/Trunks/TKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlLists"
  },
  "secure": false,
  "auth_type": "",
  "recording": {
    "mode": "do-not-record",
    "trim": "do-not-trim"
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "domain_name": "test.pstn.twilio.com",
  "date_created": "2015-01-02T11:23:45Z",
  "date_updated": "2015-01-02T11:23:45Z",
  "auth_type_set": [],
  "friendly_name": "friendly_name",
  "transfer_mode": "disable-all",
  "transfer_caller_id": "from-transferee",
  "cnam_lookup_enabled": false,
  "disaster_recovery_url": "http://disaster-recovery.com",
  "symmetric_rtp_enabled": false,
  "disaster_recovery_method": "POST"
}