Query Queue Pause Reason List

Query the existing queue pause reasons on PBX. 

GET {base_url}/{api_path}/queue_pause_reason/list?access_token={access_token}

Request parameters

Parameter Required Type Description
page No Integer Define which page is displayed.
page_size No Integer Define how many records per page.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
data Array <Pause_Reason> Pause reasons and the corresponding feature codes.
Pause_Reason
Parameter Type Description
code String The feature code of the pause reason.
reason String Pause reason.

Examples

Request example

GET /openapi/v1.0/queue_pause_reason/list?access_token=kiRFn8ugKJwIArRL9Uq1ly4svdRSDM2Y HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "code": "*01",
            "reason": "Lunch"
        },
        {
            "code": "*02",
            "reason": "Break"
        },
        {
            "code": "*03",
            "reason": "Wrap up"
        },
        {
            "code": "*04",
            "reason": "Task Transfer"
        }
    ]
}