Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

AvailablePhoneNumber Local resource

The AvailablePhoneNumberLocal resource lets you search for local 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.

AvailablePhoneNumberLocal properties

Names in REST API format
friendly_name
phone_number Not PII

A formatted version of the phone number.

phone_number
phone_number Not PII

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

lata
string Not PII

The LATA of this phone number. Available for only phone numbers from the US and Canada.

locality
string Not PII

The locality or city of this phone number's location.

rate_center
string Not PII

The rate center of this phone number. Available for only phone numbers from the US and Canada.

latitude
decimal Not PII

The latitude of this phone number's location. Available for only phone numbers from the US and Canada.

longitude
decimal Not PII

The longitude of this phone number's location. Available for only phone numbers from the US and Canada.

region
string Not PII

The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada.

postal_code
string Not PII

The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada.

iso_country
iso_country_code Not PII

The ISO country code of this phone number.

address_requirements
string Not PII

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.

beta
boolean Not PII

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

capabilities
phone_number_capabilities Not PII

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.

Read multiple AvailablePhoneNumberLocal resources

get
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json
Parameters
Names in None format
account_sid
Required
get sid<AC> Not PII

The SID of the Account requesting the AvailablePhoneNumber resources.

country_code
Required
get iso_country_code Not PII

The ISO-3166-1 country code of the country from which to read phone numbers.

area_code
Optional
get integer Not PII

The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

contains
Optional
get string Not PII

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.

sms_enabled
Optional
get boolean Not PII

Whether the phone numbers can receive text messages. Can be: true or false.

mms_enabled
Optional
get boolean Not PII

Whether the phone numbers can receive MMS messages. Can be: true or false.

voice_enabled
Optional
get boolean Not PII

Whether the phone numbers can receive calls. Can be: true or false.

exclude_all_address_required
Optional
get boolean Not PII

Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

exclude_local_address_required
Optional
get boolean Not PII

Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

exclude_foreign_address_required
Optional
get boolean Not PII

Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

beta
Optional
get boolean Not PII

Whether to read phone numbers that are new to the Twilio platform. Can be: true or false and the default is true.

near_number
Optional
get phone_number<e164> Not PII

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.

near_lat_long
Optional
get string Not PII

Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

distance
Optional
get integer Not PII

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.

in_postal_code
Optional
get string Not PII

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.

in_region
Optional
get string Not PII

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.

in_rate_center
Optional
get string Not PII

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.

in_lata
Optional
get string Not PII

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.

in_locality
Optional
get string Not PII

Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

fax_enabled
Optional
get boolean Not PII

Whether the phone numbers can receive faxes. Can be: true or false.

Example 1
        
        
        
        
        Find available local phone numbers in the United States in the 510 area code

        Find available local phone numbers by area code

        Find available local phone numbers in the United States in the 510 area code
        Example 2
              
              
              
              
              Find local phone numbers in the United States starting with 510555

              Find phone numbers by number pattern

              Find local phone numbers in the United States starting with 510555
              Example 3
                    
                    
                    
                    
                    Find local phone numbers that match the pattern 'STORM'

                    Find phone numbers by character pattern

                    Find local phone numbers that match the pattern 'STORM'
                    Example 4
                          
                          
                          
                          
                          Find available phone numbers in Arkansas

                          Find available phone numbers by state

                          Find available phone numbers in Arkansas
                          Example 5
                                
                                
                                
                                
                                Find a phone number in the London prefix (+4420)

                                Find available local phone numbers by prefix

                                Find a phone number in the London prefix (+4420)
                                Example 6
                                      
                                      
                                      
                                      
                                      Find a phone number in the UK which is Voice- and SMS-enabled

                                      Find regional phone numbers by feature

                                      Find a phone number in the UK which is Voice- and SMS-enabled
                                      Example 7
                                            
                                            
                                            
                                            
                                            Find available local phone numbers that have no address requirements

                                            Find phone numbers without address requirements

                                            Find available local phone numbers that have no address requirements
                                            Example 8
                                                  
                                                  
                                                  
                                                  
                                                  These features are limited to US and Canadian phone numbers. Find local phone numbers within 50 miles of San Francisco, CA (37.840699,-122.461853) that contain the digits '555'.

                                                  Advanced list filter example

                                                  These features are limited to US and Canadian phone numbers. Find local phone numbers within 50 miles of San Francisco, CA (37.840699,-122.461853) that contain the digits '555'.
                                                  Rate this page:

                                                  Need some help?

                                                  We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.