Twilio. Schemas. IncomingPhoneNumber
(twilio v0.2.0)
Copy Markdown
Fields
account_sid- The SID of the Account that created this IncomingPhoneNumber resource.address_requirementsaddress_sid- The SID of the Address resource associated with the phone number.api_version- The API version used to start a new TwiML session.beta- Whether the phone number is new to the Twilio platform. Can be:trueorfalse.bundle_sid- The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.capabilities- The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities areVoice,SMS, andMMSand each capability can be:trueorfalse.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 this phone number.emergency_address_statusemergency_statusfriendly_name- The string that you assigned to describe the resource.identity_sid- The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.origin- The phone number's origin.twilioidentifies Twilio-owned phone numbers andhostedidentifies hosted phone numbers.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 this IncomingPhoneNumber resource.sms_application_sid- The SID of the application that handles SMS messages sent to the phone number. If ansms_application_sidis present, we ignore allsms_*_urlvalues and use those of the application.sms_fallback_method- The HTTP method we use to callsms_fallback_url. Can be:GETorPOST.sms_fallback_url- The URL that we call when an error occurs while retrieving or executing the TwiML fromsms_url.sms_method- The HTTP method we use to callsms_url. Can be:GETorPOST.sms_url- The URL we call when the phone number receives an incoming SMS message.statusstatus_callback- The URL we call using thestatus_callback_methodto send status information to your application.status_callback_method- The HTTP method we use to callstatus_callback. Can be:GETorPOST.trunk_sid- The SID of the Trunk that handles calls to the phone number. If atrunk_sidis present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting atrunk_sidwill automatically delete yourvoice_application_sidand vice versa.type- The phone number type.uri- The URI of the resource, relative tohttps://api.twilio.com.voice_application_sid- The SID of the application that handles calls to the phone number. If avoice_application_sidis present, we ignore all of the voice urls and use those set on the application. Setting avoice_application_sidwill automatically delete yourtrunk_sidand vice versa.voice_caller_id_lookup- Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be:trueorfalse.voice_fallback_method- The HTTP method we use to callvoice_fallback_url. Can be:GETorPOST.voice_fallback_url- The URL that we call when an error occurs retrieving or executing the TwiML requested byurl.voice_method- The HTTP method we use to callvoice_url. Can be:GETorPOST.voice_receive_modevoice_url- The URL we call when the phone number receives a call. Thevoice_urlwill not be used if avoice_application_sidor atrunk_sidis set.
Summary
Functions
Decodes parsed JSON into this struct.
Types
@type t() :: %Twilio.Schemas.IncomingPhoneNumber{ __extra__: %{optional(String.t()) => term()}, __present__: [atom()], account_sid: String.t() | nil, address_requirements: Twilio.Schemas.IncomingPhoneNumberEnumAddressRequirement.t() | nil, address_sid: String.t() | nil, api_version: String.t() | nil, beta: boolean() | nil, bundle_sid: String.t() | nil, capabilities: Twilio.Schemas.IncomingPhoneNumber.Capabilities.t() | nil, date_created: String.t() | nil, date_updated: String.t() | nil, emergency_address_sid: String.t() | nil, emergency_address_status: Twilio.Schemas.IncomingPhoneNumberEnumEmergencyAddressStatus.t() | nil, emergency_status: Twilio.Schemas.IncomingPhoneNumberEnumEmergencyStatus.t() | nil, friendly_name: String.t() | nil, identity_sid: String.t() | nil, origin: 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: String.t() | nil, status_callback: String.t() | nil, status_callback_method: String.t() | nil, trunk_sid: String.t() | nil, type: 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_receive_mode: Twilio.Schemas.IncomingPhoneNumberEnumVoiceReceiveMode.t() | nil, voice_url: String.t() | nil }