查询单个消息队列信息

查询单个指定消息队列的详细信息。

请求 URL

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

请求参数

参数 是否必填 类型 说明
id 是 Integer 消息队列的唯一 ID。
注： 可使用 搜索特定消息队列 接口查询消息队列 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Object<Msg_Queue> 消息队列详情。
Msg_Queue
参数 类型 说明
id Integer 消息队列的唯一 ID。
name String 消息队列的名称。
members Array<Members> 消息队列中坐席的信息。
assignment_mode String 消息队列中聊天会话的分配模式。
  • none：坐席不允许接管会话。
  • auto：第一个回复消息的坐席自动接管会话。
  • manual：坐席手动点击 接管 按钮接管会话。
Members
参数 类型 说明
id Integer 坐席 ID。
extension_id Integer 坐席分机的 ID。
ext_num String 坐席分机的号码。
caller_id_name String 坐席的名称。

示例

请求示例

GET /openapi/v1.0/message_queue/get?id=3&access_token=N0BNItIvHFIHYruFE0EHoyqWsl8TflrJ HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 3,
        "name": "PreSales Consult Queue",
        "members": [
            {
                "id": 7,
                "extension_id": 39,
                "ext_num": "59996",
                "caller_id_name": "James Smith"
            },
            {
                "id": 8,
                "extension_id": 23,
                "ext_num": "59998",
                "caller_id_name": "Robert Williams"
            },
            {
                "id": 9,
                "extension_id": 10,
                "ext_num": "59999",
                "caller_id_name": "Michael Brown"
            }
        ],
        "assignment_mode": "manual"
    }
}