Get Pause Reasons

Retrieves the list of pause reasons configured for agents.

Request URL

GET {base_url}/uc-cconfig/api/v1/queues/pause-reasons

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
results Array<Pause_Reason_Data> The list of pause reasons.
Pause_Reason_Data
Parameter Type Description
id String The ID of the pause reason.
featureCode String The feature code of the pause reason.
reason String The description of the pause reason.

Example

Request example

GET /uc-cconfig/api/v1/queues/pause-reasons HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTkxMzkwNiwiaWF0IjoxNzkxODkyMzA2LCJqdGkiOiIyNjQzMzg4MC04OGI2LTQ1YjItYmMzZC1lMWFlM2MyZWM2NGIiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.AMBnRYQuBmBxX5qZGethRuAqTm9JzAHAQJgq0rBW9kZo_B7ZJHYZOOt7hMyQRMG_fYfnJoU-LmZCM99e20jwQZ2vSipaTtIa7BGhpr7KK-EBunjLU2lAuv2FDEE6B9yGu-ZVg56tNXQRgv1xfTN-bQgN-qx9dcJc2j4wQX9Rqxd6NhjWO1eGUQlWOcVd-gpveaRCU-q6BwNlZL8JAS7rkFrf1uHYnKxUbDh_X-7Cx7f7DtR3R3VsywDXOeNmHQ-DqiKmaOtxOYFgKh9hyeQR9QSJ2V5rM3VILn4Ffb21hbrPARxNml9zhtTU4653e4Ir4J5WEJB50YSIRJX71o48qQ
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "2cbeab0a6c4716d9cf2f818a0e3ea80e",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "results": [
    {
      "id": "361032822726717440",
      "featureCode": "*01",
      "reason": "Lunch"
    },
    {
      "id": "361032822743494656",
      "featureCode": "*02",
      "reason": "Break"
    },
    {
      "id": "361032822881906688",
      "featureCode": "*03",
      "reason": "Wrap-up"
    }
  ]
}