清除历史消息

说明:如用户开通了单群聊消息云存储服务,可通过此接口按会话清除某用户指定时间之前服务端存储的历史消息,清除后用户在客户端无法再获取到存储到融云服务端历史消息,请谨慎执行此操作。

方法名:/conversation/message/history/clean

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/conversation/message/history/clean.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
conversationType String 会话类型,支持单聊、群聊、系统消息,单聊会话是 1、群组会话是 3、系统通知是 6 (必传)
fromUserId String 操作用户 ID,删除该用户指定会话 msgTimestamp 前的历史消息(必传)
targetId String 清除的目标会话 ID,(必传)
msgTimestamp String 清除该时间戳之前的所有历史消息,精确到毫秒,为空时清除该会话的所有历史消息。(非必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

Request:

POST /conversation/message/history/clean.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

fromUserId=1&targetId=8888&conversationType=3&msgTimestamp=1566281295943

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}