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 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.
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.
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.
The SID of the Account that created this IncomingPhoneNumber resource.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Address resource associated with the phone number.
^AD[0-9a-fA-F]{32}$Min length: 34Max length: 34Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.
noneanylocalforeignThe set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.
The date and time in GMT that the resource was created specified in RFC 2822 format.
The date and time in GMT that the resource was last updated specified in RFC 2822 format.
The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.
^RI[0-9a-fA-F]{32}$Min length: 34Max length: 34The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.
The phone number's origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers.
The unique string that that we created to identify this IncomingPhoneNumber resource.
^PN[0-9a-fA-F]{32}$Min length: 34Max length: 34The 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.
^AP[0-9a-fA-F]{32}$Min length: 34Max length: 34The HTTP method we use to call sms_fallback_url. Can be: GET or POST.
GETPOSTThe URL that we call when an error occurs while retrieving or executing the TwiML from sms_url.
The HTTP method we use to call sms_url. Can be: GET or POST.
GETPOSTThe URL we call using the status_callback_method to send status information to your application.
The HTTP method we use to call status_callback. Can be: GET or POST.
GETPOSTThe 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.
^TK[0-9a-fA-F]{32}$Min length: 34Max length: 34The 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.
^AP[0-9a-fA-F]{32}$Min length: 34Max length: 34Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.
The HTTP method we use to call voice_fallback_url. Can be: GET or POST.
GETPOSTThe URL that we call when an error occurs retrieving or executing the TwiML requested by url.
The HTTP method we use to call voice_url. Can be: GET or POST.
GETPOSTThe 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.
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.
ActiveInactiveThe SID of the emergency address configuration that we use for emergency calling from this phone number.
^AD[0-9a-fA-F]{32}$Min length: 34Max length: 34The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.
registeredunregisteredpending-registrationregistration-failurepending-unregistrationunregistration-failureThe SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.jsonThe API version to use for incoming calls made to the new phone number. The default is 2010-04-01.
A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number.
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 set on the application.
^AP[0-9a-fA-F]{32}$Min length: 34Max length: 34The HTTP method that we should use to call sms_fallback_url. Can be: GET or POST and defaults to POST.
GETPOSTThe URL that we should call when an error occurs while requesting or executing the TwiML defined by sms_url.
The HTTP method that we should use to call sms_url. Can be: GET or POST and defaults to POST.
GETPOSTThe URL we should call when the new phone number receives an incoming SMS message.
The URL we should call using the status_callback_method to send status information to your application.
The HTTP method we should use to call status_callback. Can be: GET or POST and defaults to POST.
GETPOSTThe 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.
^AP[0-9a-fA-F]{32}$Min length: 34Max length: 34Whether 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.
The HTTP method that we should use to call voice_fallback_url. Can be: GET or POST and defaults to POST.
GETPOSTThe URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
The HTTP method that we should use to call voice_url. Can be: GET or POST and defaults to POST.
GETPOSTThe 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.
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.
ActiveInactiveThe SID of the emergency address configuration to use for emergency calling from the new phone number.
^AD[0-9a-fA-F]{32}$Min length: 34Max length: 34The 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.
^TK[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.
^RI[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
^AD[0-9a-fA-F]{32}$Min length: 34Max length: 34The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: fax or voice and defaults to voice.
voicefaxThe SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34The 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.
The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. You must provide an area_code or a phone_number. (US and Canada only).
You will be charged when you provision the number, and the number will appear on the Numbers page in the console.
Provide an AddressSid and a BundleSid for your new IncomingPhoneNumber
Twilio will send a HTTP request to this URL when a call comes in to your phone number
Twilio will send a HTTP request to this URL when an SMS is sent to your phone number
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.jsonThe SID of the Account that created the IncomingPhoneNumber resource to fetch.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to fetch.
^PN[0-9a-fA-F]{32}$Min length: 34Max length: 34GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.jsonWhether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true.
A string that identifies the IncomingPhoneNumber resources to read.
The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included.
How many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
Return the set of phone numbers that match exactly (415) 867-5310
Return the set of all phone numbers containing the digits 867
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.jsonThe SID of the Account that created the IncomingPhoneNumber resource to update. For more information, see Exchanging Numbers Between Subaccounts.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to update.
^PN[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Account that created the IncomingPhoneNumber resource to update. For more information, see Exchanging Numbers Between Subaccounts.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The API version to use for incoming calls made to the phone number. The default is 2010-04-01.
A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.
The SID of the application that should handle SMS messages sent to the number. If an sms_application_sid is present, we ignore all of the sms_*_url urls and use those set on the application.
^AP[0-9a-fA-F]{32}$Min length: 34Max length: 34The HTTP method that we should use to call sms_fallback_url. Can be: GET or POST and defaults to POST.
GETPOSTThe URL that we should call when an error occurs while requesting or executing the TwiML defined by sms_url.
The HTTP method that we should use to call sms_url. Can be: GET or POST and defaults to POST.
GETPOSTThe URL we should call when the phone number receives an incoming SMS message.
The URL we should call using the status_callback_method to send status information to your application.
The HTTP method we should use to call status_callback. Can be: GET or POST and defaults to POST.
GETPOSTThe SID of the application we should use to handle phone calls to the 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.
^AP[0-9a-fA-F]{32}$Min length: 34Max length: 34Whether 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.
The HTTP method that we should use to call voice_fallback_url. Can be: GET or POST and defaults to POST.
GETPOSTThe URL that we should call when an error occurs retrieving or executing the TwiML requested by url.
The HTTP method that we should use to call voice_url. Can be: GET or POST and defaults to POST.
GETPOSTThe URL that we should call to answer a call to the phone number. The voice_url will not be called if a voice_application_sid or a trunk_sid is set.
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.
ActiveInactiveThe SID of the emergency address configuration to use for emergency calling from this phone number.
^AD[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Trunk we should use to handle phone calls to the 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.
^TK[0-9a-fA-F]{32}$Min length: 34Max length: 34The configuration parameter for the phone number to receive incoming voice calls or faxes. Can be: fax or voice and defaults to voice.
voicefaxThe SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.
^RI[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.
^AD[0-9a-fA-F]{32}$Min length: 34Max length: 34The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
^BU[0-9a-fA-F]{32}$Min length: 34Max length: 34Twilio will send a HTTP request to this URL when a call is received by your phone number
Twilio will send a HTTP request to this URL when an SMS is sent to your phone number
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.jsonRelease this phone number from your account. Twilio will no longer answer calls to this number, and you will stop being billed the monthly phone number fee. The phone number will eventually be recycled and potentially given to another customer, so use with care. If you make a mistake, contact us. We may be able to give you the number back.
The SID of the Account that created the IncomingPhoneNumber resources to delete.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to delete.
^PN[0-9a-fA-F]{32}$Min length: 34Max length: 34