分页查询历史消息
更新时间: 2025/11/28 10:24:27
该接口可以分页查询指定账号在指定时间范围内的历史消息(包括单聊消息,高级群消息和超大群消息)。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
GET https://{endpoint}/im/v2.1/conversations/{conversation_id}/messages
请求 URL 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。
请求头参数
请求 Header 的参数说明请参考 请求 Header。
路径参数
| 参数名称 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
conversation_id |
String | 是 | 会话 ID。会话 ID 需要用户自行拼装,拼装规则:owner_id|conversation_type|other_id 或 owner_id|conversation_type|team_id
|
单聊会话:Accid1|1|Accid2高级群会话: Accid1|2|tid超大群会话: Accid1|3|tid |
查询参数
| 参数名称 | 类型 | 是否必选 | 说明 |
|---|---|---|---|
begin_time |
Long | 是 | 查询开始时间(毫秒)。 |
end_time |
Long | 是 | 查询截止时间(毫秒)。 |
page_token |
String | 否 | 分页标识符,如果为空,则从第一页开始查询。 |
limit |
Integer | 是 | 每页返回的消息数上限,最大为 100。小于等于 0,或者大于 100,会报 414 错误。 |
descending |
Boolean | 否 | 是否按时间正序,true:按时间正序;false:按时间倒序。 |
message_type |
String | 否 | 指定需要查询的消息类型,可指定多个消息类型,类型之间用","分割。不设置该参数则查询全部类型。 例如"0,1,2,3",其中支持的消息类型如下:0:文本;1:图片;2:语音;3:视频;4:地理位置;6:文件;10:提示;12:音视频话单;100:自定义。 |
check_team_valid |
Boolean | 否 | 检查高级群是否存在以及查询账号是否为有效的高级群成员。默认为 true(检查),若设置为 false,则只检查高级群是否存在,不检查查询账号是否为群成员。 |
include_no_sense_msg |
Boolean | 否 | 查询结果中是否需要包含无感知消息,默认为 false(不包含)。 无感知消息具体包括: |
响应信息
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体参数
| 参数名称 | 类型 | 说明 | 是否必返回 |
|---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
-
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
has_more |
Boolean | 是否还有更多数据。 | 是 |
next_token |
String | 分页标识符。 | 否 |
-
items |
Array of objects | 返回的历史消息。 | 是 |
message_server_id |
Long | 服务端消息 ID。 | 是 |
sender_id |
String | 消息发送方账号 ID。 | 是 |
message_type |
Integer | 消息类型。0:文本;1:图片;2:语音;3:视频;4:地址位置;6:文件;10:提示;12:音视频话单;100:自定义。 | 是 |
create_time |
Long | 消息发送时间戳。 | 是 |
message_client_id |
String | 客户端消息 ID。 | 是 |
sender_client_type |
Integer | 消息发送端类型。1:AOS;2:iOS;4:PC;16:Web;32:REST;64:MAC;65:HARMONY。 | 是 |
conversation_type |
Integer | 会话类型。1:单聊,2:高级群,3:超大群。 | 是 |
text |
String | 文本消息内容或多媒体消息的描述文本(该描述信息可用于云端历史消息关键词检索)。 | 否 |
attachment |
Object | 多媒体消息的属性或自定义消息内容。 | 否 |
extension |
String | 消息发送时传入的第三方扩展字段。 | 否 |
team_id |
Long | 群组 ID。team_id 与 receiver_id 只会返回一个。 |
否 |
receiver_id |
String | 消息的接收者 ID。 | 否 |
sub_type |
Integer | 消息子类型。用于对消息进行二级分类,取值范围为大于 0 的正整数。推荐自定义消息类型使用此字段区分不同业务场景,其他消息类型可根据实际需求选择性使用。 | 否 |
modify_account_id |
String | 消息更新者的用户账号 ID。 只有消息被更新才会返回该字段。 |
否 |
modify_time |
Long | 消息的更新时间。 只有消息被更新才会返回该字段。 |
否 |
receiver_account_ids |
Array of strings | 定向消息接收者账号 ID 列表。 | 否 |
inclusive |
Boolean | 定向消息接收者列表是为可读列表。true(默认):可读;false:不可读。 | 否 |
new_member_visible |
Boolean | 新进群成员是否可查看该消息。true:可查看;false:不可查看。 | 否 |
-
thread_config |
Object | Thread 消息配置项。 | 否 |
-
thread_root |
Object | Thread 根消息对象。 | 否 |
sender_id |
String | 根消息的发送者。 | 否 |
receiver_id |
String | 根消息的接收者。 | 否 |
create_time |
Long | 根消息的发送时间。 | 否 |
message_server_id |
Long | 根消息的服务器消息 ID。 | 否 |
message_client_id |
String | 根消息的客户端消息 ID。 | 否 |
-
thread_reply |
Object | 被回复的消息对象。 | 否 |
sender_id |
String | 被回复消息的发送者。 | 否 |
receiver_id |
String | 被回复消息的接收者。 | 否 |
create_time |
Long | 被回复消息的发送时间。 | 否 |
message_server_id |
Long | 被回复消息的服务器消息 ID。 | 否 |
message_client_id |
String | 被回复消息的客户端消息 ID。 | 否 |
响应体示例
JSON{
"code": 200,
"msg": "success",
"data": {
"has_more": false,
"items": [
{
"text": "更新消息内容2025-07-22T13:58:01",
"extension": "更新消息扩展字段2025-07-22T13:58:01",
"message_server_id": 2987378909999267843,
"sender_id": "test1",
"message_client_id": "2556fb03-8***c80aa86584",
"conversation_type": 2,
"team_id": 44515414685,
"create_time": 1753163876007,
"message_type": 0,
"sub_type": 1,
"modify_account_id": "test1",
"modify_time": 1753163882391,
"thread_config": {
"thread_root": {
"sender_id": "test",
"receiver_id": "44515414685",
"create_time": 1753163870827,
"message_server_id": 2987378909999267842,
"message_client_id": "a8c7a***c0d4a42000"
},
"thread_reply": {
"sender_id": "test",
"receiver_id": "44515414685",
"create_time": 1753163870827,
"message_server_id": 2987378909999267842,
"message_client_id": "a8c7a***c0d4a42000"
}
},
"sender_client_type": 1
}
]
}
}
错误码
本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码。
| 错误码 | 错误码描述 | 错误信息示例 |
|---|---|---|
| 200 | 请求成功 | success |
| 414 | 参数错误 | parameter error |
| 102404 | 用户不存在 | account not exist |
| 108404 | 群不存在 | team not exist |
| 108302 | 非高级群 | not advanced team |
| 109404 | 群成员不存在 | team member not exist |
| 500 | 服务器内部错误 | internal server error |
此文档是否对你有帮助?





