公告：融云新文档中心已上线，欢迎到新文档中心阅读 IM 服务端文档。
搜索超级群消息
更新时间:2024-02-06
PDF
即时通讯服务端默认保存 7 天内 App 下超级群所有会话频道的历史消息记录。您可以使用服务端 API 主动获取指定时段内的频道历史消息。支持仅查询由指定用户 ID 发送的消息。
该接口一般由超级群 App 运营方使用，可用于实现后台搜索消息。具体可用于查询：
- 指定时段内超级群频道中的消息
- App 的指定用户发送的消息
即时通讯服务同时提供服务端回调服务，支持将消息副本实时抄送给您指定的应用服务器。开通及配置方式详见详见全量消息路由。
可查询范围
- 时间范围：API 接口支持获取最大时间跨度不超过 14 天的频道的消息。开通超级群业务后，超级群消息云端存储默认设置为 7 天，即仅保存 7 天的历史消息存储。支持付费开通为 3 个月、6 个月、 1 年。如何调整保存时长详见开通超级群服务。
- 频道类型：API 接口支持查询公有频道和私有频道的历史消息。公有频道指 App 自建频道和超级群服务默认的
RCDefault频道。API 不对查询私有频道历史消息作额外限制，App 后端可能需要自行区分频道类型。关于私有频道的更多说明请参见私有频道概述。 - 限制条件：超级群业务从 2022.10.13 日开始提供 ID 为
RCDefault的默认频道。在此之前开通超级群业务的 App/环境中不存在RCDefault频道。即时通讯服务支持客户调整服务至最新行为。该行为调整将影响客户端、服务端收发消息、获取会话、清除历史消息、禁言等多个功能。如有需要，请提交工单咨询详细方案。如果在调用客户端、服务端 API 发送消息时不指定频道 ID，消息不属于任何频道，无法通过此 API 查询。
方法说明
POST： https://数据中心域名/ultragroup/hismsg/query.json
频率限制： 每分钟限 100 次
签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| groupId | String | 是 | 超级群 ID，请确保该超级群 ID 已存在。 |
| busChannel | String | 是 | 频道 ID。 |
| startTime | Number | 是 | 查询开始时间。Unix 时间戳（毫秒）。 |
| endTime | Number | 是 | 查询结束时间。Unix 时间戳（毫秒）。需要保证比 startTime 大，且两者之间时间跨度最大14 天。 |
| fromUserId | String | 否 | 发送者用户 ID。不传该字段，查所有用户发送的历史消息。如果传入该参数，表示只查该用户 ID 发的历史消息。 |
| pageSize | Number | 否 | 分页返回的页面大小。默认 20 条，最大 100 条。 |
请求示例
POST /ultragroup/hismsg/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
groupId=wxlGroup&busChannel=wxlBusChannel&startTime=1666251303434&endTime=1666251311996&fromUserId=123&pageSize=10
已复制
1
2
3
4
5
6
7
8
9
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象：
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Number | 返回码，200 为正常。 |
| data | Array of objects | 查询结果。按消息时间戳升序排列。 |
| data[i].groupId | String | 超级群 ID。 |
| data[i].busChannel | String | 超级群频道 ID。 |
| data[i].fromUserId | String | 消息发送方用户 ID。 |
| data[i].msgUID | String | 消息 UID。 |
| data[i].msgTime | Number | 发送消息的时间戳。Unix 时间戳（毫秒）。 |
| data[i].objectName | String | 消息类型。详见消息类型概述。 |
| data[i].conversationType | Number | 会话类型。超级群的会话类型为 10。 |
| data[i].content | String | 消息内容，JSON 格式。具体结构可通过 objectName 字段在 消息类型概述 中查询。 |
| data[i].expansion | Boolean | 消息是否已被设置为可扩展消息。true 表示可扩展。false 表示不可扩展。 |
| data[i].extraContent | String | 消息扩展的内容，JSON 结构的 Key、Value 对，如："{\"key1\":{\"v\":\"value\",\"ts\":110908544521}}"。Key 最大 32 个字符，支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式，不支持汉字。Value 最大 4096 个字符。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 200,
"data": [
{
"groupId": "wxlGroup",
"busChannel": "wxlBusChannel",
"fromUserId": "123",
"msgUID": "C3UH-8KMU-O038-22SK",
"msgTime": 1666251311995,
"objectName": "RC:TxtMsg",
"conversionType": 10,
"content": "{\"content\":\"abce\"}",
"expansion": false,
"extraContent": ""
},
{
"groupId": "wxlGroup",
"busChannel": "wxlBusChannel",
"fromUserId": "123",
"msgUID": "C3UH-8IK2-G018-22SK",
"msgTime": 1666251303434,
"objectName": "RC:TxtMsg",
"conversionType": 10,
"content": "{\"content\":\"abc\"}",
"expansion": false,
"extraContent": ""
}
]
}
已复制
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
131 6185 6839