跳到主要内容

撤回全量用户落地通知

撤回全量用户落地通知本质是发送一条撤回命令消息。用户端收到撤回命令消息后，原目标消息将被删除，同时生成一条 objectName 为 RC:RcNtf 的通知消息。会话界面可根据 RC:RcNtf 展示撤回提示。

本接口仅支持撤回通过发送全量用户落地通知接口（/message/broadcast.json）发送的消息。

提示

撤回命令消息也会存储到历史消息中。SDK 在获取历史消息时，会获取到撤回命令消息和被撤回的原始消息。移动端 SDK 已内部实现删除逻辑，开发者无需额外处理。

请求方法​

POST： https://数据中心域名/message/broadcast/recall.json

频率限制：每小时限发送 2 次，每天（自然日）最多发送 3 次。

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

正文参数​

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

参数类型必传说明
fromUserIdString是消息发送人用户 ID。
messageUIDString是消息唯一标识。目前只能通过历史消息日志获取，对应字段名称为 msgUID。
  • 获取历史消息日志数据有一定延迟，详见历史消息日志。
  • 通过全量用户落地通知发送的消息不支持全量消息路由服务，因此无法通过全量消息路由服务获取该字段的值。
sentTimeLong否消息发送时间。目前只能通过历史消息日志获取，对应字段名称为 dateTime。
  • 获取历史消息日志数据有一定延迟，详见历史消息日志。
  • 通过全量用户落地通知发送的消息不支持全量消息路由服务，因此无法通过全量消息路由服务获取该字段的值。
isAdminInt否是否为管理员操作，默认为 0。设置为 1 时，IMKit 收到此消息后，小灰条默认显示为“管理员 撤回了一条消息”。
isDeleteInt否指定移动端接收方是否需要在本地删除原始消息记录并显示撤回提示，默认为 0。
  • 为 0 时，用户端会删除原始消息内容，并替换为一条小灰条撤回提示消息。
  • 为 1 时，用户端会删除原始消息，不显示小灰条撤回提示消息。
extraString否扩展信息，可放置任意数据内容。
disableUpdateLastMsgBoolean否是否禁止更新会话的最后一条消息。为 false 时，撤回命令消息会进入会话列表；为 true 时，不更新会话列表中的最后一条消息。
注意：此参数仅对存储在客户端的消息有效。

请求示例​

HTTP
POST /message/broadcast/recall.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

fromUserId=fDR2cVpxxR5zSMUNh3yAwh&messageUID=5FGT-7VA9-G4DD-4V5P&sentTime=1507778882124

返回结果​

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

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

返回结果示例​

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

{"code":200}