Sign in
Available Phone Numbers

List of AvailablePhoneNumber resources

Returns a list of URIs to phone number resources available to the account, categorized by type (Local, Toll-Free, Mobile, etc) and ISO country.

Permissions

The API token must include the following scopes: Numbers.

get/Accounts/{AccountSid}/AvailablePhoneNumbers

Path parameters

AccountSidstring uuid required

The Project ID that uniquely identifies the Account to retrieve.

Response

The request has succeeded.

uristring required

The URI for the API call.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers",
  "countries": [
    {
      "country_code": "US",
      "country": "United States",
      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US",
      "subresource_uris": {
        "local": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local",
        "toll_free": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/TollFree"
      }
    }
  ]
}

Changes