IncomingPhoneNumber resource

An IncomingPhoneNumber instance resource represents a Twilio phone number provisioned from Twilio, ported or hosted to Twilio.

The IncomingPhoneNumbers list resource represents an account's Twilio phone numbers. You can POST to the list of resource to provision a new Twilio number. To find a new number to provision use the subresources of the AvailablePhoneNumbers resource.

You can transfer phone numbers between two Twilio accounts if you're using subaccounts. For details, see Exchanging Numbers Between Subaccounts.

ℹ️

Info

Provisioning a phone number is a two-step process. First, you must find an available phone number to provision using the subresources of the AvailablePhoneNumbers resource. Second, you must POST to the IncomingPhoneNumbers list resource, documented below.

⚠️

Important note

The order of the columns in the CSV is not defined and may change when new fields are added to the API response. Your application design should be resilient to changes in the order of the columns in the CSV response.

Response Definition

Response Item	Data Type	Description
account_sid	string	The unique identifier of the account responsible for the phone number.
address_sid	string	The unique identifier for the address associated with this phone number, if applicable. Pattern: ^AD[0-9a-fA-F]{32}$ Min length: 34 Max length: 34
address_requirements	string	Specifies the level of address requirements needed for the phone number. Can be: none, any, local, or oreign. Possible values: none any local foreign
api_version	string	The API version used when receiving calls to the phone number.
beta	boolean	Indicates if the phone number is in a beta program. Can be: true or false.
capabilities	object<phone-number-capabilities>	An object that specifies whether the phone number can receive calls, messages, and faxes. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.
date_created	string<date-time-rfc-2822>	The date and time when the phone number was created in RFC 2822
date_updated	string<date-time-rfc-2822>	The date and time when the phone number was last updated in RFC 2822
emergency_address_sid	string	The unique identifier for the emergency address associated with the phone number, if applicable.
emergency_status	string	Indicates if emergency calling has been enabled for this number.
friendly_name	string	A human-readable description for the phone number.
identity_sid	string	The unique identifier for the identity associated with the phone number, if applicable. Pattern: ^RI[0-9a-fA-F]{32}$ Min length: 34 Max length: 34
phone_number	string	The phone number in E.164 format.
sid	string	The unique string that that we created to identify this IncomingPhoneNumber resource. Pattern: ^PN[0-9a-fA-F]{32}$ Min length: 34 Max length: 34
sms_application_sid	string	The unique identifier of the application responsible for SMS messages to this number.
sms_fallback_method	string	The HTTP method used with the sms_fallback_url.
sms_fallback_url	string	The URL used to handle SMS failures.
sms_method	string	The HTTP method used with the sms_url.
sms_url	string	The URL used to handle incoming SMS messages.
status_callback	string	The URL used to send status callbacks for this phone number.
status_callback_method	string	The HTTP method used with the status_callback.
trunk_sid	string	The unique identifier for the trunk associated with the phone number, if applicable.
uri	string	The URI for this resource.
voice_application_sid	string	The unique identifier of the application responsible for voice calls to this number.
voice_caller_id_lookup	boolean	Indicates if caller ID lookup is enabled for this number.
voice_fallback_method	string	The HTTP method used with the voice_fallback_url.
voice_fallback_url	string	The URL used to handle call failures.
voice_method	string	The HTTP method used with the voice_url.
voice_url	string	The URL used to handle incoming voice calls.