List Voice Plans

GET https://{{axpAPIDomain}}/api/admin/voice/v1/accounts/:accountId/communication-managers/:communicationManagerId/voice-plans?pageNumber=1&pageSize=5&filter=name=Voice Plan&orderBy=name

This API requires the Account Administrator role.

Lists all of the Voice Plans configured in the Communication Manager server for an account.

Request Params

The possible fields that can be filtered on are:

• name
• type
• status
• userProfileId

The allowed format:

• Begins with the column name to be filtered, followed by a colon, then:
  • Either an exact string to match, or
  • A string expression including the * wildcard character
    • :{PREFIX}* will be used to find out word start with.
    • :*{POSTFIX} will be used to find out word end with
    • : will be used to match exact word
• Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string) | | orderBy | string | | Field name on which ordering needs to be performed. The default order is ascending.

The possible fields that can be ordered on are:

• name

Field Names are case-senstive (should be written as it is in description). To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc" for descending. |

HEADERS

RESPONSES

status: OK

{"pagination":{"pageNumber":1,"pageSize":10,"total":2},"resources":[{"voicePlanId":"46a99207-a5ac-4968-b488-9c078193eba1","name":"User Voice Plan for Production","type":"USER","userProfileId":"ASEDFG","description":"User Voice plan for production Communication Manager","agentDialPlanRange":["20000:20100"],"extensionDialPlanRange":["30000:30100","8000000:9000000"]},{"voicePlanId":"a5ed735d-0688-47c5-872d-366a84b23536","name":"System Range for Production","type":"SYSTEM","userProfileId":"ASEDFG","description":"System Range for production Communication Manager","reasonCodeNotReadyRange":["1:20","50:99"],"reasonCodeLogOutRange":["1:9"]}],"links":{"next":"/v1/accounts/GHFDWE/communication-managers/18e4f754-5e42-4387-ae13-e9b4fe4aed29/voice-plans?pageNumber=3\u0026pageSize=10","previous":"/v1/accounts/GHFDWE/communication-managers/18e4f754-5e42-4387-ae13-e9b4fe4aed29/voice-plans?pageNumber=1\u0026pageSize=10"}}