跳到主要内容

清除消息

如果 App（App Key/环境）开通了单群聊消息云存储服务或聊天室消息云端存储服务，可通过此接口从即时通讯服务端删除历史消息。

  • 针对单聊、群聊、系统会话，该接口会为指定用户（fromUserId）清除服务端存储的指定时间之前的会话历史消息。清除成功之后，该用户无法再通过历史消息服务获取该会话中早于指定时间的历史消息。
  • 针对聊天室会话，该接口会为所有用户清除服务端存储的指定时间之前的会话历史消息。清除成功之后，所有用户均无法再通过历史消息服务获取该会话中早于指定时间的历史消息。请谨慎操作。
提示
  • 清除历史消息不会影响离线消息?收取。如果通过该 API 清除的历史消息中包含客户端离线期间的消息（即客户端未收取过的消息），则客户端再次上线时会自动收取离线消息。
  • 清除历史消息不会影响离线消息补偿机制（该机制仅会在打开多设备消息同步开关后生效）。如果 App 用户卸载重装、换端登录，会触发离线消息补偿机制，默认收取 1 个自然日内（含当天）的消息。如需彻底删除消息补偿，请提交工单，申请开通删除服务端历史消息时同时删除多端补偿的离线消息。

请求方法​

POST： https://数据中心域名/conversation/message/history/clean.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
conversationTypeString是会话类型。支持的会话类型包括：1（单聊会话）、3（群组会话）、4（聊天室会话）、6（系统通知）
fromUserIdString是
  • 单聊、群聊、系统会话：表示删除指定用户的服务端历史消息。清除成功后，该用户无法从服务端获取已清除的历史消息。
  • 聊天室会话：表示执行删除操作的操作者用户 ID。清除成功后，所有用户均无法从服务端获取已清除的历史消息。
targetIdString是需要清除的目标会话 ID。
msgTimestampString否清除该时间戳之前的所有历史消息，精确到毫秒。为空时清除该会话的所有历史消息。

请求示例​

POST /conversation/message/history/clean.json HTTP/1.1
Host: api.rong-api.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

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 为正常。

返回结果示例​

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

{"code":200}
最后于 更新