获取历史消息
功能简介
ZIM SDK 支持按照会话维度,获取某个会话下的所有历史消息或指定消息。本文档介绍了如何使用 ZIM SDK 的接口,实现获取 单聊
历史消息、群组
历史消息和 房间
历史消息的功能。
获取全量历史消息
用户登录 ZIM SDK 后,即可通过 queryHistoryMessage 接口,传入参数 conversationID、config,获取 单聊
、群组
和 房间
的会话历史记录。
以客户端 A 获取与客户端 B 的单聊会话历史为例:
- 客户端 A、B 登录 ZIM SDK,并相互发送、接收单聊消息。
- 客户端 A 需要获取与 B 的会话记录时:
- 客户端 A 首先登录 ZIM SDK。
- 客户端 A 调用 queryHistoryMessage 接口,传入参数 conversationID、config,开始获取。
- 获取的结果,将通过 ZIMMessageQueriedCallback 回调接口通知给客户端 A。
示例代码
// 1、创建 ZIM 对象,传入 appID、appSign,目前仅建议一个客户端创建一个zim实例
zim::ZIMAppConfig app_config;
app_config.appID = 12345; // 替换为您申请到的 AppID
app_config.appSign = "appSign"; //替换为您申请到的 AppSign
zim_ = zim::ZIM::create(app_config);
// 2、设置 setEventHandler 回调
im_event_handler_ = std::make_shared<CZIMEventHandler>();
zim_->setEventHandler(im_event_handler_);
// 3、登录
zim::ZIMUserInfo user_info;
user_info.userID = user_id;
user_info.userName = user_name;
zim_->login(user_info, [=](zim::ZIMError errorInfo){
// 这里可以获取登录结果返回值,并根据错误码执行用户代码
});
// 4、获取单聊会话历史消息
std::string conversationID = "xxxx";
// 从后往前获取会话历史消息,每次获取 20 条
zim::ZIMTextMessage *message = nullptr;
zim::ZIMMessageQueryConfig config;
config.count = 20;
config.reverse = true;
zim_->queryHistoryMessage(conversationID,zim::ZIMConversationTypePeer,config,callback);
1
获取指定消息列表
ZIM 支持根据传入的 messageSeq
(消息在会话中的序号)列表(最大为 10 个),调用 queryMessages 即可查询单聊或群聊会话内对应的消息。
本接口适用于仅知道某条消息的 messageSeq
而不知道该消息的完整结构。例如,会话中有一条消息回复了某条历史消息,会话成员可以通过该条回复的 repliedInfo.messageSeq 获取该历史消息的 messageSeq
,此时即可调用本接口获取该历史消息的完整结构。
Untitled
std::vector<long long> messageSeqs; // 最大长度为 10,
std::string conversationID = "YOUR_CONVERSATION_ID";
ZIMConversationType conversationType = ZIM_CONVERSATION_TYPE_PEER; // 会话类型,取值为 单聊:ZIM_CONVERSATION_TYPE_PEER,群组:ZIM_CONVERSATION_TYPE_GROUP
ZIM::getInstance()->queryMessages(messageSeqs, conversationID, conversationType, [=](const std::string &conversationID, ZIMConversationType conversationType, const std::vector<std::shared_ptr<ZIMMessage>> &messageList, const ZIMError &errorInfo) {
if(errorInfo.code == ZIM_ERROR_CODE_SUCCESS) {
// 查询成功
} else {
// 查询失败
}
});
1