Skip to main content
POST
/
v1.0
/
numbers
/
availability
Get available numbers for a given area-code or zip code
curl --request POST \
  --url https://api.example.com/v1.0/numbers/availability \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "NumberType": "<string>",
  "MessageType": "<string>",
  "MessageEnabled": true,
  "VoiceEnabled": true,
  "MessageRouteId": "<string>",
  "VoiceRouteId": "<string>",
  "AreaCode": "<string>",
  "ZipCode": "<string>",
  "PageNumber": 123
}
'

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Obtain token from /v1.0/OAuth2/tokens endpoint.

Body

Available_By_Area_Request object

​
NumberType
string
required
Minimum string length: 1
​
MessageType
string | null
​
MessageEnabled
boolean
​
VoiceEnabled
boolean
​
MessageRouteId
string | null
​
VoiceRouteId
string | null
​
AreaCode
string | null
​
ZipCode
string | null
​
PageNumber
integer<int32>

Response

200

Success