根据消息 ID 查询历史消息

更新时间: 2025/11/28 10:24:27

该接口可以根据消息 ID 批量查询历史消息(包括单聊消息,高级群消息和超大群消息)。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求信息

请求 URL

POST https://{endpoint}/im/v2.1/conversations/{conversation_id}/batch_messages

请求 URL 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header

路径参数

参数名称 类型 是否必选 说明 示例
conversation_id String 会话 ID。会话 ID 需要用户自行拼装,拼装规则:
owner_id|conversation_type|other_idowner_id|conversation_type|team_id
  • owner_id:操作者账号 ID
  • conversation_type:会话类型,1:单聊会话;2:高级群会话;3:超大群会话
  • other_id:对方账号 ID(单聊对话)
  • team_id:群组 ID(群组会话)
单聊会话:Accid1|1|Accid2
高级群会话:Accid1|2|tid
超大群会话:Accid1|3|tid

请求体参数

参数名称 类型 是否必选 说明
- messages Array of objects 需要查询的消息对象。
message_server_id Long 消息的服务器 ID。
create_time Long 消息的发送时间(毫秒)。

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header

响应体参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
- failed_list Array of objects 查询失败的消息列表。
message_server_id Long 服务端消息 ID。
create_time Long 消息发送时间戳。
error_code Long 错误码。
error_msg String 错误信息。
- success_list Array of objects 查询到的消息列表。
message_server_id Long 服务端消息 ID。
conversation_type Integer 会话类型。1:单聊;2:高级群;3:超大群。
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。
text String 文本消息内容或多媒体消息的描述文本(该描述信息可用于云端历史消息关键词检索)。
attachment Object 多媒体消息的属性或自定义消息内容。
extension String 消息发送时传入的第三方扩展字段。
team_id Long 群组 ID。team_idreceiver_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": {
        "success_list": [{
            "text": "{\"msg\":\"2025-07-31T16:50:03.534文本消息测试-单聊-检索检索8s4\"}",
            "extension": "ext",
            "message_server_id": 158844553334358020,
            "sender_id": "test36",
            "message_client_id": "7cdb4***3639c7",
            "conversation_type": 2,
            "team_id": 2366968294,
            "create_time": 1753951805248,
            "message_type": 0,
            "sub_type": 1,
            "receiver_account_ids": [
                "test69"
            ],
            "inclusive": true,
            "new_member_visible": false,
            "modify_account_id": "test36",
            "modify_time": 1753951811315,
            "thread_config": {
                "thread_root": {
                    "sender_id": "test36",
                    "receiver_id": "2366968294",
                    "create_time": 1753951803793,
                    "message_server_id": 158844553334358018,
                    "message_client_id": "63293886***02596b183"
                },
                "thread_reply": {
                    "sender_id": "test36",
                    "receiver_id": "2366968294",
                    "create_time": 1753951803793,
                    "message_server_id": 158844553334358018,
                    "message_client_id": "632938***02596b183"
                }
            },
            "sender_client_type": 32
        }],
        "failed_list": []
    }
}

错误码

本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
102404 用户不存在 account not exist
108404 群不存在 team not exist
500 服务器内部错误 internal server error
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求信息
  • 请求 URL
  • 请求头参数
  • 路径参数
  • 请求体参数
  • 响应信息
  • 响应头参数
  • 响应体参数
  • 响应体示例
  • 错误码