跳到主要内容

查询消息回应列表

查询单条消息的所有回应列表。支持单聊、群聊、超级群会话类型。

通过该接口可以分页查询指定消息的所有回应。每个回应包含该回应的用户总数以及前 10 名回应用户的预览信息。

使用说明

请求方法

请求方式:POST

请求地址

会话类型请求地址
单聊消息https://数据中心域名/message/private/reaction/query.json
群聊消息https://数据中心域名/message/group/reaction/query.json
超级群消息https://数据中心域名/message/ultragroup/reaction/query.json

频率限制:每秒 100 次

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

正文参数

HTTP 请求正文数据格式为 application/json,支持以下参数:

参数类型必传说明
msgUIDString消息唯一标识。
pageTokenString分页查询的起始位置标识。首次查询时不传该参数,后续查询传入上次返回的 pageToken 值。
sizeNumber每次获取的回应数量。默认值为 50,最大值为 50。

请求示例

HTTP
POST /message/group/reaction/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: pvxd****kds2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb****************************000e8
Content-Type: application/json

{
"msgUID": "AAAA-****-****-AAAA",
"pageToken": "next_****_token_123",
"size": 50
}

返回结果

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

返回值返回类型说明
codeNumber返回码,200 为正常。
pageTokenString下一页的分页标识。如果为空或不存在,表示已经是最后一页。
reactionInfoArray回应列表。

reactionInfo 数组元素结构:

参数类型说明
reactionIdString回应 ID。
userCntNumber该回应的用户总数。
userInfoArray回应用户预览列表,最多返回前 10 个用户。

userInfo 数组元素结构:

参数类型说明
userIdString回应人用户 ID。
reactionTimeLong回应时间,Unix 时间戳(毫秒)。

返回结果示例

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

{
"code": 200,
"pageToken": "next_****_token_456",
"reactionInfo": [
{
"reactionId": "THUMBSUP",
"userCnt": 100,
"userInfo": [
{
"userId": "user****01",
"reactionTime": 1678886400000
},
{
"userId": "user****02",
"reactionTime": 1678886410000
},
{
"userId": "user****03",
"reactionTime": 1678886420000
}
]
},
{
"reactionId": "HEART",
"userCnt": 80,
"userInfo": [
{
"userId": "user****04",
"reactionTime": 1678886430000
},
{
"userId": "user****05",
"reactionTime": 1678886440000
}
]
},
{
"reactionId": "SMILE",
"userCnt": 50,
"userInfo": [
{
"userId": "user****06",
"reactionTime": 1678886450000
}
]
}
]
}