撤回全量用户落地通知
撤回指定消息本质是发送一条撤回命令消息。移动端收到撤回命令消息后,原目标消息将被删除,同时生成一条 objectName
是 RC:RcNtf
的通知消息,会话界面中 可根据 RC:RcNtf
展示。
支持撤回以下功能发送的消息:
- 发送全量用户落地通知:
/message/broadcast.json
- 发送标签用户通知:
/push.json
- 发送应用包名用户通知:
/push.json
提示
撤回命令消息也会存储到历史消息中,SDK 在获取历史消息时,会获取到撤回命令消息和被撤回的原始消息。移动端 SDK 已内部实现删除逻辑,开发者无需额外处理。
请求方法
POST: https://数据中心域名/message/broadcast/recall.json
频率限制:每小时限发送 2 次,每天(自然日)最多发送 3 次。
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
fromUserId | String | 是 | 消息发送人用户 ID。 |
messageUID | String | 是 | 消息唯一标识。目前只能通过历史消息日志获取,对应字段名称为 msgUID 。
|
sentTime | Long | 是 | 消息发送时间。目前只能通过历史消息日志获取,对应字段名称为 dateTime 。
|
isAdmin | Int | 否 | 是否为管理员,默认为 0,设为 1 时,IMKit 收到此条消息后,小灰条默认显示为“管理员 撤回了一条消息”。 |
isDelete | Int | 否 | 默认为 0 撤回该条消息同时,用户端将该条消息删除并替换为一条小灰条撤回提示消息;为 1 时,该条消息删除后,不替换为小灰条提示消息。 |
extra | String | 否 | 扩展信息,可以放置任意的数据内容。 |
请求示例
POST /message/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 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 为正常。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}