List Reason Codes
GET https://{{axpAPIDomain}}/api/admin/voice/v1/accounts/:accountId/communication-managers/:communicationManagerId/reason-codes?codeType=NOT_READY&codeName=Lunch&codeNumber=75&pageNumber=1&pageSize=10&orderBy=codeName desc
This API requires the Account Administrator role.
Returns list of Reason Codes based on the specified filtering criteria. If no filtering criteria is specified, this call returns list of all Reason Codes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
codeType | string | (Required) The mandatory type of the codes to query. | |
codeName | string | The optional name of the code to query. | |
codeNumber | number | The optional number of the code to query. | |
pageNumber | number | The page number of the records to retrieve. Default value is 1. | |
pageSize | number | The maximum number of results per page. Default value is 10, max value is 100. | |
orderBy | string | Specifies how response data should be sorted. Only codeName and codeNumber are valid options. | |
| 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, "codeName asc" for ascending or "codeName desc" for descending". | |||
| The default sorting order is codeName ascending. | |||
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
appkey | string | ||
Accept | string |
RESPONSES
status: OK
{"pagination":{"pageNumber":2,"pageSize":10,"total":20},"resources":[{"reasonCodeId":"123e4567-e89b-12d3-a456-426614174000","codeName":"Work on Digital","codeNumber":"89","codeType":"NOT_READY","isInterruptible":true,"systemDefinedAttributes":["WORK_ON_DIGITAL"],"organizationNodeId":"EXMPLE","status":"SUCCESS"},{"reasonCodeId":"8b2ae74d-61e5-48df-8b32-81a7bc726495","codeName":"Unreachable","codeNumber":"88","codeType":"NOT_READY","description":"Agent is unreachable","isInterruptible":false,"systemDefinedAttributes":["REDIRECTION_ON_OPTIM_FAILURE"],"organizationNodeId":"EXMPLE","status":"SUCCESS"}],"links":{"prev":"/v1/accounts/NCWBNY/communication-managers/5e9be49a-32d3-4927-83c7-7b0952798028/reason-codes?pageNumber=1\u0026pageSize=10","next":"/v1/accounts/NCWBNY/communication-managers/5e9be49a-32d3-4927-83c7-7b0952798028/reason-codes?pageNumber=3\u0026pageSize=10"}}