TWtwilio
Api20100401Domain

Fetch an instance of a Domain

Changed on

Fetch an instance of a Domain

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

Request

  • Base URL
    https://api.twilio.com
  • URL
    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json
  • Auth
    HTTP basic

Path parameters

AccountSidstring required

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

Sidstring required

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

Response

OK

account_sidstring nullable

The SID of the Account that created the SipDomain resource.

api_versionstring nullable

The API version used to process the call.

auth_typestring nullable

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_createdstring date-time-rfc-2822 nullable

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

date_updatedstring date-time-rfc-2822 nullable

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

domain_namestring nullable

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_namestring nullable

The string that you assigned to describe the resource.

sidstring nullable

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

uristring nullable

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

voice_fallback_method'GET' | 'POST' http-method nullable

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

voice_fallback_urlstring uri nullable

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

voice_method'GET' | 'POST' http-method nullable

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

voice_status_callback_method'GET' | 'POST' http-method nullable

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

voice_status_callback_urlstring uri nullable

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

voice_urlstring uri nullable

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

subresource_urisobject nullable

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

sip_registrationboolean nullable

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

emergency_calling_enabledboolean nullable

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

secureboolean nullable

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_sidstring nullable

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

emergency_caller_sidstring nullable

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.

Changes

  • v2010cf63f47f41aaRevision changes
    • info

      removed the DELETE enum value from the response property for the response status

    • info

      removed the DELETE enum value from the response property for the response status

    • info

      removed the DELETE enum value from the response property for the response status

    • info

      removed the HEAD enum value from the response property for the response status

    • info

      removed the HEAD enum value from the response property for the response status

    • info

      removed the HEAD enum value from the response property for the response status

    • info

      removed the PATCH enum value from the response property for the response status

    • info

      removed the PATCH enum value from the response property for the response status

    • info

      removed the PATCH enum value from the response property for the response status

    • info

      removed the PUT enum value from the response property for the response status

    • info

      removed the PUT enum value from the response property for the response status

    • info

      removed the PUT enum value from the response property for the response status