跳到主要内容

查询群聊历史消息

您可以使用服务端 API 主动获取指定时段内的群聊会话历史消息。

该接口一般由 App 运营方使用，可用于实现后台搜索消息。

开通服务​

调用此接口前，您须：

提示

融云即时通讯（IM）服务同时提供服务端回调服务，支持将消息副本实时抄送给您指定的应用服务器。开通及配置方式详见详见全量消息路由。

可查询范围​

  • 时间范围：API 接口支持获取最大时间跨度不超过 14 天的历史消息
  • 查询顺序：按消息时间戳降序排列

方法说明​

POST： https://数据中心域名/v3/message/group/query.json

频率限制： 每秒限 10 次

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

正文参数​

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

参数类型必传说明
userIdString否查询用户 ID。
targetIdString是群 ID。
startTimeNumber是查询开始时间。Unix 时间戳（毫秒）。
endTimeNumber是查询结束时间。Unix 时间戳（毫秒）。需要保证比 startTime 小，且两者之间时间跨度最大14 天。
pageSizeNumber否查询条数； 范围: 1-100; 默认 10，如查询时间内小于输入的消息条数时，以查询时间范围为准。
includeStartBoolean是是否包含开始时间的消息，true 包含、false 不包含。

请求示例​

HTTP
POST /v3/message/group/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "userId": "userId1",
    "targetId": "groupId1",
    "startTime": 123,
    "endTime": 30,
    "pageSize": 10,
    "includeStart": true
}

返回结果​

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

返回值返回类型说明
codeNumber返回码，200 为正常。
dataArray of objects查询结果。按消息时间戳降序排列。
data[i].targetIdString会话 ID。
data[i].fromUserIdString消息发送方用户 ID。
data[i].msgUIDString消息 UID。
data[i].msgTimeNumber发送消息的时间戳。Unix 时间戳（毫秒）。
data[i].objectNameString消息类型。详见消息类型概述。
data[i].contentString消息内容，JSON 格式。具体结构可通过 objectName 字段在 消息类型概述 中查询。
data[i].expansionBoolean消息是否已被设置为可扩展消息。true 表示可扩展。false 表示不可扩展。
data[i].extraContentString消息扩展的内容，JSON 结构的 Key、Value 对，如："{\"key1\":{\"v\":\"value\",\"ts\":110908544521}}"。Key 最大 32 个字符，支持大小写英文字母、数字、 特殊字符 + = - _ 的组合方式，不支持汉字。Value 最大 4096 个字符。

返回结果示例​

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

{
    "code": 200,
    "data": [
        {
            "targetId": "groupId1",
            "fromUserId": "userId1",
            "msgUID": "C3UH-8KMU-O038-22SK",
            "msgTime": 1666251311995,
            "objectName": "RC:TxtMsg",
            "content": "{\"content\":\"abce\"}",
            "expansion": false,
            "extraContent": ""
        },
        {
            "targetId": "groupId1",
            "fromUserId": "userId1",
            "msgUID": "C3UH-8IK2-G018-22SK",
            "msgTime": 1666251303434,
            "objectName": "RC:TxtMsg",
            "content": "{\"content\":\"abc\"}",
            "expansion": false,
            "extraContent": ""
        }
    ]
}