添加消息队列

添加消息队列,包括设置聊天会话分配模式和分配队列坐席。

请求 URL

POST {base_url}/{api_path}/message_queue/create?access_token={access_token}

请求参数

参数 是否必填 类型 说明
name String 消息队列名称。
assignment_mode String 消息队列中聊天会话的分配模式。
取值范围
  • none:坐席不允许接管会话。
  • auto:第一个回复消息的坐席自动接管会话。
  • manual:坐席手动点击 接管 按钮接管会话。
members Array<Members> 消息队列坐席。
Members
参数 是否必填 类型 说明
extension_id Integer 坐席分机的唯一 ID。
注: 可使用 搜索特定分机 接口查询分机 ID。

响应参数

1.
参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
id Integer 消息队列的唯一 ID。

示例

请求示例

POST /openapi/v1.0/message_queue/create?access_token=BkkrLotuuRnrxaOYAFXXshPz1Ot1OeCd HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

{
    "name":"docs-message-queue",
    "assignment_mode":"auto",
    "members":[
        {"extension_id":137},
        {"extension_id":138}
    ]
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 20
}