Create a new Domain

POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json

Custom DNS hostnames that can accept SIP traffic

Create a new Domain

Path parameters

AccountSid string Required

The SID of the Account that will create the resource.

Body

ByocTrunkSid string

The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.

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

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 sip.twilio.com.
EmergencyCallerSid string

Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.

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

Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
FriendlyName string

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

Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
SipRegistration boolean

Whether to allow SIP Endpoints to register with the domain to receive calls. Can be true or false. true allows SIP Endpoints to register with the domain to receive calls, false does not.
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 from voice_url.
VoiceMethod string(http-method)

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

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
VoiceStatusCallbackMethod string(http-method)

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

Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
VoiceStatusCallbackUrl string(uri)

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

The URL we should when the domain receives a call.

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}$.
- api_version string | null
  
  The API version used to process the call
- auth_type string | null
  
  The types of authentication mapped to the domain
- byoc_trunk_sid string | null
  
  The SID of the BYOC Trunk resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BY[0-9a-fA-F]{32}$.
- date_created string(date-time-rfc-2822) | null
  
  The RFC 2822 date and time in GMT that the resource was created
- date_updated string(date-time-rfc-2822) | null
  
  The RFC 2822 date and time in GMT that the resource was last updated
- domain_name string | null
  
  The unique address on Twilio to route SIP traffic
- emergency_caller_sid string | null
  
  Whether an emergency caller sid is configured for the domain.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[0-9a-fA-F]{32}$.
- emergency_calling_enabled boolean | null
  
  Whether emergency calling is enabled for the domain.
- friendly_name string | null
  
  The string that you assigned to describe the resource
- secure boolean | null
  
  Whether secure SIP is enabled for the domain
- sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SD[0-9a-fA-F]{32}$.
- sip_registration boolean | null
  
  Whether SIP registration is allowed
- subresource_uris object(uri-map) | null
  
  A list mapping resources associated with the SIP Domain resource
- uri string(uri) | null
  
  The URI of the resource, relative to https://api.twilio.com
- 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_status_callback_method string(http-method) | null
  
  The HTTP method we use to call voice_status_callback_url
  
  Values are HEAD, GET, POST, PATCH, PUT, or DELETE.
- voice_status_callback_url string(uri) | null
  
  The URL that we call with status updates
- voice_url string(uri) | null
  
  The URL we call when receiving a call

POST /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json

curl \
 -X POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'ByocTrunkSid=string&DomainName=string&EmergencyCallerSid=string&EmergencyCallingEnabled=true&FriendlyName=string&Secure=true&SipRegistration=true&VoiceFallbackMethod=HEAD&VoiceFallbackUrl=https%3A%2F%2Fexample.com&VoiceMethod=HEAD&VoiceStatusCallbackMethod=HEAD&VoiceStatusCallbackUrl=https%3A%2F%2Fexample.com&VoiceUrl=https%3A%2F%2Fexample.com'

Request example

{
  "ByocTrunkSid": "string",
  "DomainName": "string",
  "EmergencyCallerSid": "string",
  "EmergencyCallingEnabled": true,
  "FriendlyName": "string",
  "Secure": true,
  "SipRegistration": true,
  "VoiceFallbackMethod": "HEAD",
  "VoiceFallbackUrl": "https://example.com",
  "VoiceMethod": "HEAD",
  "VoiceStatusCallbackMethod": "HEAD",
  "VoiceStatusCallbackUrl": "https://example.com",
  "VoiceUrl": "https://example.com"
}

Request examples

{
  "ByocTrunkSid": "string",
  "DomainName": "string",
  "EmergencyCallerSid": "string",
  "EmergencyCallingEnabled": true,
  "FriendlyName": "string",
  "Secure": true,
  "SipRegistration": true,
  "VoiceFallbackMethod": "HEAD",
  "VoiceFallbackUrl": "https://example.com",
  "VoiceMethod": "HEAD",
  "VoiceStatusCallbackMethod": "HEAD",
  "VoiceStatusCallbackUrl": "https://example.com",
  "VoiceUrl": "https://example.com"
}

Response examples (201)

{
  "account_sid": "string",
  "api_version": "string",
  "auth_type": "string",
  "byoc_trunk_sid": "string",
  "date_created": "string",
  "date_updated": "string",
  "domain_name": "string",
  "emergency_caller_sid": "string",
  "emergency_calling_enabled": true,
  "friendly_name": "string",
  "secure": true,
  "sid": "string",
  "sip_registration": true,
  "subresource_uris": {},
  "uri": "https://example.com",
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_status_callback_method": "HEAD",
  "voice_status_callback_url": "https://example.com",
  "voice_url": "https://example.com"
}

Response examples (201)

{
  "account_sid": "string",
  "api_version": "string",
  "auth_type": "string",
  "byoc_trunk_sid": "string",
  "date_created": "string",
  "date_updated": "string",
  "domain_name": "string",
  "emergency_caller_sid": "string",
  "emergency_calling_enabled": true,
  "friendly_name": "string",
  "secure": true,
  "sid": "string",
  "sip_registration": true,
  "subresource_uris": {},
  "uri": "https://example.com",
  "voice_fallback_method": "HEAD",
  "voice_fallback_url": "https://example.com",
  "voice_method": "HEAD",
  "voice_status_callback_method": "HEAD",
  "voice_status_callback_url": "https://example.com",
  "voice_url": "https://example.com"
}