移除消息回应
移除指定消息的回应。支持单聊、群聊、超级群会话类型。
用户可以取消之前添加的回应。移除回应后,该用户对该消息的该回应记录将被删除。
使用说明
- 只能移除
userId对应用户自己添加的回应。 - 超级群频道消息需要传入与原消息相同的频道 ID。
请求方法
请求方式:POST
请求地址:
| 会话类型 | 请求地址 |
|---|---|
| 单聊消息 | https://数据中心域名/message/private/reaction/remove.json |
| 群聊消息 | https://数据中心域名/message/group/reaction/remove.json |
| 超级群消息 | https://数据中心域名/message/ultragroup/reaction/remove.json |
频率限制:每秒 100 次
签名规则:所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/json,支持以下参数:
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
targetId | String | 是 | 会话 ID。单聊为对方用户 ID,群聊为群组 ID,超级群为超级群 ID。 |
msgUID | String | 是 | 消息唯一标识。可通过全量消息路由或历史消息日志获取。 |
reactionId | String | 是 | 回应 ID。要移除的表情标识符,只能使用英文字母和数字组合,长度不超过 16 个字符。 |
userId | String | 是 | 回应人用户 ID。只能移除该用户自己添加的回应。 |
busChannel | String | 否 | 频道 ID,仅超级群场景使用。如果原消息发送时指定了频道 ID,则移除回应时也必须指定相同的频道 ID。 |
pushContent | String | 否 | 推送内容。当接收方用户离线时,在推送通知中显示的文本内容。 |
pushData | String | 否 | 推送数据。iOS 和 Android 平台收到推送消息时可从 payload 中获取的自定义数据,对应字段名为 appData。 |
pushExt | String | 否 | 推送扩展信息,JSON 字符串格式。可设置 推送标题、推送配置等。具体参见发送单聊普通消息中 pushExt 参数说明。 |
推送说明
只有同时传入 pushContent 和 pushExt 参数时,才会触发离线推送通知。如果只传其中一个参数,则不会进行推送。
请求示例
HTTP
POST /message/group/reaction/remove.json HTTP/1.1
Host: api.rong-api.com
App-Key: pvxd****kds2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb****************************000e8
Content-Type: application/json
{
"targetId": "group****01",
"msgUID": "AAAA-****-****-DDDD",
"reactionId": "HEART",
"userId": "user****89",
"pushContent": "用户取消了回应",
"pushData": "{\"key\":\"value\"}",
"pushExt": "{\"title\":\"消息回应\"}"
}
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
| 返回值 | 返回类型 | 说明 |
|---|---|---|
code | Number | 返回码,200 为正常。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200
}