编辑消息队列

更新指定消息队列的设置。

请求 URL

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

请求参数

参数 是否必填 类型 说明
id 是 Integer 消息队列的唯一 ID。
注： 可使用 搜索特定消息队列 接口查询消息队列 ID。
name 否 String 消息队列名称。
assignment_mode 否 String 消息队列中聊天会话的分配模式。
取值范围：
  • none：坐席不允许接管会话。
  • auto：第一个回复消息的坐席自动接管会话。
  • manual：坐席手动点击 接管 按钮接管会话。
members 否 Array<Members> 消息队列坐席。
Members
重要： 此设置不支持部分更新，所有需要保留的现有坐席信息必须全部提交。
参数 是否必填 类型 说明
id 否 Integer 坐席的唯一 ID。
注：
extension_id 是 Integer 坐席分机的唯一 ID。
注： 可使用 搜索特定分机 接口查询分机 ID。

响应参数

表 1.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

为某个消息队列 (ID：20) 增加一位坐席(ID：26)。

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

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
   "id":20,
   "members":[
        {"id":1, "extension_id":137},   
        {"id":2, "extension_id":138}, //保留所有原有坐席信息，否则现有设置将被覆盖。
        {"extension_id":26}
    ]
}

响应示例

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