Twilio.Schemas.DependentPhoneNumber (twilio v0.2.0)

Copy Markdown

Fields

  • account_sid - The SID of the Account that created the DependentPhoneNumber resource.
  • address_requirements
  • api_version - The API version used to start a new TwiML session.
  • capabilities - The set of Boolean properties that indicates whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.
  • 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.
  • emergency_address_sid - The SID of the emergency address configuration that we use for emergency calling from the phone number.
  • emergency_status
  • friendly_name - The string that you assigned to describe the resource.
  • phone_number - The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.
  • sid - The unique string that that we created to identify the DependentPhoneNumber resource.
  • sms_application_sid - The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all sms_*_url values and use those of the application.
  • sms_fallback_method - The HTTP method we use to call sms_fallback_url. Can be: GET or POST.
  • sms_fallback_url - The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url.
  • sms_method - The HTTP method we use to call sms_url. Can be: GET or POST.
  • sms_url - The URL we call when the phone number receives an incoming SMS message.
  • status_callback - The URL we call using the status_callback_method to send status information to your application.
  • status_callback_method - The HTTP method we use to call status_callback. Can be: GET or POST.
  • trunk_sid - The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.
  • uri - The URI of the resource, relative to https://api.twilio.com.
  • voice_application_sid - The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.
  • voice_caller_id_lookup - Whether we look up the caller's caller-ID name from the CNAM database. Can be: true or false. Caller ID lookups can cost $0.01 each.
  • 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 retrieving or executing the TwiML requested by url.
  • voice_method - The HTTP method we use to call voice_url. Can be: GET or POST.
  • voice_url - The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.

Summary

Functions

Decodes parsed JSON into this struct.

Types

t()

@type t() :: %Twilio.Schemas.DependentPhoneNumber{
  __extra__: %{optional(String.t()) => term()},
  __present__: [atom()],
  account_sid: String.t() | nil,
  address_requirements:
    Twilio.Schemas.DependentPhoneNumberEnumAddressRequirement.t() | nil,
  api_version: String.t() | nil,
  capabilities: term() | nil,
  date_created: String.t() | nil,
  date_updated: String.t() | nil,
  emergency_address_sid: String.t() | nil,
  emergency_status:
    Twilio.Schemas.DependentPhoneNumberEnumEmergencyStatus.t() | nil,
  friendly_name: String.t() | nil,
  phone_number: String.t() | nil,
  sid: String.t() | nil,
  sms_application_sid: String.t() | nil,
  sms_fallback_method: String.t() | nil,
  sms_fallback_url: String.t() | nil,
  sms_method: String.t() | nil,
  sms_url: String.t() | nil,
  status_callback: String.t() | nil,
  status_callback_method: String.t() | nil,
  trunk_sid: String.t() | nil,
  uri: String.t() | nil,
  voice_application_sid: String.t() | nil,
  voice_caller_id_lookup: boolean() | nil,
  voice_fallback_method: String.t() | nil,
  voice_fallback_url: String.t() | nil,
  voice_method: String.t() | nil,
  voice_url: String.t() | nil
}

Functions

decode(json)

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

Decodes parsed JSON into this struct.