提交工单
咨询集成、功能及报价等问题
ZIM SDK 支持按照会话维度,获取某个会话下的所有历史消息或指定消息。本文档介绍了如何使用 ZIM SDK 的接口,实现获取 单聊
历史消息、群组
历史消息和 房间
历史消息的功能。
在实现“获取历史消息”功能之前,请确保:
用户登录 ZIM SDK 后,即可通过 queryHistoryMessage 接口,传入参数 conversationID、config,获取 单聊
、群组
和 房间
的会话历史记录。
以客户端 A 获取与客户端 B 的单聊会话历史为例:
ZIMMessageQueryConfig config;
config.count = 20;
config.reverse = true;
zim_->queryHistoryMessage("conversationID",zim::ZIMConversationTypePeer,config,callback);
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
conversationID | String | 是 | 会话 ID。
|
conversationType | ZIMConversationType | 是 | 会话类型。
请注意,“房间”场景下,默认不支持离线消息的缓存、获取。如您有需要,请联系 ZEGO 技术支持处理。 |
config | ZIMMessageQueryConfig | 是 | 获取历史消息的高级属性设置,具体请参考下表。 |
callback | ZIMMessageQueriedCallback | 是 | 获取历史消息操作的结果回调。 |
参数 config
,需要通过 ZIMMessageQueryConfig 类的以下参数进行配置:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
nextMessage |
是 |
分页查询消息时的锚点,即指查询到的是 nextMessage 之后或之前的消息列表,“之后”或“之前”由 reverse 值决定。
|
|
messageCount |
Number |
是 |
查询一次,可获取的消息数量。 每次查询的消息数量,建议小于 100 条,以降低开销。 |
reverse |
Boolean |
是 |
查询消息时:
|
// 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);
ZIM 支持根据传入的 messageSeq
(消息在会话中的序号)列表(最大为 10 个),调用 queryMessages 即可查询单聊或群聊会话内对应的消息。
本接口适用于仅知道某条消息的 messageSeq
而不知道该消息的完整结构。例如,会话中有一条消息回复了某条历史消息,会话成员可以通过该条回复的 repliedInfo.messageSeq 获取该历史消息的 messageSeq
,此时即可调用本接口获取该历史消息的完整结构。
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 {
// 查询失败
}
});
联系我们
文档反馈