Qodex.ai

List Numbers

GET https://{{axpAPIDomain}}/api/admin/voice/v1/accounts/:accountId/phone-numbers?pageNumber=1&pageSize=5

This API requires the Account Administrator role.

List phone numbers with accountId

Request Params

KeyDatatypeRequiredDescription
pageNumbernumberThe page number of the records to retrieve. Default value is 1.
pageSizenumberThe 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.
filterstringThe possible fields you can filter on are phoneNumber, displayName, countryCode, type and status. The allowed format:
  • Begins with the field name to be filtered, followed by a colon and:
    • Either an exact string to match, or
    • A string expression including the * wildcard character

Examples include 'phoneNumber:+35311234567', 'countryCode:IN' | | orderBy | string | | Field name on which ordering needs to be performed. The possible fields that can be ordered by are phoneNumber, displayName, countryCode, type. Field names are case-senstive (should be written as it is in description). The default sorting order is 'phoneNumber ascending'. To specify descending order, a suffix ' desc' should be apended. For example, "name" for ascending or "name desc" for descending". |

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Acceptstring

RESPONSES

status: OK

{"pagination":{"pageNumber":2,"pageSize":10,"total":45},"phoneNumbers":[{"phoneNumberId":"c8c2909d-75e9-484a-94c0-b7e8d29771fe","phoneNumber":"+16479308804","displayName":"private Number","isCallingPartyNumber":true,"countryCode":"US","type":"LOCAL","accountId":":accountId","status":"INACTIVE","statusMessage":"Verification needed. Please send the necessary documents to siptrunksupport@avaya.com to activate it."}],"links":{"prev":"/api/admin/voice/v1/accounts/:accountId/phone-numbers?pageNumber=1\u0026pageSize=10","next":"/api/admin/voice/v1/accounts/:accountId/phone-numbers?pageNumber=3\u0026pageSize=10"}}