Compatibility REST APIAvailable Phone Numbers

List of AvailablePhoneNumber resources by country

View as Markdown
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 used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account to retrieve.
IsoCountrystringRequired
The ISO country code of the number.

Response

The request has succeeded.
country_codestring
The ISO country code of the number.
countrystring
The country the number is from.
uristring
The URI for the API call.
betaboolean

New numbers on SignalWire are marked as beta.

subresource_urisobject
URIs for subresources.

Errors