Twilio.Schemas.SipDomain (twilio v0.2.0)

Copy Markdown

Fields

  • account_sid - The SID of the Account that created the SipDomain resource.
  • api_version - The API version used to process the call.
  • auth_type - 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.
  • byoc_trunk_sid - The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
  • date_created - The date and time in GMT that the resource was created specified in RFC 2822 format.
  • date_updated - The date and time in GMT that the resource was last updated specified in RFC 2822 format.
  • domain_name - 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.
  • emergency_caller_sid - 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.
  • emergency_calling_enabled - Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
  • friendly_name - The string that you assigned to describe the resource.
  • secure - 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.
  • sid - The unique string that that we created to identify the SipDomain resource.
  • sip_registration - Whether to allow SIP Endpoints to register with the domain to receive calls.
  • subresource_uris - A list of mapping resources associated with the SIP Domain resource identified by their relative URIs.
  • uri - The URI of the resource, relative to https://api.twilio.com.
  • voice_fallback_method - The HTTP method we use to call voice_fallback_url. Can be: GET or POST.
  • voice_fallback_url - The URL that we call when an error occurs while retrieving or executing the TwiML requested from voice_url.
  • voice_method - The HTTP method we use to call voice_url. Can be: GET or POST.
  • voice_status_callback_method - The HTTP method we use to call voice_status_callback_url. Either GET or POST.
  • voice_status_callback_url - The URL that we call to pass status parameters (such as call ended) to your application.
  • voice_url - The URL we call using the voice_method when the domain receives a call.

Summary

Types

t()

Functions

decode(json)

Decodes parsed JSON into this struct.

Types

t()

@type t() :: %Twilio.Schemas.SipDomain{
  __extra__: %{optional(String.t()) => term()},
  __present__: [atom()],
  account_sid: String.t() | nil,
  api_version: String.t() | nil,
  auth_type: String.t() | nil,
  byoc_trunk_sid: String.t() | nil,
  date_created: String.t() | nil,
  date_updated: String.t() | nil,
  domain_name: String.t() | nil,
  emergency_caller_sid: String.t() | nil,
  emergency_calling_enabled: boolean() | nil,
  friendly_name: String.t() | nil,
  secure: boolean() | nil,
  sid: String.t() | nil,
  sip_registration: boolean() | nil,
  subresource_uris: map() | nil,
  uri: String.t() | nil,
  voice_fallback_method: String.t() | nil,
  voice_fallback_url: String.t() | nil,
  voice_method: String.t() | nil,
  voice_status_callback_method: String.t() | nil,
  voice_status_callback_url: String.t() | nil,
  voice_url: String.t() | nil
}

Functions

decode(json)

@spec decode(term()) :: t() | term()

Decodes parsed JSON into this struct.