Api20100401IncomingPhoneNumberMobile
post/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json

Request

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

Path parameters

AccountSidstring required

The SID of the Account that will create the resource.

Request body application/x-www-form-urlencoded

PhoneNumberstring phone-number required

The phone number to purchase specified in E.164 format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.

ApiVersionstring

The API version to use for incoming calls made to the new phone number. The default is 2010-04-01.

FriendlyNamestring

A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number.

SmsApplicationSidstring

The SID of the application that should handle SMS messages sent to the new phone number. If an sms_application_sid is present, we ignore all of the sms_*_url urls and use those of the application.

SmsFallbackMethod'GET' | 'POST' http-method

The HTTP method that we should use to call sms_fallback_url. Can be: GET or POST and defaults to POST.

SmsFallbackUrlstring uri

The URL that we should call when an error occurs while requesting or executing the TwiML defined by sms_url.

SmsMethod'GET' | 'POST' http-method

The HTTP method that we should use to call sms_url. Can be: GET or POST and defaults to POST.

SmsUrlstring uri

The URL we should call when the new phone number receives an incoming SMS message.

StatusCallbackstring uri

The URL we should call using the status_callback_method to send status information to your application.

StatusCallbackMethod'GET' | 'POST' http-method

The HTTP method we should use to call status_callback. Can be: GET or POST and defaults to POST.

VoiceApplicationSidstring

The SID of the application we should use to handle calls to the new phone number. If a voice_application_sid is present, we ignore all of the voice urls and use only those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.

VoiceCallerIdLookupboolean

Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: true or false and defaults to false.

VoiceFallbackMethod'GET' | 'POST' http-method

The HTTP method that we should use to call voice_fallback_url. Can be: GET or POST and defaults to POST.

VoiceFallbackUrlstring uri

The URL that we should call when an error occurs retrieving or executing the TwiML requested by url.

VoiceMethod'GET' | 'POST' http-method

The HTTP method that we should use to call voice_url. Can be: GET or POST and defaults to POST.

VoiceUrlstring uri

The URL that we should call to answer a call to the new phone number. The voice_url will not be called if a voice_application_sid or a trunk_sid is set.

IdentitySidstring

The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.

AddressSidstring

The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.

EmergencyStatus'Active' | 'Inactive'

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

EmergencyAddressSidstring

The SID of the emergency address configuration to use for emergency calling from the new phone number.

TrunkSidstring

The SID of the Trunk we should use to handle calls to the new phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.

VoiceReceiveMode'voice' | 'fax'
BundleSidstring

The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.

Response

Created

account_sidstring nullable

The SID of the Account that created the resource.

address_sidstring nullable

The SID of the Address resource associated with the phone number.

address_requirements'none' | 'any' | 'local' | 'foreign'

Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.

api_versionstring nullable

The API version used to start a new TwiML session.

betaboolean nullable

Whether the phone number is new to the Twilio platform. Can be: true or false.

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.

friendly_namestring nullable

The string that you assigned to describe the resource.

identity_sidstring nullable

The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.

phone_numberstring phone-number nullable

The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

originstring nullable

The phone number's origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers.

sidstring nullable

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

sms_application_sidstring nullable

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'GET' | 'POST' http-method nullable

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

sms_fallback_urlstring uri nullable

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

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

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

sms_urlstring uri nullable

The URL we call when the phone number receives an incoming SMS message.

status_callbackstring uri nullable

The URL we call using the status_callback_method to send status information to your application.

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

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

trunk_sidstring nullable

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.

uristring nullable

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

voice_receive_mode'voice' | 'fax'
voice_application_sidstring nullable

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

Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.

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 retrieving or executing the TwiML requested by url.

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

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

voice_urlstring uri nullable

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.

emergency_status'Active' | 'Inactive'

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

emergency_address_sidstring nullable

The SID of the emergency address configuration that we use for emergency calling from this phone number.

emergency_address_status'registered' | 'unregistered' | 'pending-registration' | 'registration-failure' | 'pending-unregistration' | 'unregistration-failure'

The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.

bundle_sidstring nullable

The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.

statusstring nullable

Changes

    • info

      api tag Api20100401IncomingPhoneNumberMobile added

    • info

      api tag Api20100401Mobile removed

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property

    • 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 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 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 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

    • 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