Path parameters

• AccountSid string Required

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

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

Query parameters

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • domains array[object]
    Hide domains attributes Show domains attributes object

    • account_sid string | null

      The SID of the Account that created the SipDomain 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 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 string(date-time-rfc-2822) | null

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

    • date_updated string(date-time-rfc-2822) | null

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

    • domain_name string | null

      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_name string | null

      The string that you assigned to describe the resource.

    • sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SD[0-9a-fA-F]{32}$.

    • uri string | null

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

    • voice_fallback_method string(http-method) | null

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

      Values are GET or POST.

    • voice_fallback_url string(uri) | null

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

    • voice_method string(http-method) | null

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

      Values are GET or POST.

    • voice_status_callback_method string(http-method) | null

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

      Values are GET or POST.

    • voice_status_callback_url string(uri) | null

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

    • voice_url string(uri) | null

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

    • subresource_uris object(uri-map) | null

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

    • sip_registration boolean | null

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

    • emergency_calling_enabled boolean | null

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

    • secure boolean | null

      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_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BY[0-9a-fA-F]{32}$.

    • emergency_caller_sid string | null

      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.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[0-9a-fA-F]{32}$.

  • end integer
  • first_page_uri string(uri)
  • next_page_uri string(uri) | null
  • page integer
  • page_size integer
  • previous_page_uri string(uri) | null
  • start integer
  • uri string(uri)