Menu

Expand
Rate this page:

AvailablePhoneNumber resource

The subresources of the AvailablePhoneNumber resource lets you search for local, toll-free and mobile 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.

You cannot make requests directly to AvailablePhoneNumber instance resources. Instead, to find available numbers, make a request to one of the subresources:

Once you've found a number you'd like to purchase (also referred to as provisioning a number or buying the number), you can do so using the Incoming Phone Numbers API.

Supported Countries and Types

You can query the AvailablePhoneNumber resource to get a list of subresources available for your account by ISO Country. For full information about our phone number support, see our Phone Number CSV or the FAQ. Each instance of the resource will have the following properties.

Resource Properties in REST API format
country_code
iso_country_code Not PII

The ISO-3166-1 country code of the country.

country
string Not PII

The name of the country.

uri
url Not PII

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

beta
boolean Not PII

Whether all phone numbers available in the country are new to the Twilio platform. true if they are and false if all numbers are not in the Twilio Phone Number Beta program.

subresource_uris
uri_map Not PII

A list of related AvailablePhoneNumber resources identified by their URIs relative to https://api.twilio.com.

Fetch a specific country

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

The SID of the Account requesting the available phone number Country resource.

country_code
Path
get iso_country_code Not PII

The ISO-3166-1 country code of the country to fetch available phone number information about.

Example 1
        
        
        
        
        Fetches the subresources available for the US

        Fetch a specific country

        Fetches the subresources available for the US

        Read a list of countries

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json
        Parameters
        Parameters in REST API format
        account_sid
        Path
        get sid<AC> Not PII

        The SID of the Account requesting the available phone number Country resources.

        Example 1
              
              
              
              
              Gets the subresources available for all supported countries

              Read a list of countries

              Gets the subresources available for all supported countries
              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.

                    
                    
                    

                    Thank you for your feedback!

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

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    Refer us and get $10 in 3 simple steps!

                    Step 1

                    Get link

                    Get a free personal referral link here

                    Step 2

                    Give $10

                    Your user signs up and upgrade using link

                    Step 3

                    Get $10

                    1,250 free SMSes
                    OR 1,000 free voice mins
                    OR 12,000 chats
                    OR more