查询消息队列列表

请求 URL

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

请求参数


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

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
total_number	Integer	消息队列总数。
list	Array<Msg_Queue>	消息队列的信息。

Msg_Queue


参数	类型	说明
id	Integer	消息队列的唯一 ID。
name	String	消息队列的名称。

示例

请求示例

GET /openapi/v1.0/message_queue/list?access_token=FdOMCWyxiQLAF9r9JqHg0fTCecqtp6Vo&page=1&page_size=5 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 11,
    "list": [
        {
            "id": 3,
            "name": "PreSales Consult Queue"
        },
        {
            "id": 4,
            "name": "After Sales Service Queue"
        },
        {
            "id": 5,
            "name": "Technical Support Queue"
        },
        {
            "id": 6,
            "name": "Customer Care Queue"
        },
        {
            "id": 13,
            "name": "Product Feedback Queue"
        }
    ]
}