跳到主要内容

批量查询消息回应摘要

批量查询多条消息的回应摘要信息。支持单聊、群聊、超级群会话类型。

通过该接口可以一次查询多条消息的回应情况。每条消息返回回应摘要信息，包括回应总数、各回应的用户数量以及前 10 名回应用户的预览信息。

使用说明
  • 仅支持查询已经开通云存储的消息的回应摘要。如需开通或调整消息云存储时长，单聊和群聊参见单群聊消息云端存储时长，超级群参见超级群历史消息存储的回应摘要。
  • 单次最多查询 100 条消息的回应信息。
  • 每条消息最多返回 50 个回应信息。
  • 每个回应最多返回前 10 个用户的预览信息。
  • msgUIDs 参数中的空字符串元素将被忽略，不会报错。

请求方法​

请求方式：POST

请求地址：

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

频率限制：每秒 100 次

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

正文参数​

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

参数类型必传说明
msgUIDsArray是消息 ID 列表，最多 100 个。每个元素为消息的唯一标识 msgUID。

请求示例​

HTTP
POST /message/private/reaction/batch/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

{
  "msgUIDs": [
    "AAAA-****-****-AAAA",
    "BBBB-****-****-BBBB",
    "CCCC-****-****-CCCC"
  ]
}

返回结果​

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

返回值返回类型说明
codeNumber返回码，200 为正常。
reactionArray消息回应摘要列表。

reaction 数组元素结构：

参数类型说明
msgUIDString消息 ID。
reactionCntNumber该消息下所有回应的总数量。
reactionInfoArray回应摘要列表，最多 50 个。

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,
  "reaction": [
    {
      "msgUID": "AAAA-****-****-AAAA",
      "reactionCnt": 200,
      "reactionInfo": [
        {
          "reactionId": "THUMBSUP",
          "userCnt": 100,
          "userInfo": [
            {
              "userId": "user****01",
              "reactionTime": 1678886400000
            },
            {
              "userId": "user****02",
              "reactionTime": 1678886410000
            }
          ]
        },
        {
          "reactionId": "HEART",
          "userCnt": 100,
          "userInfo": [
            {
              "userId": "user****03",
              "reactionTime": 1678886420000
            }
          ]
        }
      ]
    },
    {
      "msgUID": "BBBB-****-****-BBBB",
      "reactionCnt": 50,
      "reactionInfo": [
        {
          "reactionId": "SMILE",
          "userCnt": 50,
          "userInfo": [
            {
              "userId": "user****04",
              "reactionTime": 1678886430000
            }
          ]
        }
      ]
    }
  ]
}