获取历史消息

功能简介

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

前提条件

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

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

获取全量历史消息

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

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

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

调用接口示例

ZIMMessageQueryConfig *config = [[ZIMMessageQueryConfig alloc] init];
config.count = 20;
config.reverse = true;
[zim queryHistoryMessageByConversationID:conversationID conversationType:conversationType config:config callback:^(NSArray<ZIMMessage *> * _Nonnull messageList, ZIMError * _Nonnull errorInfo) {
    //在此编写获取消息后的业务逻辑
}];

参数说明

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

示例代码

// 1、创建 ZIM 对象，传入 appID、appSign
ZIMAppConfig *appConfig = [[ZIMAppConfig alloc] init];
appConfig.appID = (unsigned int)appID;     //替换为您申请到的 AppID
appConfig.appSign = @"appSign";     //替换为您申请到的 AppSign
self.zim = [ZIM createWithAppConfig: appConfig];

// 2、登录
ZIMUserInfo *userInfo = [[ZIMUserInfo alloc] init];
userInfo.userID = @"xxxx";
userInfo.userName = @"xxxx";
[self.zim loginWithUserInfo:userInfo callback:^(ZIMError * _Nonnull errorInfo){
    // 开发者可根据 ZIMError 来判断是否登录成功。
}];

// 3、获取单聊会话历史消息
NSString *conversationID = @"xxxx";

// 从后往前获取会话历史消息，每次获取 20 条

ZIMMessageQueryConfig *config = [[ZIMMessageQueryConfig alloc] init];
config.count = 20;
config.reverse = true;
// 首次获取时 nextMessage 为 null
config.nextMessage = nil

[zim queryHistoryMessageByConversationID:conversationID conversationType:conversationType config:config callback:^(NSArray<ZIMMessage *> * _Nonnull messageList, ZIMError * _Nonnull errorInfo) {
    // 开发者可以通过该回调监听获取获取到消息列表。
    // 手指往下滑动到屏幕最上方一条消息时，获取更早的消息
    //保存最前的一条消息作为消息的锚点
    if (fetchMore) {
        // 后续分页获取时，nextMessage 为当前获取到的消息列表的第一条消息
        config.nextMessage = messageList[0];
        // 递归调用获取函数
    }
}];

获取指定消息列表

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

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

NSArray<NSNumber *> messageSeqs = @[]; // 最大长度为 10，

NSString *conversationID = @"YOUR_CONVERSATION_ID";
ZIMConversationType conversationType = ZIMConversationTypePeer; // 会话类型，取值为 单聊：ZIMConversationTypePeer，群组：ZIMConversationTypeGroup

[[ZIM getInstance] queryMessagesByMessageSeqs:messageSeqs conversationID:conversationID conversationType:conversationType callback:^(NSString * _Nonnull conversationID, ZIMConversationType conversationType, NSArray<ZIMMessage *> * _Nonnull messageList, ZIMError * _Nonnull errorInfo) {
    if(errorInfo.code == ZIMErrorCodeSuccess) {
        // 查询成功
    } else {
        // 查询失败
    }
}];