Search for available phone numbers that match your criteria.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Searches SignalWire inventory for local phone numbers available in one ISO country. Results are candidates, not project resources, until purchased through Incoming Phone Numbers or the native purchase operation. Use the [toll-free search](/docs/compatibility-api/rest/available-phone-numbers/search-toll-free-available-phone-numbers) for toll-free inventory, or native [Search phone numbers](/docs/apis/rest/phone-numbers/search-available-phone-numbers) for the JSON API. #### 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)

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.

Query parameters

AreaCodestringOptional

Find numbers in the provided area code. Only available for numbers in US and Canada.

BetabooleanOptional

New numbers on SignalWire are marked as beta.

ContainsstringOptional

Find numbers based off of a pattern. Valid characters are [0-9a-zA-Z].

ExcludeAllAddressRequiredbooleanOptional

Accepted but has no effect on the response.

ExcludeForeignAddressRequiredbooleanOptional

Accepted but has no effect on the response.

ExcludeLocalAddressRequiredbooleanOptional

Accepted but has no effect on the response.

FaxEnabledbooleanOptional

Accepted but not supported; has no effect on the response.

InLocalitystringOptional

Limits search to a city/locality. Requires InRegion to also be set.

InRegionstringOptional

Limits search to same region as number. Must be a two-letter state/province code.

MmsEnabledbooleanOptional

Accepted but not supported; has no effect on the response.

SmsEnabledbooleanOptional

Accepted but not supported; has no effect on the response.

VoiceEnabledbooleanOptional

Accepted but not supported; has no effect on the response.

Response

The request has succeeded.

uristring

The URI for the API call.

available_phone_numberslist of objects

List of available phone numbers.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error