Sample - Twilio API
GET/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json

Get a SIP domain

Retrieves a single SIP domain from an account. Use AccountSid and Sid to identify the owning account and domain resource. The response includes the domain's authentication, voice, registration, and security configuration.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
AccountSidstringrequired
The 34-character SID of the account that owns the SIP domain, beginning with `AC`.
Sidstringrequired
The 34-character SID of the SIP domain to retrieve, beginning with `SD`.

1 status code
200Returns the SIP domain with its account SID, API version, authentication type, timestamps, domain name, generated SID, voice configuration, and resource URI.
account_sidstringoptional
The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource.
api_versionstringoptional
The API version used to process the call.
auth_typestringoptional
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.
date_createdstringoptional
The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updatedstringoptional
The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
domain_namestringoptional
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`.
friendly_namestringoptional
The string that you assigned to describe the resource.
sidstringoptional
The unique string that that we created to identify the SipDomain resource.
uristringoptional
The URI of the resource, relative to `https://api.twilio.com`.
voice_fallback_methodstringoptional
The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`.
Allowed:GETPOST
voice_fallback_urlstringoptional
The URL that we call when an error occurs while retrieving or executing the TwiML requested from `voice_url`.
voice_methodstringoptional
The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.
Allowed:GETPOST
voice_status_callback_methodstringoptional
The HTTP method we use to call `voice_status_callback_url`. Either `GET` or `POST`.
Allowed:GETPOST
voice_status_callback_urlstringoptional
The URL that we call to pass status parameters (such as call ended) to your application.
voice_urlstringoptional
The URL we call using the `voice_method` when the domain receives a call.
subresource_urisobjectoptional
A list of mapping resources associated with the SIP Domain resource identified by their relative URIs.
sip_registrationbooleanoptional
Whether to allow SIP Endpoints to register with the domain to receive calls.
emergency_calling_enabledbooleanoptional
Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
securebooleanoptional
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.
byoc_trunk_sidstringoptional
The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
emergency_caller_sidstringoptional
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.

Error handling

AccountSid must be a 34-character account SID beginning with AC, and Sid must be a 34-character SIP domain SID beginning with SD. Both values must use the hexadecimal SID format defined by their schemas.