v1
latestOpenAPI 3.1.02026-07-2414238909.1 KBView all the available numbers
get/numbers/available
Query parameters
countrystring required
The country of the recipient in ISO 3166-1 alpha 2 format.
servicestring
The available services are "Sms" and "Voice" (case sensitive)
pageinteger
The page number to retrieve, default value is 0 (meaning the first page).
sizeinteger
The number of items to retrieve, default value is 20.
sortstring
The field name that will be used to sort the results.
areaCodeinteger
Area code is a 3-digit prefix applied only for US numbers(1-xxx-123456).
Headers
Authorizationstring required
Bearer {access_token}
Content-Typestring required
application/json
Response
200
Example response
{
"content": [
{
"msisdn": "+15033365068",
"country": "US",
"services": [
"Sms"
],
"inboundCosts": [
{
"price": 0.01,
"currency": "EUR",
"service": "Sms"
}
],
"monthlyCosts": {
"price": 0.05,
"currency": "EUR"
},
"activationCosts": {
"price": 0.05,
"currency": "EUR"
},
"chargeInterval": 1
}
],
"totalPages": 1,
"last": true,
"totalElements": 1,
"first": true,
"numberOfElements": 1,
"size": 20
}