A SIP Domain resource describes a custom DNS hostname that can accept SIP traffic for your account. A SIP request to that domain, such as to sip:alice@example.sip.twilio.com
, routes to Twilio. Twilio authenticates the request and requests TwiML from the voice_url
of the SIP Domain.
Your SIP Domain must map at least one of these two authentication methods or requests to it will be blocked.
account_sid
type: SID<AC>The SID of the Account that created the SipDomain resource.
^AC[0-9a-fA-F]{32}$
34
34
auth_type
type: stringThe types of authentication you have mapped to your domain. Can be: IP_ACL
and CREDENTIAL_LIST
. If you have both defined for your domain, both will be returned in a comma delimited string. If auth_type
is not defined, the domain will not be able to receive any traffic.
date_created
type: string<date-time-rfc-2822>The date and time in GMT that the resource was created specified in RFC 2822 format.
date_updated
type: string<date-time-rfc-2822>The date and time in GMT that the resource was last updated specified in RFC 2822 format.
domain_name
type: stringThe 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
.
sid
type: SID<SD>The unique string that that we created to identify the SipDomain resource.
^SD[0-9a-fA-F]{32}$
34
34
voice_fallback_method
type: enum<http-method>The HTTP method we use to call voice_fallback_url
. Can be: GET
or POST
.
GET
POST
voice_fallback_url
type: string<uri>The URL that we call when an error occurs while retrieving or executing the TwiML requested from voice_url
.
voice_method
type: enum<http-method>The HTTP method we use to call voice_url
. Can be: GET
or POST
.
GET
POST
voice_status_callback_method
type: enum<http-method>The HTTP method we use to call voice_status_callback_url
. Either GET
or POST
.
GET
POST
voice_status_callback_url
type: string<uri>The URL that we call to pass status parameters (such as call ended) to your application.
voice_url
type: string<uri>The URL we call using the voice_method
when the domain receives a call.
subresource_uris
type: object<uri-map>A list of mapping resources associated with the SIP Domain resource identified by their relative URIs.
sip_registration
type: booleanWhether to allow SIP Endpoints to register with the domain to receive calls.
emergency_calling_enabled
type: booleanWhether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
secure
type: booleanWhether 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.
byoc_trunk_sid
type: SID<BY>The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
^BY[0-9a-fA-F]{32}$
34
34
emergency_caller_sid
type: SID<PN>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.
^PN[0-9a-fA-F]{32}$
34
34
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json
AccountSid
type: SID<AC>The SID of the Account that will create the resource.
^AC[0-9a-fA-F]{32}$
34
34
DomainName
type: stringRequiredThe 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
.
FriendlyName
type: stringA descriptive string that you created to describe the resource. It can be up to 64 characters long.
VoiceMethod
type: enum<http-method>The HTTP method we should use to call voice_url
. Can be: GET
or POST
.
GET
POST
VoiceFallbackUrl
type: string<uri>The URL that we should call when an error occurs while retrieving or executing the TwiML from voice_url
.
VoiceFallbackMethod
type: enum<http-method>The HTTP method we should use to call voice_fallback_url
. Can be: GET
or POST
.
GET
POST
VoiceStatusCallbackUrl
type: string<uri>The URL that we should call to pass status parameters (such as call ended) to your application.
VoiceStatusCallbackMethod
type: enum<http-method>The HTTP method we should use to call voice_status_callback_url
. Can be: GET
or POST
.
GET
POST
SipRegistration
type: booleanWhether 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.
EmergencyCallingEnabled
type: booleanWhether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
Secure
type: booleanWhether 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.
ByocTrunkSid
type: SID<BY>The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
^BY[0-9a-fA-F]{32}$
34
34
EmergencyCallerSid
type: SID<PN>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.
^PN[0-9a-fA-F]{32}$
34
34
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json
AccountSid
type: SID<AC>The SID of the Account that created the SipDomain resource to fetch.
^AC[0-9a-fA-F]{32}$
34
34
Sid
type: SID<SD>The Twilio-provided string that uniquely identifies the SipDomain resource to fetch.
^SD[0-9a-fA-F]{32}$
34
34
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json
AccountSid
type: SID<AC>The SID of the Account that created the SipDomain resources to read.
^AC[0-9a-fA-F]{32}$
34
34
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json
AccountSid
type: SID<AC>The SID of the Account that created the SipDomain resource to update.
^AC[0-9a-fA-F]{32}$
34
34
Sid
type: SID<SD>The Twilio-provided string that uniquely identifies the SipDomain resource to update.
^SD[0-9a-fA-F]{32}$
34
34
FriendlyName
type: stringA descriptive string that you created to describe the resource. It can be up to 64 characters long.
VoiceFallbackMethod
type: enum<http-method>The HTTP method we should use to call voice_fallback_url
. Can be: GET
or POST
.
GET
POST
VoiceFallbackUrl
type: string<uri>The URL that we should call when an error occurs while retrieving or executing the TwiML requested by voice_url
.
VoiceMethod
type: enum<http-method>The HTTP method we should use to call voice_url
GET
POST
VoiceStatusCallbackMethod
type: enum<http-method>The HTTP method we should use to call voice_status_callback_url
. Can be: GET
or POST
.
GET
POST
VoiceStatusCallbackUrl
type: string<uri>The URL that we should call to pass status parameters (such as call ended) to your application.
SipRegistration
type: booleanWhether 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.
DomainName
type: stringThe 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
.
EmergencyCallingEnabled
type: booleanWhether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
Secure
type: booleanWhether 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.
ByocTrunkSid
type: SID<BY>The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
^BY[0-9a-fA-F]{32}$
34
34
EmergencyCallerSid
type: SID<PN>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.
^PN[0-9a-fA-F]{32}$
34
34
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json
AccountSid
type: SID<AC>The SID of the Account that created the SipDomain resources to delete.
^AC[0-9a-fA-F]{32}$
34
34
Sid
type: SID<SD>The Twilio-provided string that uniquely identifies the SipDomain resource to delete.
^SD[0-9a-fA-F]{32}$
34
34