This endpoint is deprecated.

Get available numbers

DEPRECATED:

SUNSET:

SUCCESSOR:

Jan 20, 2024.

Not planned

None

Use this method to get all the numbers available to buy. Use the query parameters to filter the returned numbers for specific details.

Getting available US numbers is restricted to integrated users only.
Please refer to Resource Request API, which is a preferred method for purchasing US numbers.

Authorizations:

Scopes:

numbers:manage

query Parameters

capabilities	Array of strings Items Enum: "SMS" "VOICE" "MMS" "WHATSAPP" "WHATSAPP_VOICE" An array of communication channels the number is able to support.
country	string The number's country code.
state	string US Numbers only: US state
npa	integer <int32> US numbers only: area code.
nxx	integer <int32> US numbers only: the 3 digits following the area code.
limit	integer <int32> Default: 10 Number of records returned per page.
number	string Searched number.
page	integer <int32> Default: 0 Page number. Use it with `limit` for paging purposes.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Use case: Making an appointment using 2-way SMS communication

Request samples

Example

cURL

Copy

curl -L -g 'https://{baseUrl}/numbers/1/numbers/available' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type

application/json

Copy

Collapse all


{"numbers": 
[
{"numberKey": "78D8394AC3EG0460B4CF0E723FC31B49",
"number": "79029555551",
"country": "RU",
"type": "VIRTUAL_LONG_NUMBER",
"capabilities": 
["SMS"
],
"shared": false,
"price": 
{"pricePerMonth": 15,
"setupPrice": 0,
"initialMonthPrice": 9.193549,
"currency": "EUR"
}
},
{"numberKey": "3B9D1EACAB7FBDRN%EE03592BFCD6BE",
"number": "79029555525",
"country": "RU",
"type": "VIRTUAL_LONG_NUMBER",
"capabilities": 
["SMS"
],
"shared": false,
"price": 
{"pricePerMonth": 15,
"setupPrice": 0,
"initialMonthPrice": 9.193549,
"currency": "EUR"
}
}
],
"numberCount": 2
}