撤回公众号消息
公众号会话类型的消息撤回,仅支持公众号做为发送者发送的消息的撤回。撤回指定消息后,原消息将被删除,同时生成一条 objectName 是 RC:RcCmd
的通知消息,UI 可根据 RC:RcCmd
展示
请求方法
POST:https://<your-domain-url>/media-platform/mc/msg/recall.json
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
字段 | 类型 | 描述 |
---|---|---|
fromMcId | String | 公众号 Id。(必传) |
toUserId | String | 接收用户 Id。(必传) |
sentTime | Long | 消息发送时间,可通过服务端实时消息路由获取,对应名称为 msgTimestamp。 |
messageUID | String | 消息唯一标识,可通过服务端实时消息路由获取,对应名称为 msgUID。 |
isDelete可选 | Int | 默认为 0 撤回该条消息同时,用户端将该条消息删除并替换为一条小灰条撤回提示消息;为 1 时,该条消息删除后,不替换为小灰条提示消息。(可选) |
isAdmin可选 | Int | 是否为管理员,默认为 0,设为 1 时,IMKit 收到此条消息后,小灰条默认显示为“管理员 撤加了一条消息”。(可选) |
extra可选 | String | 扩展信息,可以放置任意的数据内容。(可选) |
isRoute可选 | Int | 发出的消息是否路由到应用服务器,发出的消息是否路由到应用服务器,0 表示为不路由,1 表示为路由,默认为 1 路由。(可选) |
请求示例
POST /message/recall.json HTTP/1.1
Host: your-domain-url
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
fromMcId=fDR2cVpxxR5zSMUNh3yAwh&toUserId=MersNRhaKwJkRV9mJR5JXY&messageUID=5FGT-7VA9-G4DD-4V5P&sentTime=1507778882124
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
字段 | 类型 | 描述 |
---|---|---|
code | Int | 返回码,200 为正常。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}