存档消息会话

存档消息会话。

请求 URL

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

请求参数

参数 是否必填 类型 说明
session_id 是 Integer 消息会话的唯一 ID。
注： 可使用 搜索特定消息会话 接口获取消息会话 ID。
user_type 是 Integer 存档消息会话的操作者类型。
取值范围：
  • 1：分机用户。
  • 9：第三方分析平台。
user_no 否 String 存档消息会话的操作者的唯一 ID。
取值范围：
  • 此参数在 user_type设为 1 时必填，用于指定分机用户的 ID。
    注： 可使用 搜索特定分机 接口查询分机 ID。
  • 若 user_type 设为 9，可设此参数为 api 或留空。

响应参数

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

示例

请求示例

分机 1004 存档其消息会话 (ID：3073)。

POST /openapi/v1.0/message_session/archive?access_token=PLpSKjhDXAEFgKMJP3VxvJD1kLoiApp1 HTTP/1.1

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

{
    "session_id": 3073,
    "user_type": 1,
    "user_no":"1004" 
}

响应示例

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