List of AvailablePhoneNumber resources

GET 
/Accounts/:AccountSid/AvailablePhoneNumbers

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.

Request

Path Parameters

AccountSid uuidrequired

The Project ID that uniquely identifies the Account to retrieve.

Responses

200

OK

application/json

Schema

Schema

uri string
The URI for the API call.
Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local

countries

object

beta boolean

New numbers on SignalWire are marked as beta. Possible values are true or false.

country string

The country the number is from.

Example: United States

country_code string

The ISO country code of the number.

Example: US

subresource_uris

object

local string

The URI of the subresource

Example: /2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local

toll_free string

The URI of the subresource

Example: /2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local

uri string

The URI for the API call.

Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local

Example (from schema)

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