Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

SIP Domain Resource

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.

SIP Domain Authentication

Your SIP Domain must map at least one of these two authentication methods or requests to it will be blocked.

SipDomain properties

Names in PHP format
accountSid
sid<AC> Not PII

The SID of the Account that created the SipDomain resource.

apiVersion
string Not PII

The API version used to process the call.

authType
string Not PII

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

dateCreated
date_time<rfc2822> Not PII

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

dateUpdated
date_time<rfc2822> Not PII

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

domainName
string Not PII

The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and "-".

friendlyName
string Not PII

The string that you assigned to describe the resource.

sid
sid<SD> Not PII

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

uri
uri Not PII

The URI of the resource, relative to https://api.twilio.com.

voiceFallbackMethod
http_method Not PII

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

voiceFallbackUrl

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

voiceMethod
http_method Not PII

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

voiceStatusCallbackMethod
http_method Not PII

The HTTP method we use to call voice_status_callback_url. Either GET or POST.

voiceStatusCallbackUrl

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

voiceUrl

The URL we call using the voice_method when the domain receives a call.

subresourceUris
uri_map Not PII

A list of mapping resources associated with the SIP Domain resource identified by their relative URIs.

sipRegistration
boolean Not PII

Whether to allow SIP Endpoints to register with the domain to receive calls.

Create a SipDomain resource

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json
Parameters
Names in None format
domain_name
Required
post string Not PII

The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and "-".

friendly_name
Optional
post string Not PII

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

voice_url
Optional
post url PII MTL: 30 DAYS

The URL we should when the domain receives a call.

voice_method
Optional
post http_method Not PII

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

voice_fallback_url
Optional
post url PII MTL: 30 DAYS

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

voice_fallback_method
Optional
post http_method Not PII

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

voice_status_callback_url
Optional
post url PII MTL: 30 DAYS

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

voice_status_callback_method
Optional
post http_method Not PII

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

sip_registration
Optional
post boolean Not PII

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.

account_sid
Required
post sid<AC> Not PII

The SID of the Account that will create the resource.

Example 1
        
        
        
        

        Fetch a SipDomain resource

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json
        Parameters
        Names in None format
        account_sid
        Required
        get sid<AC> Not PII

        The SID of the Account that created the SipDomain resource to fetch.

        sid
        Required
        get sid<SD> Not PII

        The Twilio-provided string that uniquely identifies the SipDomain resource to fetch.

        Example 1
              
              
              
              

              Read multiple SipDomain resources

              get
              https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains.json
              Parameters
              Names in None format
              account_sid
              Required
              get sid<AC> Not PII

              The SID of the Account that created the SipDomain resources to read.

              Example 1
                    
                    
                    
                    

                    Update a SipDomain resource

                    post
                    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json
                    Parameters
                    Names in None format
                    account_sid
                    Required
                    post sid<AC> Not PII

                    The SID of the Account that created the SipDomain resource to update.

                    sid
                    Required
                    post sid<SD> Not PII

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

                    friendly_name
                    Optional
                    post string Not PII

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

                    voice_fallback_method
                    Optional
                    post http_method Not PII

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

                    voice_fallback_url
                    Optional
                    post url PII MTL: 30 DAYS

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

                    voice_method
                    Optional
                    post http_method Not PII

                    The HTTP method we should use to call voice_url

                    voice_status_callback_method
                    Optional
                    post http_method Not PII

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

                    voice_status_callback_url
                    Optional
                    post url PII MTL: 30 DAYS

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

                    voice_url
                    Optional
                    post url PII MTL: 30 DAYS

                    The URL we should call when the domain receives a call.

                    sip_registration
                    Optional
                    post boolean Not PII

                    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.

                    domain_name
                    Optional
                    post string Not PII

                    The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and "-".

                    Example 1
                          
                          
                          
                          

                          Delete a SipDomain resource

                          delete
                          https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json
                          Parameters
                          Names in None format
                          account_sid
                          Required
                          delete sid<AC> Not PII

                          The SID of the Account that created the SipDomain resources to delete.

                          sid
                          Required
                          delete sid<SD> Not PII

                          The Twilio-provided string that uniquely identifies the SipDomain resource to delete.

                          Example 1
                                
                                
                                
                                
                                Rate this page:

                                Need some help?

                                We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.