List Available Numbers

get

{protocol}://{server}{basePath}/v1beta/accounts/{accountId}/available-phone-numbers

This API requires the Account Administrator role.

List available phone numbers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account

Query Params

countryCode

string

required

length between 2 and 2

^[A-Z]{2}$

Two letter ISO country code present here "https://www.iban.com/country-codes". Not all code supported which are listed here.

type

string

enum

required

The type of phone number. Acceptable values are LOCAL or TOLLFREE.

Allowed:

areaCode

string

length between 1 and 5

Filters list of available numbers based on area code.

phoneNumber

string

length between 1 and 15

Specifies the desired characters contained within the available numbers to list.

pageNumber

int32

≥ 1

Defaults to 1

The page number of the records to retrieve. Default value is 1.

pageSize

int32

1 to 50

Defaults to 5

The max number of records to retrieve per page. Default value is 5, Any value like 5,10,15,20,25,30 is allowed. If value comes more than 1000 then max 1000 records will be returned.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200OK

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

500Request processing failed