Sign in
Available Phone Numbers

List of AvailablePhoneNumber resources by country

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

Permissions

The API token must include the following scopes: Numbers.

get/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountry}

Path parameters

AccountSidstring uuid required

The Project ID that uniquely identifies the Account to retrieve.

IsoCountrystring required

The ISO country code of the number.

Response

The request has succeeded.

country_codestring required

The ISO country code of the number.

countrystring required

The country the number is from.

uristring required

The URI for the API call.

betaboolean required

New numbers on SignalWire are marked as beta.

Example response

{
  "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