List Available Numbers
GET https://{{axpAPIDomain}}/api/admin/voice/v1/accounts/:accountId/available-phone-numbers?countryCode=US&type=LOCAL&pageNumber=1&pageSize=5
This API requires the Account Administrator role.
List available phone numbers
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
countryCode | string | (Required) Two letter ISO country code present here "https://www.iban.com/country-codes". Not all code supported which are listed here. | |
type | string | (Required) The type of phone number. Acceptable values are LOCAL or TOLLFREE. | |
areaCode | number | Filters list of available numbers based on area code. | |
phoneNumber | string | Specifies the desired characters contained within the available numbers to list. | |
pageNumber | number | The page number of the records to retrieve. Default value is 1. | |
pageSize | number | 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
| Key | Datatype | Required | Description |
|---|---|---|---|
appkey | string | ||
Accept | string |
RESPONSES
status: OK
{"pagination":{"pageNumber":2,"pageSize":10,"total":45},"phoneNumbers":[{"phoneNumber":"+16479308804","countryCode":"US","type":"LOCAL","documentationRequired":true}],"links":{"prev":"/api/admin/voice/v1/accounts/:accountId/available-phone-numbers?pageNumber=1\u0026pageSize=10","next":"/api/admin/voice/v1/accounts/:accountId/available-phone-numbers?pageNumber=3\u0026pageSize=10"}}