The AvailablePhoneNumberTollFree
resource lets you search for toll-free phone numbers that are available for you to purchase. You can search for phone numbers that match a pattern, are in a certain country, are in certain area code (NPA) or exchange (NXX) or are in a specific geography.
Once you've found an available number you want to purchase, make an HTTP POST
request to the IncomingPhoneNumbers list resource passing the number as the 'PhoneNumber' parameter.
We work hard to keep a wide variety of numbers in stock at all times. See our pricing pages for country availability.
The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.
The LATA of this phone number. Available for only phone numbers from the US and Canada.
The rate center of this phone number. Available for only phone numbers from the US and Canada.
The latitude of this phone number's location. Available for only phone numbers from the US and Canada.
The longitude of this phone number's location. Available for only phone numbers from the US and Canada.
The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada.
The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada.
The type of Address resource the phone number requires. Can be: none
, any
, local
, or foreign
. none
means no address is required. any
means an address is required, but it can be anywhere in the world. local
means an address in the phone number's country is required. foreign
means an address outside of the phone number's country is required.
Whether the phone number is new to the Twilio platform. Can be: true
or false
.
The 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
.
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json
The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.
The pattern on which to match phone numbers. Valid characters are *
, 0-9
, a-z
, and A-Z
. The *
character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.
Whether the phone numbers can receive text messages. Can be: true
or false
.
Whether the phone numbers can receive MMS messages. Can be: true
or false
.
Whether the phone numbers can receive calls. Can be: true
or false
.
Whether to exclude phone numbers that require an Address. Can be: true
or false
and the default is false
.
Whether to exclude phone numbers that require a local Address. Can be: true
or false
and the default is false
.
Whether to exclude phone numbers that require a foreign Address. Can be: true
or false
and the default is false
.
Whether to read phone numbers that are new to the Twilio platform. Can be: true
or false
and the default is true
.
Given a phone number, find a geographically close number within distance
miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.
Given a latitude/longitude pair lat,long
find geographically close numbers within distance
miles. Applies to only phone numbers in the US and Canada.
The search radius, in miles, for a near_
query. Can be up to 500
and the default is 25
. Applies to only phone numbers in the US and Canada.
Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.
Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.
Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata
to be set as well. Applies to only phone numbers in the US and Canada.
Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.
Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.
Whether the phone numbers can receive faxes. Can be: true
or false
.
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Find toll-free phone numbers that start with 866, followed by any three digits, then the string EPIC.
Find toll-free phone numbers in the 800 area code that contain the pattern 'KYLO'