Get Availability

get

https://api.cm.com/voice-phonenumberrequestapi/v1/{accountGuid}/numberrequests/availability

Check the availability of phone numbers based on the provided request details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountGuid

uuid

required

Unique identifier of the Logical Account or Voice Account.

Query Params

Quantity

int32

The quantity of numbers to check availability for.

RangeSize

int32

The size of the range to check availability for. Only required if a range of numbers is requested.
Requires number ranges to be supported. See the order restrictions endpoint for the allowed ranges

CountryCode

string

The country code in ISO 3166-1 alpha-2 format.

NumberType

string

enum

The type of the number, either Local, National, or TollFree.

Allowed:

AreaCode

string

The area code to check availability for. Required when city is not provided.
If the city is also provided, this will be used in combination with city.

City

string

City to check availability for. Required when area code is not provided.
If the area code is also provided, this will be used in combination with area code.

Region

string

The region the city is located in (only required for Nanpa).

Responses

401

Unauthorized

200Success