获取历史消息
功能简介
开发者可以使用 ZIM 接口查询某个单聊、群组或房间会话下的所有历史消息或指定消息。在查询过程中,ZIM SDK 会优先从本地数据库缓存中检索消息;当本地缓存不完整时,SDK 会自动向 ZIM 服务端发起查询请求。
本文档将详细介绍如何使用 ZIM SDK 的接口实现获取单聊、群组和房间历史消息的功能。
获取全量历史消息
用户登录 ZIM SDK 后,即可通过 queryHistoryMessage 接口,传入参数 conversationID、config,获取 单聊
、群组
和 房间
的会话历史记录。
以客户端 A 获取与客户端 B 的单聊会话历史为例:

- 客户端 A、B 登录 ZIM SDK,并相互发送、接收单聊消息。
- 客户端 A 需要获取与 B 的会话记录时:
- 客户端 A 首先登录 ZIM SDK。
- 客户端 A 调用 queryHistoryMessage 接口,传入参数 conversationID、config,开始获取。
- 获取的结果,将通过 ZIMMessageQueriedResult 回调接口通知给客户端 A。
// 获取单聊会话历史消息
const curMessageList: ZIMMessage[] = [];
const conversationID = '';
const conversationType = 0;
// 从后往前获取会话历史消息,每次获取 30 条
const config: ZIMMessageQueryConfig = {
nextMessage: null, // 首次获取时 nextMessage 为 null
count: 30,
reverse: true
}
const queryMessageCallback = (res: ZIMMessageQueriedResult) => {
const messageList = res.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
,此时即可调用本接口获取该历史消息的完整结构。
const messageSeqs = [1]; // 最大长度为 10
const conversationID = '';
const conversationType = 0; // 会话类型,取值为 单聊:0,群组:2
zim.queryMessages(messageSeqs, conversationID, conversationType)
.then((res: ZIMMessageQueriedResult) => {
// 查询成功
})
.catch((err: ZIMError) => {
// 查询失败
});