Lists all CM servers

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

This API requires the Account Administrator role.

Returns the list of all available Communication Manager servers by account id

Request Params

The possible fields that can be filtered on are:

• name

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":[{"id":"a5ed735d-0688-47c5-872d-366a84b23536","name":"CM4696","description":"This is testing Communication Manager.","hostname":"dc1-cm96.avayacloud.stage","port":"5022","username":"cust","password":"testpassword","version":"V10_X","hybridCloudGatewayId":"04703a3a-3dfb-4606-ae79-fd0fe0be3e64","status":"IN_PROGRESS"},{"id":"8c21249d-b98d-408a-9537-c6141fdb57df","name":"CM132","description":"This is testing Communication Manager.","hostname":"dc3-cm32.avayacloud.stage","port":"5022","username":"cust","password":"testpassword","version":"V10_X","hybridCloudGatewayId":"b7f551d8-ed78-11ed-a05b-0242ac120003","status":"SUCCESS"}],"links":{"next":"/v1/accounts/GHFDWE/communication-managers?pageNumber=3\u0026pageSize=10","previous":"/v1/accounts/GHFDWE/communication-managers?pageNumber=1\u0026pageSize=10"}}