Fetch an instance of a Domain

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

Custom DNS hostnames that can accept SIP traffic

Fetch an instance of a Domain

Path parameters

  • AccountSid string Required

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

  • Sid string Required

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

Responses

  • OK

    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

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

    • 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

GET /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json
curl \
 -X GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json \
 --user "username:password"
Response examples (200)
{
  "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 (200)
{
  "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"
}