转移消息会话

将消息会话转移至指定分机、消息队列或第三方分析平台。

请求 URL

POST {base_url}/{api_path}/message_session/transfer?access_token={access_token}

请求参数

参数 是否必填 类型 说明
session_id 是 Integer 消息会话的唯一 ID。
注： 可使用 搜索特定消息会话 接口获取消息会话 ID。
destination_type 是 String 会话转移目的地的类型。
取值范围：
  • extension：分机用户。
  • queue：消息队列。
  • api：第三方分析平台 (消息通过二次开发接口传递)
destination_id 否 Integer 会话转移目的地的 ID。
取值范围：
  • 此参数在 destination_type 设为 extension 或 queue 时必填，用于指定目的地的 ID。
    注： 可使用 搜索特定分机 接口搜索分机 ID，使用 搜索特定消息队列 搜索消息队列 ID。
  • 若 destination_type 设为 api，可设此参数为 0 或留空。

响应参数

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

示例

请求示例

将某个消息会话 (ID：3073) 转移给指定分机 (ID：138)。

POST /openapi/v1.0/message_session/transfer?access_token=xMv4MJAruG8wFiqj0f0y8tgaMvR44nQm HTTP/1.1

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

{
  "session_id": 3073,
  "destination_type": "extension",
  "destination_id": 138  
}

响应示例

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