获取历史消息

功能简介

ZIM SDK 支持按照会话维度，获取某个会话下的所有历史消息或指定消息。本文档介绍了如何使用 ZIM SDK 的接口，实现获取 单聊 历史消息、群组 历史消息和 房间 历史消息的功能。

前提条件

在实现“获取历史消息”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID 和 ServerSecret。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考 项目管理 - 即时通讯），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已获取登录 SDK 所需的 Token，详情请参考 使用 Token 鉴权。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “3 集成 SDK”。

获取历史消息

用户登录 ZIM SDK 后，即可通过 queryHistoryMessage 接口，传入参数 conversationID、config，获取 单聊、群组 和 房间 的会话历史记录。

以客户端 A 获取与客户端 B 的单聊会话历史为例：

1. 客户端 A、B 登录 ZIM SDK，并相互发送、接收单聊消息。
2. 客户端 A 需要获取与 B 的会话记录时：
   1. 客户端 A 首先登录 ZIM SDK。
   2. 客户端 A 调用 queryHistoryMessage 接口，传入参数 conversationID、config，开始获取。
   3. 获取的结果，将通过 ZIMMessageQueriedResult 回调接口通知给客户端 A。

调用接口示例

queryHistoryMessage(
    conversationID: string,
    conversationType: ZIMConversationType,
    config: ZIMMessageQueryConfig,
): Promise<ZIMMessageQueriedResult>

参数说明

参数 config，需要通过 ZIMMessageQueryConfig 类的以下参数进行配置：

示例代码

// 获取单聊会话历史消息
var curMessageList = [];

var conversationID = '';
var conversationType = 0;
// 从后往前获取会话历史消息，每次获取 30 条
var config = {
    nextMessage: null, // 首次获取时 nextMessage 为 null
    count: 30,
    reverse: true
}

function queryMessageCallback({ messageList }) {
    curMessageList.push(...messageList);

    // 手指往下滑动到屏幕最上方一条消息时，获取更早的消息
    if (fetchMore && messageList.length > 0) {
        // 后续分页获取时，nextMessage 为当前获取到的消息列表的第一条消息
        config.nextMessage = messageList[0];
        zim.queryHistoryMessage(conversationID, conversationType, config).then(queryMessageCallback);
    }
}

zim.queryHistoryMessage(conversationID, conversationType, config).then(queryMessageCallback);

获取指定消息列表

ZIM 支持根据传入的 messageSeq（消息在会话中的序号）列表（最大为 10 个），调用 queryMessages 即可查询单聊或群聊会话内对应的消息。

本接口适用于仅知道某条消息的 messageSeq 而不知道该消息的完整结构。例如，会话中有一条消息回复了某条历史消息，会话成员可以通过该条回复的 repliedInfo.messageSeq 获取该历史消息的 messageSeq，此时即可调用本接口获取该历史消息的完整结构。

var messageSeqs = []; // 最大长度为 10

var conversationID = '';
var conversationType = 0; // 会话类型，取值为 单聊：0，群组：2

zim.queryMessages(messageSeqs, conversationID, conversationType)
    .then(({ messageList }) => {
        // 查询成功
    })
    .catch((err) => {
        // 查询失败
    });