添加消息回应
为指定消息添加回应。支持单聊、群聊、超级群会话类型。
用户可以对消息添加回应(如点赞、点踩等)。同一个用户对同一条消息的相同回应只会保留最早的一次回应时间。
使用说明
- 消息回应功能无需单独开通,所有应用默认可用。
- 同一条消息支持的回应数量上限默认为 50 个。
- 每个回应的用户数量上限默认为 100 人。
- 仅支持对已开通云存储的消息添加回应。如需开通或调整消息云存储时长,单聊和群聊参见单群聊消息云端存储时长,超级群参见超级群历史消息存储。
请求方法
请求方式:POST
请求地址:
| 会话类型 | 请求地址 |
|---|---|
| 单聊消息 | https://数据中心域名/message/private/reaction/add.json |
| 群聊消息 | https://数据中心域名/message/group/reaction/add.json |
| 超级群消息 | https://数据中心域名/message/ultragroup/reaction/add.json |
频率限制:每秒 100 次
签名规则:所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/json,支持以下参数:
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
targetId | String | 是 | 会话 ID。单聊为对方用户 ID,群聊为群组 ID,超级群为超级群 ID。 |
msgUID | String | 是 | 消息唯一标识。可通过全量消息路由或历史消息日志获取。 |
reactionId | String | 是 | 回应 ID。由客户端定义的表情标识符,如 LIKE(点赞)、HEART(爱心)等。只能使用英文字母和数字组合,长度不超过 16 个字符。 |
userId | String | 是 | 回应人用户 ID。 |
busChannel | String | 否 | 频道 ID,仅超级群场景使用。如果原消息发送时指定了频道 ID,则添加回应时也必须指定相同的频道 ID。 |
pushContent | String | 否 | 推送 内容。当接收方用户离线时,在推送通知中显示的文本内容。 |
pushData | String | 否 | 推送数据。iOS 平台收到推送消息时,可从 payload 中获取,对应字段名为 appData。Android 平台收到推送消息时对应字段名也为 appData。 |
pushExt | String | 否 | 推送扩展信息,JSON 字符串格式。可设置推送标题、推送配置等。具体参见发送单聊普通消息中 pushExt 参数说明。 |
推送说明
只有同时传入 pushContent 和 pushExt 参数时,才会触发离线推送通知。如果只传其中一个参数,则不会进行推送。
请求示例
HTTP
POST /message/ultragroup/reaction/add.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": "target****01",
"msgUID": "AAAA-****-****-DDDD",
"reactionId": "HEART",
"userId": "user****89",
"busChannel": "channel001",
"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
}