查询暂停原因列表

查询 PBX 中已添加的队列暂停原因。

请求 URL

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

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Array <Pause_Reason> 暂停原因及特征码。
Pause_Reason
参数 类型 说明
code String 暂停原因的特征码。
reason String 暂停原因。

示例

请求示例

GET /openapi/v1.0/queue_pause_reason/list?access_token=kiRFn8ugKJwIArRL9Uq1ly4svdRSDM2Y HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

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"
        }
    ]
}