在线调试

分页查询历史消息

更新时间: 2025/11/13 17:10:29

该接口已废弃,如需分页查询历史消息请参考新的 分页查询历史消息 API。

该接口可以分页查询指定账号在指定时间范围内的历史消息(包括单聊消息,高级群消息和超大群消息)。

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2/conversations/{conversation_id}/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

查询参数

参数名称 类型 是否必选 说明
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:地理位置;5:通知;6:文件;10:提示;11:Robot;100:自定义。
check_team_valid Boolean 检查高级群是否存在以及查询账号是否为有效的高级群成员。默认为 true(检查),若设置为 false,则只检查高级群是否存在,不检查查询账号是否为群成员。该参数仅对高级群消息生效,对超大群无效。
include_no_sense_msg Boolean 查询结果中是否需要包含无感知消息,默认为 false(不包含)。
无感知消息具体包括:
  • 发送消息时,被设置为发送方无感知的消息(即 msgSenderNoSense = 0)。
  • 发消息时,被设置为接收方无感知的消息(即 msgReceiverNoSense = 1)。
  • 被单向撤回的消息。
  • 被单向删除的消息。
  • 响应信息

    响应头参数

    响应 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:地址位置;5:通知;6:文件;10:提示;11:机器人;100:自定义。
    create_time Long 消息发送时间戳。
    message_client_id String 客户端消息 ID。
    sender_client_type Integer 消息发送端类型。1:Android;2:iOS;4:PC;16:Web;32:REST;64:MAC。
    text String 文本消息内容或多媒体消息的描述文本(该描述信息可用于云端历史消息关键词检索)。
    attachment Object 多媒体消息的属性或自定义消息内容。
    extension String 消息发送时传入的第三方扩展字段。
    team_id Long 群组 ID。team_idreceiver_id 只会返回一个。
    receiver_id String 消息的接收者 ID。
    sub_type Integer 自定义消息子类型,大于 0。message_type = 100 时该字段才有效。
    modify_account_id String 消息更新者的用户账号 ID。
    只有消息被更新才会返回该字段。
    modify_time Long 消息的更新时间。
    只有消息被更新才会返回该字段。
    - thread_config Object Thread 消息配置项。
    - thread_root Object Thread 根消息对象。
    sender_id String 根消息的发送者。
    receiver_id String 根消息的接收者。
    create_time Long 根消息的发送时间。
    message_server_id String 根消息的服务器消息 ID。
    message_client_id String 根消息的客户端消息 ID。
    - thread_reply Object 被回复的消息对象。
    sender_id String 被回复消息的发送者。
    receiver_id String 被回复消息的接收者。
    create_time Long 被回复消息的发送时间。
    message_server_id String 被回复消息的服务器消息 ID。
    message_client_id String 被回复消息的客户端消息 ID。

    响应体示例

    JSON{
        "code": 200,
        "msg": "success",
        "data": {
            "has_more": true,
            "next_token": "MTY5MjE5MTY3MjgyN3wxNTg0MDM3NzU=",
            "items": [
                {
                    "text": "{\"msg\":\"30l7mgx1elkf9xi9g7wqc0ry4av43gawqgkecl4f9p46us6kzi\"}",
                    "message_server_id": 167595237,
                    "message_client_id": "80227c89-3374-4258-97bd-424db19d5360",
                    "sender_id": "wmtest2",
                    "create_time": 1695362207119,
                    "message_type": 0,
                    "sender_client_type": "32"
                }
            ]
        }
    }
    

    错误码

    本文仅列举部分业务接口错误码,完整列表请参考客户端 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
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 调用频率
    • 请求信息
    • 请求 URL
    • 请求头参数
    • 路径参数
    • 查询参数
    • 响应信息
    • 响应头参数
    • 响应体参数
    • 响应体示例
    • 错误码