Interface

2026-01-21


errorInfo	ZIM
ZIMDefines

ZIM

方法

ZIMCombineMessageDetailQueriedCallback

public ZIMCombineMessageDetailQueriedCallback

查询合并消息详情的结果回调。

参数

名称	类型	描述
message	const ZIMCombineMessage&	携带完整合并转发消息列表的合并消息。
errorInfo	const ZIMError &	错误信息，包含错误码和错误详细信息。

详情

查询合并消息详情的结果回调。

ZIMMessageAttachedCallback

public ZIMMessageAttachedCallback

为传入的消息对象赋予 localMessgeID 并返回。

参数

名称	类型	描述
message	ZIMMessage	当前发送的消息对象。

详情

为传入的消息对象赋予 localMessgeID 并返回。

业务场景：在消息发送成功前，可以对应其消息 localMessageID，实现发送前 loading 的效果。
通知时机：发送消息后，消息发送成功前触发。

支持版本：2.4.0 及以上。

ZIMMultipleMediaUploadingProgress

public ZIMMultipleMediaUploadingProgress

发送组合消息的进度回调。

参数

名称	类型	描述
message	ZIMMultipleMessage	当前发送的消息对象。
currentFileSize	unsigned long long	当前总共已上传的大小。
totalFileSize	unsigned long long	待上传的总共的文件的大小。
messageInfoIndex	int	当前上传的文件所在数组的索引。
currentIndexFileSize	unsigned long long	当前上传的文件的已上传的大小。
totalIndexFileSize	unsigned long long	当前上传的文件的总的大小。

详情

发送组合消息的进度回调。

业务场景：开发者可以通过该回调获得组合消息里的媒体文件的上传进度。
通知时机：当开发者调用 [sendMessage] 接口时，会触发该回调，且在发送的过程中将会多次触发。
相关接口：通过 [sendMessage]，发送进度情况会通过本回调通知。

支持版本：2.19.0 及以上。

ZIMDefines

方法

ZIMBlacklistUsersAddedCallback

public ZIMBlacklistUsersAddedCallback

添加用户到黑名单的操作结果回调。

参数

名称	类型	描述
errorUserList	const std::vector<ZIMErrorUserInfo> &	拉黑失败的 userInfo 列表。
errorInfo	const ZIMError &	添加用户到黑名单返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

添加用户到黑名单的操作结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否添加到黑名单成功。
通知时机：当开发者调用 [addUsersToBlacklist] 接口时，会触发该回调。
相关接口：通过 [addUsersToBlacklist] 添加黑名单。

支持版本：2.13.0 及以上。

ZIMFriendAddedCallback

public ZIMFriendAddedCallback

添加好友结果回调。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	const ZIMError &	添加好友返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

添加好友的结果的返回。

业务场景：进行确添加好友操作后，成功与否可以通过该回调得知。
相关接口：[addFriend]，添加好友。

支持版本：2.13.0 及以上。

ZIMFriendAliasUpdatedCallback

public ZIMFriendAliasUpdatedCallback

更新好友备注的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	const ZIMError &	更新好友备注的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新好友备注的返回结果。

业务场景：进行更新好友备注操作后，成功与否可以通过该回调得知。
相关接口：[updateFriendAlias]，更新好友备注。

ZIMFriendApplicationAcceptedCallback

public ZIMFriendApplicationAcceptedCallback

接受好友申请的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	const ZIMError &	同意好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

接受好友申请的返回结果。

业务场景：进行接受好友申请操作后，成功与否可以通过该回调得知。
相关接口：[acceptFriendApplication]，接受好友申请。

ZIMFriendApplicationListQueriedCallback

public ZIMFriendApplicationListQueriedCallback

发起好友申请的返回结果。

参数

名称	类型	描述
applicationList	std::vector<ZIMFriendApplicationInfo> &	好友申请信息列表。
nextFlag	int	当前查询锚点下标。
errorInfo	const ZIMError &	查询好友申请列表错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行发起好友申请操作后，成功与否可以通过该回调得知。
相关接口：[sendFriendApplication]，发起好友申请。

支持版本：2.14.0 及以上。

ZIMFriendApplicationRejectedCallback

public ZIMFriendApplicationRejectedCallback

拒绝好友申请的返回结果。

参数

名称	类型	描述
userInfo	ZIMUserInfo	申请人用户信息。
errorInfo	const ZIMError &	同意好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

拒绝好友申请的返回结果。

业务场景：进行拒绝好友申请操作后，成功与否可以通过该回调得知。
相关接口：[rejectFriendApplication]，拒绝好友申请。

ZIMFriendApplicationSentCallback

public ZIMFriendApplicationSentCallback

发起好友申请的返回结果。

参数

名称	类型	描述
applicationInfo	ZIMFriendApplicationInfo	好友申请信息。
errorInfo	const ZIMError &	发起好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行发起好友申请操作后，成功与否可以通过该回调得知。
相关接口：[sendFriendApplication]，发起好友申请。

支持版本：2.14.0 及以上。

ZIMFriendAttributesUpdatedCallback

public ZIMFriendAttributesUpdatedCallback

更新好友属性的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	const ZIMError &	更新好友属性错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新好友属性的返回结果。

业务场景：进行更新好友属性操作后，成功与否可以通过该回调得知。
相关接口：[updateFriendAttributes]，更新好友属性。

ZIMFriendListQueriedCallback

public ZIMFriendListQueriedCallback

查询好友列表的返回结果。

参数

名称	类型	描述
friendList	std::vector<ZIMFriendInfo> &	查询好友列表的返回结果。
nextFlag	int	当前查询锚点下标。
errorInfo	const ZIMError &	查询好友列表返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询好友列表的返回结果。

业务场景：进行查询好友列表操作后，成功与否可以通过该回调得知。
相关接口：[queryFriendList]，查询好友列表。

ZIMFriendsDeletedCallback

public ZIMFriendsDeletedCallback

删除好友的返回结果。

参数

名称	类型	描述
errorUserList	const std::vector<ZIMErrorUserInfo> &	删除失败的用户id及原因列表。
errorInfo	const ZIMError &	添加用户到黑名单返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除好友的返回结果。

业务场景：进行删除好友操作后，成功与否可以通过该回调得知。
相关接口：[deleteFriends]，批量删除好友。

支持版本：2.14.0 及以上。

ZIMFriendsInfoQueriedCallback

public ZIMFriendsInfoQueriedCallback

批量查询好友信息的返回结果。

参数

名称	类型	描述
friendInfos	const std::vector<ZIMFriendInfo>&	好友信息。
errorUserList	const std::vector<ZIMErrorUserInfo> &	查询失败的用户id及原因。
errorInfo	const ZIMError &	发起好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

批量查询好友信息的返回结果。

业务场景：进行批量查询好友信息操作后，成功与否可以通过该回调得知。
相关接口：[queryFriendsInfo]，批量查询好友信息。

ZIMFriendsSearchedCallback

public ZIMFriendsSearchedCallback

搜索本地好友的返回结果。

参数

名称	类型	描述
friendInfos	std::vector<ZIMFriendInfo> &	好友信息列表。
nextFlag	int	当前查询锚点下标。
errorInfo	const ZIMError &	查询好友列表返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索本地好友的返回结果。

业务场景：进行本地好友搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalFriends]，搜索本地好友。

ZIMBlacklistUsersRemovedCallback

public ZIMBlacklistUsersRemovedCallback

移除用户出黑名单的操作结果回调。

参数

名称	类型	描述
errorUserList	const std::vector<ZIMErrorUserInfo> &	移除失败的 userInfo 列表。
errorInfo	const ZIMError &	黑名单删除的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

移除用户出黑名单的操作结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否添加到黑名单成功。
通知时机：当开发者调用 [removeUsersFromBlacklist] 接口时，会触发该回调。
相关接口：通过 [removeUsersFromBlacklist] 将用户移除出黑名单。

支持版本：2.13.0 及以上。

ZIMBlacklistQueriedCallback

public ZIMBlacklistQueriedCallback

查询黑名单结果回调。

参数

名称	类型	描述
blacklist	const std::vector<ZIMUserInfo> &	SDK 本地存储的黑名单数据。
nextFlag	unsigned int	详情描述：下一个标志。为 0 表示黑名单查询完毕。不为 0 时表示黑名单查询未完成，再次调用查询接口，传入此 nextFlag 即可继续查询。
errorInfo	const ZIMError &	查询的错误码。0 代表成功，非 0 为失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询黑名单结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否查询成功。
通知时机：当开发者调用 [queryBlacklist] 接口时，会触发该回调。
相关接口：通过 [queryBlacklist] 查询黑名单列表。

支持版本：2.13.0 及以上。

ZIMFriendsRelationCheckedCallback

public ZIMFriendsRelationCheckedCallback

检查好友关系的返回结果。

参数

名称	类型	描述
errorUserList	const std::vector<ZIMErrorUserInfo> &	检查好友关系失败的用户id及原因列表。
relationInfos	const std::vector<ZIMFriendRelationInfo> &	好友关系信息列表。
errorInfo	const ZIMError &	查询的错误码。0 代表成功，非 0 为失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行检查好友关系操作后，成功与否可以通过该回调得知。
相关接口：[checkFriendsRelation]，检查好友关系。

支持版本：2.14.0 及以上。

ZIMBlacklistCheckedCallback

public ZIMBlacklistCheckedCallback

黑名单检查结果回调。

参数

名称	类型	描述
isUserInBlacklist	bool	该用户是否在黑名单
errorInfo	const ZIMError &	黑名单检查返回的错误码。0 代表检查成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

黑名单检查结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否检查成功。
通知时机：当开发者调用 [checkUserIsInBlacklist] 接口时，会触发该回调。
相关接口：通过 [checkUserIsInBlacklist] 检查用户是否在黑名单。

支持版本：2.13.0 及以上。

ZIMSubscribedUserStatusListQueriedCallback

public ZIMSubscribedUserStatusListQueriedCallback

querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。

参数

名称	类型	描述
userStatusSubscriptionList	const std::vector< ZIMUserStatusSubscription > &	订阅列表中用户的订阅信息。

详情

querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。

ZIMUserCustomStatusUpdatedCallback

public ZIMUserCustomStatusUpdatedCallback

更新自定义状态的回调。

参数

名称	类型	描述
errorInfo	ZIMError	更新自定义状态的错误信息。
customStatus	String	自定义状态。

详情

更新自定义状态的回调。

ZIMUsersStatusQueriedCallback

public ZIMUsersStatusQueriedCallback

批量查询用户在线状态接口 queryUsersStatus 的结果回调。

参数

名称	类型	描述
userStatusList	const std::vector< ZIMUserStatus >&	被查询用户的在线状态信息列表。
errorUserList	const std::vector< ZIMErrorUserInfo >&	查询失败的用户列表。
errorInfo	const ZIMError &	查询操作的结果，包含错误码与错误信息。

详情

批量查询用户在线状态接口 queryUsersStatus 的结果回调。

ZIMUsersStatusSubscribedCallback

public ZIMUsersStatusSubscribedCallback

subscribeUsersStatus 批量订阅接口的操作结果回调。

参数

名称	类型	描述
errorUserList	const std::vector<ZIMErrorUserInfo> &	订阅失败的用户列表。
errorInfo	const ZIMError &	操作结果，包含错误码与错误信息。

详情

subscribeUsersStatus 批量订阅接口的操作结果回调。

ZIMUsersStatusUnsubscribedCallback

public ZIMUsersStatusUnsubscribedCallback

unsubscribeUsersStatus 批量取消订阅接口的操作回调。

参数

名称	类型	描述
errorUserList	const std::vector<std::string> &	取消失败的用户列表。
errorInfo	ZIMError	批量取消操作的结果，包含错误信息与错误码。

详情

unsubscribeUsersStatus 批量取消订阅接口的操作回调。

ZIMTokenRenewedCallback

public ZIMTokenRenewedCallback

更新 Token 的结果的回调。

参数

名称	类型	描述
token	const std::string &	需要更新的鉴权 Token。
errorInfo	ZIMError	错误信息。错误码值为 0 时更新成功，非 0 时更新失败。若出现返回非 0 错误码的时候，开发者应到官网错误码文档中查询解决方案。

详情

开发者更新 Token 后，执行结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否更新 Token 成功。
通知时机：当开发者调用 [renewToken] 接口时，会触发该回调。
相关接口：通过 [renewToken] 更新 Token，更新 Token 的成功与否会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMUsersInfoQueriedCallback

public ZIMUsersInfoQueriedCallback

查询 userInfo 的回调。

参数

名称	类型	描述
userList	const std::vector<ZIMUserFullInfo> &	查询到的 userInfo 列表。
errorUserList	const std::vector<ZIMErrorUserInfo> &	查询失败的 userInfo 列表。
errorInfo	const ZIMError &	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者查询用户信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否登录成功。
通知时机：当开发者调用 [queryUsersInfo] 接口时，会触发该回调。
相关接口：通过 [queryUsersInfo] 查询。

支持版本：2.2.0 及以上。

ZIMUserNameUpdatedCallback

public ZIMUserNameUpdatedCallback

更新 user name 的回调。

参数

名称	类型	描述
userName	std::string	更新后的 user name。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者更新用户名称后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserName] 接口时，会触发该回调。
相关接口：[updateUserName]。

支持版本：2.2.0 及以上。

ZIMUserAvatarUrlUpdatedCallback

public ZIMUserAvatarUrlUpdatedCallback

更新 user avatar URL 的回调。

参数

名称	类型	描述
userAvatarUrl	std::string	更新后的 user avatar URL。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者更新用户头像 URL 后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserAvatarUrl] 接口时，会触发该回调。
相关接口：[updateUserAvatarUrl] 。

支持版本：2.3.0 及以上。

ZIMUserExtendedDataUpdatedCallback

public ZIMUserExtendedDataUpdatedCallback

更新 user extended data 的回调。

参数

名称	类型	描述
extendedData	std::string	更新后的 user extended data。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者修改用户扩展信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserExtendedData] 接口时，会触发该回调。
相关接口：通过 [updateUserExtendedData] 查询。

支持版本：2.2.0 及以上。

ZIMLoggedInCallback

public ZIMLoggedInCallback

登录结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	日志上传结果的错误信息。信息中的错误码值 0 代表成功，非 0 为失败。若出现上传失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者登录结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否登录成功。
通知时机：当开发者调用 [login] 接口时，会触发该回调。

支持版本：1.2.0 及以上。

ZIMLogUploadedCallback

public ZIMLogUploadedCallback

日志上传结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	日志上传结果的错误信息。信息中的错误码值 0 代表成功，非 0 为失败。若出现上传失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者进行上传日志后，执行结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否上传成功。
通知时机：当开发者调用 [uploadLog] 接口时，会触发该回调。
相关接口：通过 [uploadLog] 调用日志上传，成功与否会通过本回调通知。

支持版本：1.2.0 及以上。

ZIMSelfUserInfoQueriedCallback

public ZIMSelfUserInfoQueriedCallback

查询个人用户信息、规则的结果回调。

参数

名称	类型	描述
selfUserInfo	ZIMSelfUserInfo	自身用户信息、规则数据类。
errorInfo	ZIMError	包含错误码，错误信息。

详情

查询个人用户信息、规则的结果回调。

ZIMUserOfflinePushRuleUpdatedCallback

public ZIMUserOfflinePushRuleUpdatedCallback

更新用户离线推送规则的结果回调。

参数

名称	类型	描述
offlinePushRule	ZIMUserOfflinePushRule	更新后的离线推送规则。
errorInfo	ZIMError	包含错误码与详细信息。

详情

更新用户离线推送规则的结果回调。

ZIMCallInvitationListQueriedCallback

public ZIMCallInvitationListQueriedCallback

查询呼叫列表的结果回调。

参数

名称	类型	描述
callList	const std::vector<ZIMCallInfo> &	查询返回的呼叫信息列表
nextFlag	long long	分页查询返回的锚点，下次查询时传入可在上次查询的基础上继续查询。
errorInfo	const ZIMError &	查询返回的错误信息。

详情

查询呼叫列表的结果回调。

ZIMCallingInvitationSentCallback

public ZIMCallingInvitationSentCallback

邀请加入当前呼叫的结果回调。

参数

名称	类型	描述
callID	const std::string &	当前呼叫邀请的 callID。
info	const ZIMCallInvitationSentInfo &	呼叫中邀请已发送信息。
errorInfo	const ZIMError &	错误信息，详情请参考常见错误码文档。

详情

邀请加入当前呼叫的结果回调。

ZIMCallQuitSentCallback

public ZIMCallQuitSentCallback

退出呼叫操作的回调闭包。

参数

名称	类型	描述
callID	const std::string &	退出的 callID。
info	const ZIMCallQuitSentInfo &	退出的信息。
errorInfo	const ZIMError &	错误信息。

详情

退出呼叫操作的回调闭包。

ZIMCallEndSentCallback

public ZIMCallEndSentCallback

结束呼叫的结果回调。

参数

名称	类型	描述
callID	const std::string &	呼叫的 callID。
info	const ZIMCallInvitationEndedInfo &	结束呼叫返回的信息。
errorInfo	const ZIMError &	结束呼叫返回的错误信息。

详情

结束呼叫的结果回调。

ZIMCallJoinSentCallback

public ZIMCallJoinSentCallback

加入呼叫的结果回调。

名称	类型	描述
callID	const std::string &	呼叫的 callID。
info	const ZIMCallJoinSentInfo &	加入呼叫返回的信息。
errorInfo	const ZIMError &	加入呼叫返回的错误信息。

ZIMCallInvitationSentCallback

public ZIMCallInvitationSentCallback

发送呼叫邀请的操作回调。

参数

名称	类型	描述
callID	const std::string &	已创建的呼叫邀请ID。
info	ZIMCallInvitationSentInfo	发送呼叫邀请信息。
errorInfo	ZIMError	发送呼叫邀请的错误码。0 代表发送呼叫邀请成功，非 0 为发送呼叫邀请失败。若出现发送呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

发送呼叫邀请的操作回调。

业务场景：进行发送呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：发送呼叫邀请操作结束后的结果返回。
相关接口：[callInvite]，发送呼叫邀请。

支持版本：2.0.0。

ZIMCallCancelSentCallback

public ZIMCallCancelSentCallback

取消呼叫邀请的操作回调。

参数

名称	类型	描述
callID	const std::string &	呼叫邀请唯一 ID
errorInvitees	const std::vector<std::string> &	取消呼叫邀请失败的用户。
errorInfo	ZIMError	取消呼叫邀请的错误码。0 代表取消呼叫邀请成功，非 0 为取消呼叫邀请失败。若出现取消呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

取消呼叫邀请的操作回调。

业务场景：进行取消呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：取消呼叫邀请操作结束后的结果返回。
相关接口：[callCancel]，取消呼叫邀请。

支持版本：2.0.0。

ZIMCallAcceptanceSentCallback

public ZIMCallAcceptanceSentCallback

接受呼叫邀请的操作回调。

参数

名称	类型	描述
callID	const std::string &	呼叫邀请唯一ID
errorInfo	ZIMError	接受呼叫邀请的错误码。0 代表接受呼叫邀请成功，非 0 为接受呼叫邀请失败。若出现接受呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

接受呼叫邀请的操作回调。

业务场景：进行接受呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：接受呼叫邀请操作结束后的结果返回。
相关接口：[callAccept]，接受呼叫邀请。

支持版本：2.0.0。

ZIMCallRejectionSentCallback

public ZIMCallRejectionSentCallback

拒绝呼叫邀请的操作回调。

参数

名称	类型	描述
callID	const std::string &	呼叫邀请唯一ID
errorInfo	ZIMError	拒绝呼叫邀请的错误码。0 代表拒绝呼叫邀请成功，非 0 为拒绝呼叫邀请失败。若出现拒绝呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

拒绝呼叫邀请的操作回调。

业务场景：进行拒绝呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：拒绝呼叫邀请操作结束后的结果返回。
相关接口：[callReject]，拒绝呼叫邀请。

支持版本：2.0.0。

ZIMGroupCreatedCallback

public ZIMGroupCreatedCallback

创建群的结果的返回。

参数

名称	类型	描述
groupInfo	const ZIMGroupFullInfo&	群组信息。
userList	const std::vector<ZIMGroupMemberInfo>	用户列表。
errorUserList	const std::vector<ZIMErrorUserInfo>	错误用户列表。
errorInfo	ZIMError	创建群组的错误码。0 代表创建群组成功，非 0 为创建群组失败。若出现创建群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群创建操作结果的返回。

业务场景：进行群创建操作后，成功与否可以通过该回调得知。
通知时机：群创建操作结束后的结果返回。
相关接口：[createGroup]，创建群组。

ZIMGroupsSearchedCallback

public ZIMGroupsSearchedCallback

搜索群的结果的返回。

参数

名称	类型	描述
groupSearchInfoList	const std::vector<ZIMGroupSearchInfo> &	群组信息。
nextFlag	unsigned int	分页拉取标志，搜索下一页的锚点。
errorInfo	const ZIMError &	搜索群组的错误码。0 代表搜索群组成功，非 0 为搜索群组失败。若出现搜索群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索群操作结果的返回。

业务场景：进行群搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalGroups]，搜索群组。

ZIMGroupMembersSearchedCallback

public ZIMGroupMembersSearchedCallback

搜索群成员的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群 ID。
userList	const std::vector<ZIMGroupMemberInfo> &	符合搜索条件的群成员列表。
nextFlag	unsigned int	分页拉取标志，搜索下一页的锚点。
errorInfo	const ZIMError &	搜索群成员的错误码。0 代表搜索群成员成功，非 0 为搜索群成员失败。若出现搜索群成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索群成员的结果的返回。

业务场景：进行群成员搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalGroupMembers]，搜索群成员。

ZIMGroupJoinedCallback

public ZIMGroupJoinedCallback

加入群的结果的返回。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群信息。
errorInfo	ZIMError	加入群组的错误码。0 代表加入群组成功，非 0 为加入群组失败。若出现加入群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群加入操作结果的返回。

业务场景：进行群加入操作后，成功与否可以通过该回调得知。
通知时机：群加入操作结束后的结果返回。
相关接口：[joinGroup]，加入群组。[leaveGroup]，离开群组。

ZIMGroupLeftCallback

public ZIMGroupLeftCallback

离开群的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组 ID。
errorInfo	ZIMError	离开群组的错误码。0 代表离开群组成功，非 0 为离开群组失败。若出现离开群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群离开操作结果的返回。

业务场景：进行群离开操作后，成功与否可以通过该回调得知。
通知时机：群离开操作结束后的结果返回。
相关接口：[leaveGroup]，离开群组。[joinGroup]，进入群组。

ZIMGroupDismissedCallback

public ZIMGroupDismissedCallback

解散群的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组 ID。
errorInfo	ZIMError	解散群组的错误码。0 代表解散群组成功，非 0 为解散群组失败。若出现解散群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群解散操作结果的返回。

业务场景：进行群解散操作后，成功与否可以通过该回调得知。
通知时机：群解散操作结束后的结果返回。
相关接口：[createGroup]，创建群组。[dismissGroup]，解散群租。

ZIMGroupUsersInvitedCallback

public ZIMGroupUsersInvitedCallback

用户被邀请进群的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组 ID。
userList	const std::vector<ZIMGroupMemberInfo> &	用户列表。
errorUserList	const std::vector<ZIMErrorUserInfo> &	邀请失败的用户列表。
errorInfo	ZIMError	邀请用户入群的错误码。0 代表邀请用户入群，非 0为邀请用户入群失败。若出现邀请用户入群失败时，开发者应查看官网错误码文档查询解决方案。

详情

邀请用户进群操作结果的返回。

业务场景：用户被邀请进群后，成功与否可以通过该回调得知。
通知时机：用户被邀请进群后的结果返回。
相关接口：[inviteUsersIntoGroup]，邀请用户进群。

ZIMGroupMemberKickedCallback

public ZIMGroupMemberKickedCallback

踢出群成员的结果的返回。

参数

名称	类型	描述
kickedUserIDList	const std::vector<std::string>	被踢出的成员列表。
errorUserList	const std::vector<ZIMErrorUserInfo>	错误的用户列表。
errorInfo	ZIMError	踢出群成员的错误码。0 代表踢出群成员成功，非 0 为踢出群成员失败。若出现踢出群成员时，开发者应查看官网错误码文档查询解决方案。

详情

踢出群成员操作结果的返回。

业务场景：进行踢出群成员操作后，成功与否可以通过该回调得知。
通知时机：踢出群成员操作结束后的结果返回。
相关接口：[kickGroupMembers]，踢出群成员。

ZIMGroupOwnerTransferredCallback

public ZIMGroupOwnerTransferredCallback

群主转让的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组ID。
toUserID	const std::string &	用户ID。
errorInfo	ZIMError	转让群主的错误码。0 代表转让群主成功，非 0为转让群主失败。若出现转让群主失败时，开发者应查看官网错误码文档查询解决方案。

详情

群主转让操作结果的返回。

业务场景：进行群主转让操作后，成功与否可以通过该回调得知。
通知时机：群主转让操作结束后的结果返回。
相关接口：[transferGroupOwner]，群主转让。

ZIMGroupAliasUpdatedCallback

public ZIMGroupAliasUpdatedCallback

群备注更新的结果回调。

参数

名称	类型	描述
groupID	const std::string &	群组 ID。
groupAlias	const std::string &	群备注。
errorInfo	ZIMError	更新群备注的错误码。0 代表更新成功，非 0为更新失败。若出现更新失败时，请查看官网错误码文档查询解决方案。

详情

群备注更新操作结果的返回。

业务场景：进行群备注更新操作后，成功与否可以通过该回调得知。
通知时机：群备注更新操作结束后的结果返回。
相关接口：[updateGroupAlias]，更新群备注。

ZIMGroupNameUpdatedCallback

public ZIMGroupNameUpdatedCallback

群名称更新的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组ID。
groupName	const std::string &	群名称。
errorInfo	ZIMError	更新群名称的错误码。0 代表更新群名称成功，非 0为更新群名称失败。若出现更新群名称失败时，开发者应查看官网错误码文档查询解决方案。

详情

群名称更新操作结果的返回。

业务场景：进行群名称更新操作后，成功与否可以通过该回调得知。
通知时机：群名称更新操作结束后的结果返回。
相关接口：[updateGroupName]，群名称更新。

ZIMGroupMutedCallback

public ZIMGroupMutedCallback

群禁言更新的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组ID。
isMute	bool	群禁言或解除群禁言。
mutedInfo	ZIMGroupMuteInfo	群禁言信息。
errorInfo	ZIMError	更新群禁言信息的错误码。0 代表更新群禁言信息成功，非 0为更新群禁言信息失败。若出现更新群禁言信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群禁言信息更新操作结果的返回。

业务场景：进行群禁言信息更新操作后，成功与否可以通过该回调得知。
通知时机：群禁言信息更新操作结束后的结果返回。
相关接口：[muteGroup]，群禁言。

ZIMGroupMembersMutedCallback

public ZIMGroupMembersMutedCallback

群成员禁言更新的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组ID。
isMute	bool	群成员禁言或解除群成员禁言。
duration	int	群成员禁言时长，单位为秒。
mutedUserIDs	const std::vector<std::string> &	成功被修改禁言状态的群成员 ID 列表。
errorUserList	const std::vector<ZIMErrorUserInfo> &	修改禁言状态失败的群成员列表。
errorInfo	ZIMError	更新群成员禁言信息的错误码。0 代表更新群成员禁言信息成功，非 0为更新群成员禁言信息失败。若出现更新群成员禁言信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员禁言信息更新操作结果的返回。

业务场景：进行群成员禁言信息更新操作后，成功与否可以通过该回调得知。
通知时机：群成员禁言信息更新操作结束后的结果返回。
相关接口：[muteGroupMembers]，群禁言。

ZIMGroupAvatarUrlUpdatedCallback

public ZIMGroupAvatarUrlUpdatedCallback

群头像 URL 更新的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组ID。
groupAvatarUrl	const std::string &	群头像 URL。
errorInfo	ZIMError	更新群头像 URL 的错误码。0 代表更新成功，非 0为更新群名称失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

群头像 URL 更新操作结果的返回。

业务场景：进行群头像 URL 更新操作后，成功与否可以通过该回调得知。
通知时机：群头像 URL 更新操作结束后的结果返回。
相关接口：[updateGroupAvatarUrl]。

ZIMGroupNoticeUpdatedCallback

public ZIMGroupNoticeUpdatedCallback

群公告更新的结果的返回。

参数

名称	类型	描述
groupNotice	const std::string &	群公告。
errorInfo	ZIMError	更新群公告的错误码。0 代表更新群公告成功，非 0为更新群公告失败。若出现更新群公告失败时，开发者应查看官网错误码文档查询解决方案。

详情

群公告更新操作结果的返回。

业务场景：进行群公告更新操作后，成功与否可以通过该回调得知。
通知时机：群公告更新操作结束后的结果返回。
相关接口：[updateGroupNotice]，群公告更新。

ZIMGroupJoinModeUpdatedCallback

public ZIMGroupJoinModeUpdatedCallback

加群验证模式更新的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
mode	ZIMGroupJoinMode	加群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

加群验证模式更新操作结果的返回。

业务场景：进行加群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：加群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupJoinMode]，加群验证模式更新。

ZIMGroupInviteModeUpdatedCallback

public ZIMGroupInviteModeUpdatedCallback

邀请入群验证模式更新的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
mode	ZIMGroupInviteMode	邀请入群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

邀请入群证模式更新操作结果的返回。

业务场景：进行邀请入群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：邀请入群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupInviteMode]，邀请入群验证模式更新。

ZIMGroupBeInviteModeUpdatedCallback

public ZIMGroupBeInviteModeUpdatedCallback

被邀请入群验证模式更新的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
mode	ZIMGroupBeInviteMode	被邀请入群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

被邀请入群证模式更新操作结果的返回。

业务场景：进行被邀请入群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：被邀请入群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupBeInviteMode]，被邀请入群验证模式更新。

ZIMGroupJoinApplicationSentCallback

public ZIMGroupJoinApplicationSentCallback

发送加群申请的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

发送加群申请的操作结果的返回。

业务场景：发送加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[sendGroupJoinApplication]，发送加群申请。

ZIMGroupJoinApplicationAcceptedCallback

public ZIMGroupJoinApplicationAcceptedCallback

接受加群申请的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
userID	std::string	申请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

接受加群申请的操作结果的返回。

业务场景：接受加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[acceptGroupJoinApplication]，接受加群申请。

ZIMGroupJoinApplicationRejectedCallback

public ZIMGroupJoinApplicationRejectedCallback

拒绝加群申请的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
userID	std::string	申请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

拒绝加群申请的操作结果的返回。

业务场景：拒绝加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[rejectGroupJoinApplication]，拒绝加群申请。

ZIMGroupInviteApplicationsSentCallback

public ZIMGroupInviteApplicationsSentCallback

发送邀请入群申请的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
errorUserList	std::vector<ZIMErrorUserInfo>	邀请失败的用户列表。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

发送邀请入群申请的操作结果的返回。

业务场景：发送邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[sendGroupInviteApplications]，发送邀请入群申请。

ZIMGroupInviteApplicationAcceptedCallback

public ZIMGroupInviteApplicationAcceptedCallback

接受邀请入群申请的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
inviterUserID	std::string	邀请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

接受邀请入群申请的操作结果的返回。

业务场景：接受邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[acceptGroupInviteApplication]，接受邀请入群申请。

ZIMGroupApplicationListQueriedCallback

public ZIMGroupApplicationListQueriedCallback

查询入群申请列表的回调。

参数

名称	类型	描述
applicationList	std::vector<ZIMGroupApplicationInfo>	入群申请列表。
nextFlag	unsigned int	下一个标志。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

入群申请列表查询结果的返回。

业务场景：进行入群申请列表查询后，成功与否可以通过该回调得知。
相关接口：[queryGroupApplicationList]，查询入群申请列表。

ZIMGroupInviteApplicationRejectedCallback

public ZIMGroupInviteApplicationRejectedCallback

拒绝邀请入群申请的回调。

参数

名称	类型	描述
groupID	std::string	群组ID。
inviterUserID	std::string	邀请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

拒绝邀请入群申请的操作结果的返回。

业务场景：拒绝邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[rejectGroupInviteApplication]，拒绝邀请入群申请。

ZIMGroupInfoQueriedCallback

public ZIMGroupInfoQueriedCallback

查询群信息的结果的返回。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群信息。
errorInfo	ZIMError	查询群组信息的错误码。0 代表查询群组信息成功，非 0 为查询群组信息失败。若出现查询群组信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群信息查询结果的返回。

业务场景：进行群信息查询后，成功与否可以通过该回调得知。
通知时机：群信息查询结束后的结果返回。
相关接口：[queryGroupInfo]，群信息查询。

ZIMGroupListQueriedCallback

public ZIMGroupListQueriedCallback

查询群列表的结果的返回。

参数

名称	类型	描述
groupList	const std::vector<ZIMGroupInfo>	群列表。
errorInfo	ZIMError	查询群组列表的错误码。0 代表查询群组列表成功，非 0 为查询群组列表失败。若出现查询群组列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

群列表查询结果的返回。

业务场景：进行群列表查询后，成功与否可以通过该回调得知。
通知时机：群列表查询结束后的结果返回。
相关接口：[queryGroupList]，查询群组列表。

ZIMGroupAttributesOperatedCallback

public ZIMGroupAttributesOperatedCallback

群属性操作结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组ID。
errorKeys	std::vector<std::string>	错误的键。
errorInfo	ZIMError	设置群组属性的错误码。0 代表设置群组属性成功，非 0 为设置群组属性失败。若出现设置群组属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

群属性操作结果的返回。

业务场景：进行自定义属性操作后，成功与否可以通过该回调得知。
通知时机：群属性操作结束后的结果返回。
相关接口：[setGroupAttributes]，设置房间属性。[deleteGroupAttributes]，删除房间属性。

ZIMGroupAttributesQueriedCallback

public ZIMGroupAttributesQueriedCallback

查询群属性结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组 ID。
groupAttributes	std::unordered_map<std::string, std::string>	群属性。
errorInfo	ZIMError	查询群组属性的错误码。0 代表查询群组属性成功，非 0 为查询群组属性失败。若出现查询群组属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

群属性查询结果的返回。

业务场景：进行自定义属性查询后，成功与否可以通过该回调得知。
通知时机：群属性查询后的结果返回。
相关接口：[queryGroupAttributes]，查询房间属性。

ZIMGroupMemberRoleUpdatedCallback

public ZIMGroupMemberRoleUpdatedCallback

成员角色更新的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组 ID。
forUserID	const std::string	用户ID。
role	int	角色。
errorInfo	ZIMError	群成员角色更新的错误码。0 代表群成员角色更新成功，非 0为群成员角色更新失败。若出现群成员角色更新失败时，开发者应查看官网错误码文档查询解决方案。

详情

成员角色更新操作结果的返回。

业务场景：进行成员角色更新操作后，成功与否可以通过该回调得知。
通知时机：成员角色更新操作结束后的结果返回。
相关接口：[setGroupMemberRole]，成员角色更新。

ZIMGroupMemberNicknameUpdatedCallback

public ZIMGroupMemberNicknameUpdatedCallback

群成员昵称更新的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组 ID。
forUserID	const std::string	用户ID。
nickname	const std::string	用户昵称。
errorInfo	ZIMError	设置群成员昵称的错误码。0 代表设置群成员昵称成功，非 0 为设置群成员昵称失败。若出现设置群成员昵称失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员昵称更新操作结果的返回。

业务场景：进行群成员昵称更新操作后，成功与否可以通过该回调得知。
通知时机：群成员昵称更新操作结束后的结果返回。
相关接口：[setGroupMemberNickname]，群成员昵称更新。

ZIMGroupMemberInfoQueriedCallback

public ZIMGroupMemberInfoQueriedCallback

群成员查询的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	群组 ID。
userInfo	ZIMGroupMemberInfo	群成员信息。
errorInfo	ZIMError	查询群组成员的错误码。0 代表查询群组成员成功，非 0 为查询群组成员失败。若出现查询群组成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员查询结果的返回。

业务场景：进行群成员查询后，成功与否可以通过该回调得知。
通知时机：群成员查询后的结果返回。
相关接口：[queryGroupMemberInfo]，群成员查询。

ZIMGroupMemberListQueriedCallback

public ZIMGroupMemberListQueriedCallback

查询群成员列表的结果的返回。

参数

名称	类型	描述
userList	const std::vector<ZIMGroupMemberInfo>	成员列表。
nextFlag	int	下一个标志。
errorInfo	ZIMError	查询群成员列表的错误码。0 代表查询群成员列表成功，非 0 为查询群成员列表失败。若出现查询群成员列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员列表操作结果的返回。

业务场景：进行查询群成员列表操作后，成功与否可以通过该回调得知。
通知时机：查询群成员列表操作结束后的结果返回。
相关接口：[queryGroupMemberList]，查询群成员列表。

ZIMGroupMemberMutedListQueriedCallback

public ZIMGroupMemberMutedListQueriedCallback

查询群禁言成员列表的结果的返回。

参数

名称	类型	描述
groupID	const std::string &	修改群成员禁言状态的群 ID。
nextFlag	unsigned long long	下一个标志。
userList	const std::vector<ZIMGroupMemberInfo>	成员列表。
errorInfo	ZIMError	查询群禁言成员列表的错误码。0 代表查询群禁言成员列表成功，非 0 为查询群禁言成员列表失败。若出现查询群禁言成员列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员禁言列表操作结果的返回。

业务场景：进行查询群禁言成员列表操作后，成功与否可以通过该回调得知。
通知时机：查询群禁言成员列表操作结束后的结果返回。
相关接口：[queryGroupMemberMutedList]，查询群禁言成员列表。

ZIMGroupMemberCountQueriedCallback

public ZIMGroupMemberCountQueriedCallback

查询群成员数量的结果的返回。

参数

名称	类型	描述
groupID	String	成员数量。
count	int	下一个标志。
errorInfo	ZIMError	查询群成员数量的错误码。0 代表查询群成员数量成功，非 0 为查询群成员数量失败。若出现查询群成员数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员数量操作结果的返回。

业务场景：进行查询群成员数量操作后，成功与否可以通过该回调得知。
通知时机：查询群成员数量操作结束后的结果返回。
相关接口：[queryGroupMemberCount]，查询群成员数量。

ZIMConversationPinnedListQueriedCallback

public ZIMConversationPinnedListQueriedCallback

置顶会话列表查询回调。

参数

名称	类型	描述
conversationList	const std::vector<std::shared_ptr<ZIMConversation>> &	置顶会话列表。
errorInfo	ZIMError	查询置顶会话列表的错误信息。0 代表查询置顶会话列表成功，非 0 为查询置顶会话列表失败。若出现查询置顶会话列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询置顶会话列表后通过该回调返回查询结果。

业务场景：可在该回调内做置顶会话列表查询后的逻辑。
通知时机：查询置顶会话列表后触发。

支持版本：2.8.0 及以上。

ZIMConversationPinnedStateUpdatedCallback

public ZIMConversationPinnedStateUpdatedCallback

会话置顶状态变更回调。

参数

名称	类型	描述
conversationID	const std::string &	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	更新会话置顶状态的错误码。0 代表更新会话置顶状态成功，非 0为更新会话置顶状态失败。若出现更新会话置顶状态失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新会话置顶状态后通过该回调返回结果。

业务场景：可在该回调内做更新会话置顶状态后的逻辑。
通知时机：调用 [updateConversationPinnedState] 接口更新会话置顶状态后触发。

支持版本：2.8.0 及以上。

ZIMConversationQueriedCallback

public ZIMConversationQueriedCallback

会话查询回调。

参数

名称	类型	描述
conversation	std::shared_ptr<ZIMConversation> &	会话对象。
errorInfo	ZIMError	查询会话的错误码。0 代表查询会话成功，非 0 为查询会话失败。若出现查询会话失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询会话后通过该回调返回查询结果。

业务场景：可在该回调内做会话查询后的逻辑。
通知时机：调用 [queryConversation] 接口查询会话后触发。

支持版本：2.8.0 及以上。

ZIMConversationListQueriedCallback

public ZIMConversationListQueriedCallback

会话列表查询回调。

参数

名称	类型	描述
conversationList	std::vector<std::shared_ptr<ZIMConversation>>	会话列表。
errorInfo	ZIMError	查询回话列表的错误码。0 代表查询回话列表成功，非 0 为查询回话列表失败。若出现查询回话列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询会话列表后通过该回调返回查询结果。

业务场景：可在该回调内做会话列表查询后的逻辑。
通知时机：查询会话列表后触发。
相关接口：[queryConversationList]

支持版本：2.0.0 及以上。

ZIMConversationDeletedCallback

public ZIMConversationDeletedCallback

会话删除的回调。

参数

名称	类型	描述
conversationID	const std::string &	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	删除回话的错误码。0 代表删除回话成功，非 0为删除回话失败。若出现删除回话失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除会话后通过该回调返回删除结果。

业务场景：可在该回调内做会话删除后的逻辑。
通知时机：删除会话后触发。
相关接口：[deleteConversation]。

支持版本：2.0.0 及以上。

ZIMConversationDraftSetCallback

public ZIMConversationDraftSetCallback

设置会话草稿的回调。

参数

名称	类型	描述
conversationID	std::string	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	设置会话草稿的错误码。0 代表设置会话草稿成功，非 0为设置会话草稿失败。若出现设置会话草稿失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置会话草稿后，通过该回调返回操作结果。

业务场景：可在该回调内做设置会话草稿后的逻辑。
通知时机：设置会话草稿后触发。
相关接口：[setConversationDraft]。

支持版本：2.14.0 及以上。

ZIMConversationTotalUnreadMessageCountQueriedCallback

public ZIMConversationTotalUnreadMessageCountQueriedCallback

查询会话未读消息总数的回调。

参数

名称	类型	描述
unreadMessageCount	unsigned int	会话未读消息总数。
errorInfo	ZIMError	查询操作的错误码。

通知时机：查询会话未读消息总数触发。

支持版本：2.17.0 及以上。

ZIMConversationsAllDeletedCallback

public ZIMConversationsAllDeletedCallback

全部会话删除的回调。

参数

名称	类型	描述
errorInfo	ZIMError	删除全部会话的错误码。0 代表删除全部会话成功，非 0为删除全部会话失败。若出现删除全部会话失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除全部会话后通过该回调返回删除结果。

业务场景：可在该回调内做全部会话删除后的逻辑。
通知时机：删除全部会话后触发。
相关接口：[deleteAllConversations]。

支持版本：2.12.0 及以上。

ZIMConversationTotalUnreadMessageCountClearedCallback

public ZIMConversationTotalUnreadMessageCountClearedCallback

全部会话未读数清除的回调。

参数

名称	类型	描述
errorInfo	ZIMError	清除全部会话未读数数量的错误码。0 代表清除全部会话未读数数量成功，非 0为清除全部会话未读数数量失败。若出现清除全部会话未读数数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

清除全部会话未读数后通过该回调返回清除会话的结果。

业务场景：可在该回调内做清除全部未读数后的逻辑。
通知时机：清除全部会话未读数后触发。
相关接口：[clearConversationTotalUnreadMessageCount]

支持版本：2.12.0 及以上。

ZIMConversationUnreadMessageCountClearedCallback

public ZIMConversationUnreadMessageCountClearedCallback

会话未读数清除的回调。

参数

名称	类型	描述
conversationID	const std::string &	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	清除回话未读数数量的错误码。0 代表清除回话未读数数量成功，非 0为清除回话未读数数量失败。若出现清除回话未读数数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

清除会话未读数后通过该回调返回清除会话的结果。

业务场景：可在该回调内做清除未读数后的逻辑。
通知时机：清除会话未读数后触发。
相关接口：[clearConversationUnreadMessageCount]

支持版本：2.0.0 及以上。

ZIMConversationMarkSetCallback

public ZIMConversationMarkSetCallback

会话标记设置的回调。

参数

名称	类型	描述
failedConversationInfos	const std::vector<ZIMConversationBaseInfo> &	设置失败的会话简要信息。
errorInfo	ZIMError	会话标记操作的错误码。0 代表会话标记操作成功，非 0 为会话标记操作失败。若出现会话标记操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置会话标记的结果。

通知时机：设置会话标记后触发。
相关接口：[setConversationMark]。

支持版本：2.17.0 及以上。

ZIMMessageInsertedCallback

public ZIMMessageInsertedCallback

插入本地消息的结果的回调。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMessage> &	消息对象。
errorInfo	ZIMError	插入本地消息的错误码。0 代表插入消息成功，非 0 为插入消息失败。若出现插入消息失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

插入本地消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否插入成功。
通知时机：当开发者调用 [insertMessageToLocalDB] 接口时，会触发该回调。
相关接口：通过 [insertMessageToLocalDB] 插入本地消息，成功与否会通过本回调通知。

支持版本：2.4.0 及以上。

ZIMMessageImportedCallback

public ZIMMessageImportedCallback

导入消息的结果的回调。

参数

名称	类型	描述
errorInfo	const std::shared_ptr<ZIMMessage> &	导入消息的错误码。0 代表导入消息成功，非 0 为导入消息失败。

详情

导入消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否导入成功。
通知时机：当开发者调用 [importLocalMessages] 接口时，会触发该回调。
相关接口：通过 [importLocalMessages] 导入消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageExportedCallback

public ZIMMessageExportedCallback

导出消息的结果的回调。

参数

名称	类型	描述
errorInfo	const std::shared_ptr<ZIMMessage> &	导出消息的错误码。0 代表导出消息成功，非 0 为导出消息失败。

详情

导出消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否导出成功。
通知时机：当开发者调用 [exportLocalMessages] 接口时，会触发该回调。
相关接口：通过 [exportLocalMessages] 导出消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMFileCacheClearedCallback

public ZIMFileCacheClearedCallback

清除本地缓存结果的回调。

参数

名称	类型	描述
errorInfo	const std::shared_ptr<ZIMMessage> &	清理缓存的错误码。0 代表清理缓存成功，非 0 为清理缓存失败。

详情

清除本地缓存结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否清理成功。
通知时机：当开发者调用 [clearLocalFileCache] 接口时，会触发该回调。
相关接口：通过 [clearLocalFileCache] 插入本地消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMFileCacheQueriedCallback

public ZIMFileCacheQueriedCallback

查询本地缓存的结果的回调。

参数

名称	类型	描述
fileCacheInfo	ZIMFileCacheInfo	缓存信息。
errorInfo	ZIMError	查询缓存的错误码。0 代表查询缓存成功，非 0 为查询缓存失败。

详情

查询本地缓存的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否查询成功。
通知时机：当开发者调用 [queryLocalFileCache] 接口时，会触发该回调。
相关接口：通过 [queryLocalFileCache]查询本地缓存，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageReactionAddedCallback

public ZIMMessageReactionAddedCallback

消息表态新增的返回。

参数

名称	类型	描述
reaction	const ZIMMessageReaction &	表态数据。
errorInfo	const ZIMError &	添加消息表态的错误码，0 代表操作成功，非 0 代表操作失败，请参考官网文档（https://doc-zh.zego.im/article/11605）获取解决方案。

详情

消息表态新增操作的结果。

通知时机：对消息进行表态后。
相关接口：[addMessageReaction]

支持版本：2.10.0 及以上。

ZIMMessageReactionDeletedCallback

public ZIMMessageReactionDeletedCallback

消息表态删除的返回。

参数

名称	类型	描述
reaction	const ZIMMessageReaction &	表态数据。
errorInfo	const ZIMError &	删除消息表态的错误码，0 代表操作成功，非 0 代表操作失败，请参考官网文档（https://doc-zh.zego.im/article/11605）获取解决方案。

详情

消息表态删除操作的结果。

通知时机：删除消息表态后。
相关接口：[deleteMessageReaction]

支持版本：2.10.0 及以上。

ZIMMessageReactionUserListQueriedCallback

public ZIMMessageReactionUserListQueriedCallback

消息表态详情查询的返回。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMessage> &	表态相关的消息。
userList	const std::vector<ZIMMessageReactionUserInfo> &	查询出来的表态用户详情列表。
reactionType	const std::string &	表态的类型。
nextFlag	const long long	查询锚点，用于下一次分页传给 [ZIMMessageReactionUserQueryConfig] 查询使用。
totalCount	const unsigned int	表态的用户总数。
error	const ZIMError &	错误信息。

详情

消息表态用户信息查询操作的结果。

通知时机：查询消息表态的用户信息后。
相关接口：[queryMessageReactionUserList]

支持版本：2.10.0 及以上。

ZIMMessageRepliedListQueriedCallback

public ZIMMessageRepliedListQueriedCallback

查询回复消息列表的结果的回调。

名称	类型	描述
messageList	const std::vector<ZIMMessage> &	查询出来的消息列表。
nextFlag	const long long	查询锚点，用于下一次分页传给 [ZIMMessageRepliedListQueryConfig] 查询使用。
rootRepliedInfo	ZIMMessageRootRepliedInfo	根消息的回复信息。
error	const ZIMError &	错误信息。

ZIMMessageEditedCallback

public ZIMMessageEditedCallback

编辑消息的结果的回调。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMessage> &	编辑的消息对象，可从中获取 editedTime、editorUserID 等参数。
errorInfo	ZIMError	编辑消息的错误码。

详情

编辑消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否编辑成功。
通知时机：当开发者调用 [editMessage] 接口时，会触发该回调。

支持版本：2.20.0 及以上。

ZIMMessagePinnedCallback

public ZIMMessagePinnedCallback

置顶或取消置顶消息的结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	置顶或取消消息的错误码。
sequence	zim_sequence	上下文，用于标识本次回调是哪一次调用触发的。

详情

置顶或取消置顶消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否编辑成功。
通知时机：当开发者调用 [pinMessage] 接口时，会触发该回调。

支持版本：2.25.0 及以上。

ZIMMessageSentCallback

public ZIMMessageSentCallback

发送消息的结果的回调。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMessage> &	发送的消息对象，可从中获取 messageID 等参数。若发送失败则其中的 messageID 参数将为空字符串。
errorInfo	ZIMError	发送消息的错误码。0 代表发送消息成功，非 0为发送消息失败。若出现发送消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

发送消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [sendPeerMessage] 与 [sendRoomMessage] 接口时，会触发该回调。
相关接口：通过 [sendPeerMessage] 与 [sendRoomMessage] 发送消息，发送消息的成功与否会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMSendingMessageCancelledCallback

public ZIMSendingMessageCancelledCallback

取消发送消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否取消发送成功。
通知时机：当开发者调用 [cancelSendingMessage] 接口时，会触发该回调。

支持版本：2.22.0 及以上。

ZIMConversationMessageReceiptReadSentCallback

public ZIMConversationMessageReceiptReadSentCallback

设置回执会话已读的回调接口。

参数

名称	类型	描述
conversationID	const std::string &	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	设置回执会话已读的错误码。0 代表设置成功，非 0为设置失败。若出现设置失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置回执会话已读的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
通知时机：当开发者调用 [sendConversationMessageReceiptRead] 接口时，会触发该回调。
相关接口：通过 [sendConversationMessageReceiptRead] 设置回执的会话已读的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageReceiptsReadSentCallback

public ZIMMessageReceiptsReadSentCallback

设置回执消息已读的回调接口。

参数

名称	类型	描述
conversationID	const std::string &	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorMessageIDs	std::vector<long long>	设置消息回执失败对应的消息ID。
errorInfo	ZIMError	设置回执消息已读的错误码。0 代表设置成功，非 0为设置失败。若出现设置失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置回执消息已读的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
通知时机：当开发者调用 [sendMessageReceiptsRead] 接口时，会触发该回调。
相关接口：通过 [sendMessageReceiptsRead] 设置回执的消息已读的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageReceiptsInfoQueriedCallback

public ZIMMessageReceiptsInfoQueriedCallback

查询回执消息信息的回调接口。

参数

名称	类型	描述
infos	std::vector<ZIMMessageReceiptInfo> &	查询出来的回执信息。
errorMessageIDs	std::vector<long long>	查询消息回执信息错误的消息ID。
errorInfo	ZIMError	查询消息回执的错误码。0 代表查询成功，非 0 为查询失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询回执消息信息的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [queryMessageReceiptsInfo] 接口时，会触发该回调。
相关接口：通过 [queryMessageReceiptsInfo] 查询回执的信息的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMGroupMessageReceiptMemberListQueriedCallback

public ZIMGroupMessageReceiptMemberListQueriedCallback

查询群回执消息具体已读/未读成员列表的回调接口。

参数

名称	类型	描述
groupID	std::string	群组 ID。
userList	std::vector<ZIMGroupMemberInfo>	查询成功的群用户列表。
nextFlag	unsigned int	查询下一页对应的 flag，用于给 [ZIMGroupMessageReceiptMemberQueryConfig] 的 nextFlag 参数使用。
errorInfo	ZIMError	设置查询群成员列表返回的错误码。0 代表查询成功，非 0为查询失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群回执消息具体已读/未读成员列表的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [queryGroupMessageReceiptReadMemberList] / [queryGroupMessageReceiptUnreadMemberList] 接口时，会触发该回调。

支持版本：2.5.0 及以上。

ZIMMessageRevokedCallback

public ZIMMessageRevokedCallback

撤回消息的结果的回调。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMessage> &	消息对象。
errorInfo	ZIMError	撤回消息的错误码。0 代表撤回成功，非 0为撤回失败。若出现撤回失败时，开发者应查看官网错误码文档查询解决方案。

详情

撤回消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [revokeMessage] 接口时，会触发该回调。
相关接口：通过 [revokeMessage] 撤回消息，发送消息的成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageQueriedCallback

public ZIMMessageQueriedCallback

开发者通过该回调获取查询到的消息列表，可以做历史消息显示。

参数

名称	类型	描述
conversationID	const std::string &	会话 ID。
conversationType	ZIMConversationType	会话类型。
messageList	const std::vector<std::shared_ptr<ZIMMessage>> &	查询结果的消息列表。
errorInfo	ZIMError	查询消息的错误码。0 代表查询消息成功，非 0为查询消息失败。若出现查询消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询消息列表的结果回调。

业务场景：开发者通过该回调获取查询到的消息列表，可以做历史消息显示。
通知时机：调用查询历史消息接口 [queryHistoryMessage] 后，查询到的消息列表会通过本回调通知。
相关接口：通过 [queryHistoryMessage] 查询历史消息，查询到的消息列表会通过本回调通知。

支持版本：2.0.0 及以上。

ZIMPinnedMessageListQueriedCallback

public ZIMPinnedMessageListQueriedCallback

开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。

参数

名称	类型	描述
messageList	const std::vector<std::shared_ptr<ZIMMessage>> &messageList	查询结果的消息列表。
errorInfo	ZIMError	查询消息的错误码。0 代表查询消息成功，非 0为查询消息失败。若出现查询消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询置顶消息列表的结果回调。

业务场景：开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。
通知时机：调用查询置顶消息接口 [queryPinnedMessageList] 后，查询到的置顶消息列表会通过本回调通知。
相关接口：通过 [queryPinnedMessageList] 查询历史消息，查询到的消息列表会通过本回调通知。

支持版本：2.25.0 及以上。

ZIMConversationMessagesAllDeletedCallback

public ZIMConversationMessagesAllDeletedCallback

删除全部会话的全部消息的回调。

参数

名称	类型	描述
errorInfo	ZIMError	删除消息的错误码。0 代表删除消息成功，非 0为删除消息失败。若出现删除消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除全部会话的全部消息后通过该回调返回消息删除的结果。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
通知时机：调用删除消息接口 [deleteAllConversationMessages] 后触发。
相关接口：[deleteAllConversationMessages]。

支持版本：2.14.0 及以上。

ZIMMessageDeletedCallback

public ZIMMessageDeletedCallback

删除消息的回调。

参数

名称	类型	描述
conversationID	const std::string &	会话 ID
conversationType	ZIMConversationType	会话类型
errorInfo	ZIMError	删除消息的错误码。0 代表删除消息成功，非 0为删除消息失败。若出现删除消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除消息后通过该回调返回消息删除的结果。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
通知时机：调用删除消息接口 [deleteMessage] 后触发。
相关接口：[deleteMessage]。

支持版本：2.0.0 及以上。

ZIMMediaDownloadedCallback

public ZIMMediaDownloadedCallback

下载媒体消息的结果回调。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMessage> &	发送的消息对象，可从中获取 messageID 等参数。若发送失败则其中的 messageID 参数将为空字符串。
errorInfo	ZIMError	发送消息的错误码。0 代表发送消息成功，非 0为发送消息失败。若出现发送消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

媒体消息下载的结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否下载成功。
通知时机：当开发者调用 [downloadMediaFile] 接口时，会触发该回调。
相关接口：通过 [downloadMediaFile] 下载媒体消息，成功与否会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMMediaUploadingProgress

public ZIMMediaUploadingProgress

发送媒体消息的进度回调。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMediaMessage> &	当前文件上传的消息对象。
currentFileSize	unsigned long long	当前进度，即当前文件上传的实时大小。
totalFileSize	unsigned long long	总进度，即当前文件的总大小。

详情

发送媒体消息的进度回调。

业务场景：开发者可以通过该回调获得媒体消息的发送进度。
通知时机：当开发者调用 [sendMediaMessage] 接口时，会触发该回调，且在发送的过程中将会多次触发。
相关接口：通过 [sendMediaMessage]，发送进度情况会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMMessageExportingProgress

public ZIMMessageExportingProgress

导出消息的进度回调。

参数

名称	类型	描述
exportedMessageCount	unsigned long long	当前进度，即当前导出的消息数。
totalMessageCount	unsigned long long	总进度，即导出消息的总数目。

详情

导出消息的进度回调。

业务场景：开发者可以通过该回调获得导出消息的进度。
通知时机：当开发者调用 [exportLocalMessages] 接口时，会触发该回调，且在导出的过程中将会多次触发。
相关接口：通过 [exportLocalMessages]，导出进度情况会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageImportingProgress

public ZIMMessageImportingProgress

导入消息的进度回调。

参数

名称	类型	描述
importedMessageCount	unsigned long long	当前进度，即当前导入的消息数。
totalMessageCount	unsigned long long	总进度，即导入消息的总数目。

详情

导入消息的进度回调。

业务场景：开发者可以通过该回调获得导入消息的进度。
通知时机：当开发者调用 [importLocalMessages] 接口时，会触发该回调，且在导入的过程中将会多次触发。
相关接口：通过 [importLocalMessages]，导入进度情况会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMediaDownloadingProgress

public ZIMMediaDownloadingProgress

下载媒体文件的进度回调。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMessage> &	当前文件下载的消息对象。
currentFileSize	unsigned long long	当前进度，即当前文件下载的实时大小。
totalFileSize	unsigned long long	总进度，即当前文件的总大小。

详情

下载媒体消息的进度回调。

业务场景：开发者可以通过该回调获得媒体消息的下载进度。
通知时机：当开发者调用 [downloadMediaFile] 接口时，会触发该回调，且在下载的过程中将会多次触发。
相关接口：通过 [downloadMediaFile]，下载进度情况会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMMessageLocalExtendedDataUpdatedCallback

public ZIMMessageLocalExtendedDataUpdatedCallback

更新消息本地拓展字段的回调。

参数

名称	类型	描述
message	const std::shared_ptr<ZIMMessage>	更新后消息对象。
errorInfo	const ZIMError &	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者修改消息本地扩展信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateMessageLocalExtendedData] 接口时，会触发该回调。

支持版本：2.9.0 及以上。

ZIMMessagesSearchedCallback

public ZIMMessagesSearchedCallback

搜索本地消息结果的返回。

参数

名称	类型	描述
conversationID	const std::string &	会话 ID，单聊时，conversationID 即是对方的 userID。群组时，conversationID 即是群组的 groupID。
conversationType	ZIMConversationType	会话类型。0：单聊 1：房间 2：群组，注意：“房间”场景下，默认不支持缓存和搜索离线消息。
messageList	const std::vector<ZIMMessage> &	搜索到的消息列表。
nextMessage	const std::vector<std::shared_ptr<ZIMMessage>> &	分页拉取标志，搜索下一页的消息锚点。
errorInfo	const ZIMError &	搜索本地消息的错误码。0 代表搜索本地消息成功，非 0 为搜索本地消息失败。若出现搜索本地消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索本地消息结果的返回。

业务场景：进行本地消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalMessages]，搜索本地消息。

ZIMMessagesGlobalSearchedCallback

public ZIMMessagesGlobalSearchedCallback

全局搜索本地消息结果的返回。

参数

名称	类型	描述
messageList	const std::vector<std::shared_ptr<ZIMMessage>> &	全局搜索到的消息列表。
nextMessage	const std::shared_ptr<ZIMMessage> &	分页拉取标志，搜索下一页的消息锚点。
errorInfo	const ZIMError &	全局搜索本地消息的错误码。0 代表全局搜索本地消息成功，非 0 为全局搜索本地消息失败。若出现全局搜索本地消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

全局搜索本地消息结果的返回。

业务场景：进行全局本地消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchGlobalLocalMessages]，全局搜索本地消息。

ZIMConversationsSearchedCallback

public ZIMConversationsSearchedCallback

基于本地消息搜索本地会话结果的返回。

参数

名称	类型	描述
conversationSearchInfoList	const std::vector<ZIMConversationSearchInfo>&	搜索到的会话消息列表。
nextFlag	unsigned int	分页拉取标志，搜索下一页的锚点。
errorInfo	const ZIMError &	搜索结果的错误码。0 代表搜索成功，非 0 为搜索失败。若出现搜索失败时，开发者应查看官网错误码文档查询解决方案。

详情

基于本地消息搜索本地会话结果的返回。

业务场景：进行本地会话消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalConversations]，基于本地消息搜索本地会话。

ZIMRoomMembersQueriedCallback

public ZIMRoomMembersQueriedCallback

查询房间指定成员的结果回调。

参数

名称	类型	描述
roomID	const std::string &	房间 ID。
memberList	const std::vector<ZIMRoomMemberInfo> &	查询成功的用户信息列表。
errorUserList	const std::vector<ZIMErrorUserInfo> &	查询失败的用户列表。
errorInfo	ZIMError	错误信息。

详情

查询房间用户信息后通过该回调返回查询结果。

业务场景：可在该回调内做查询房间用户信息后的逻辑。
通知时机：调用 [queryRoomMembers] 接口查询房间用户信息后触发。

支持版本：2.8.0 及以上。

ZIMRoomMembersAttributesQueriedCallback

public ZIMRoomMembersAttributesQueriedCallback

房间用户属性批量查询结果的返回。

参数

名称	类型	描述
roomID	const std::string &	房间 ID。
infos	const std::vector<ZIMRoomMemberAttributesInfo> &	房间用户属性列表。
errorInfo	ZIMError	查询房间用户属性的错误码。0 代表查询房间用户属性成功，非 0 为查询房间用户属性失败。若出现查询房间用户属性失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

根据 UserID 列表，房间用户属性批量查询结果的返回。

业务场景：进行房间用户属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间用户属性查询结束后的结果返回。
相关接口：[queryRoomMembersAttributes]，查询房间用户属性。

支持版本：2.4.0 及以上。

ZIMRoomMemberAttributesListQueriedCallback

public ZIMRoomMemberAttributesListQueriedCallback

房间内用户属性列表查询结果的返回。

参数

名称	类型	描述
roomID	const std::string &	房间 ID。
infos	const std::vector<ZIMRoomMemberAttributesInfo> &	房间用户属性列表。
nextFlag	const std::string &	下一个分页查询的锚点，为空则代表已经查询完毕。
errorInfo	ZIMError	查询房间用户属性的错误码。0 代表查询房间用户属性成功，非 0 为查询房间用户属性失败。若出现查询房间用户属性失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

分页查询房间内所有用户属性列表结果的返回。

业务场景：进行房间用户属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间用户属性查询结束后的结果返回。
相关接口：[queryRoomMemberAttributesList]，查询房间用户属性。

支持版本：2.4.0 及以上。

ZIMRoomCreatedCallback

public ZIMRoomCreatedCallback

创建房间的结果的回调。

参数

名称	类型	描述
roomInfo	const ZIMRoomFullInfo &	创建出来的房间的详细信息。若创建失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	错误信息。

详情

创建房间的结果回调。

业务场景：当开发者创建房间时可以通过该回调来判断是否创建成功，并执行相应的业务逻辑。
通知时机：当调用 [createRoom] 创建房间后结果会触发本回调通知。
相关接口：通过 [createRoom] 创建房间，创建结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomEnteredCallback

public ZIMRoomEnteredCallback

进入房间的结果的回调。

参数

名称	类型	描述
roomInfo	const ZIMRoomFullInfo &	创建出来的房间的详细信息。若创建失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	错误信息。

详情

进入房间的结果回调。

业务场景：当开发者进入房间时可以通过该回调来判断是否进入成功，并执行相应的业务逻辑。
通知时机：当调用 [enterRoom] 进入房间后结果会触发本回调通知。
相关接口：通过 [enterRoom] 创建房间，进入结果会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMRoomSwitchedCallback

public ZIMRoomSwitchedCallback

切换房间的结果的回调。

参数

名称	类型	描述
roomInfo	const ZIMRoomFullInfo &	切换后的房间的详细信息。
errorInfo	ZIMError	错误信息。

详情

切换房间的结果回调。

业务场景：当开发者切换房间时可以通过该回调来判断是否切换成功，并执行相应的业务逻辑。
通知时机：当调用 [switchRoom] 切换房间后结果会触发本回调通知。
相关接口：通过 [switchRoom] 切换房间，切换结果会通过本回调通知。

支持版本：2.18.0 及以上。

ZIMRoomJoinedCallback

public ZIMRoomJoinedCallback

加入房间的结果的回调。

参数

名称	类型	描述
roomInfo	const ZIMRoomFullInfo &	加入的房间的详细信息。若加入失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	加入房间的错误码。0 代表加入房间成功，非 0 为加入房间失败。若出现加入房间失败时，开发者应查看官网错误码文档查询解决方案。

详情

加入房间的结果的回调。

业务场景：当开发者加入房间时，开发者可以通过该回调判断是否加入成功。
通知时机：当有人加入房间时，会通过该回调通知。
相关接口：通过 [joinRoom] 加入房间，加入结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomAllLeftCallback

public ZIMRoomAllLeftCallback

离开所有房间的结果的回调。

参数

名称	类型	描述
roomIDs	std::vector<std::string>	房间 ID 列表。

通知时机：当用户调用 [leaveAllRoom]，则会触发该回调返回结果。

支持版本：1.15 及以上。

ZIMRoomLeftCallback

public ZIMRoomLeftCallback

离开房间的结果的回调。

参数

名称	类型	描述
roomID	const std::string &	房间 ID
errorInfo	ZIMError	离开房间的错误码。0 代表离开房间成功，非 0 为离开房间失败。若出现离开房间失败时，开发者应查看官网错误码文档查询解决方案。

详情

离开房间的结果的回调。

业务场景：当用户本人需要离开房间时，开发者可以在该回调里进行业务逻辑处理。
通知时机：当用户调用 [leaveRoom]，则会触发该回调返回结果。
相关接口：通过 [leaveRoom] 离开房间，离开结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomMemberQueriedCallback

public ZIMRoomMemberQueriedCallback

查询房间成员列表的结果回调。

参数

名称	类型	描述
roomID	const std::string &	房间 ID
memberList	const std::vector<ZIMUserInfo> &	房间的成员列表。
nextFlag	const std::string &	分页查询的标识位，如果此字段为空字符串，说明已查询完毕。否则需要将此值设置到 ZIMQueryMemberConfig 的 "nextFlag" 字段中以进行下一页查询。
errorInfo	ZIMError	查询房间成员的错误码。0 代表查询房间成员成功，非 0 为查询房间成员失败。若出现查询房间成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询房间成员列表的结果回调。

通知时机：当调用 [queryRoomMember] 接口进行房间成员查询时候，会触发该回调。
相关接口：通过 [queryRoomMember] 查询房间成员列表，查询结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomOnlineMemberCountQueriedCallback

public ZIMRoomOnlineMemberCountQueriedCallback

查询房间在线成员数量回调。

参数

名称	类型	描述
roomID	const std::string &	房间 ID
count	unsigned int	房间的在线成员数量。
errorInfo	ZIMError	查询房间在线成员的错误码。0 代表查询房间在线成员成功，非 0 为查询房间在线成员失败。若出现查询房间在线成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

进行查询房间在线成员数量操作后，执行所获得的人数回调。

通知时机：当调用 [queryRoomOnlineMemberCount] 接口进行查询房间成员人数时，会触发该回调。
相关接口：可通过 [queryRoomOnlineMemberCount] 查询房间在线人数。

支持版本：1.1.0 及以上。

ZIMRoomAttributesQueriedCallback

public ZIMRoomAttributesQueriedCallback

房间属性查询结果的返回。

参数

名称	类型	描述
roomID	const std::string &	房间 ID
roomAttributes	std::unordered_map<std::string, std::string> &	房间内的房间属性。
errorInfo	ZIMError	查询房间全部属性的错误码。0 代表查询房间全部属性成功，非 0 为查询房间全部属性失败。若出现查询房间全部属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性查询结果的返回。

业务场景：进行自定义属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间属性查询结束后的结果返回。
相关接口：[queryRoomAllAttributes]，查询房间属性。

支持版本：1.3.0。

ZIMRoomAttributesOperatedCallback

public ZIMRoomAttributesOperatedCallback

房间属性操作结果的返回。

参数

名称	类型	描述
roomID	std::string	房间 ID。
errorKeys	const std::vector<std::string> &	操作失败的 keys。
errorInfo	ZIMError	房间属性操作的错误码。0 代表房间属性操作成功，非 0 为房间属性操作失败。若出现房间属性操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性操作结果的返回。

业务场景：进行自定义属性操作后，成功与否可以通过该回调得知。
通知时机：房间属性操作结束后的结果返回。
相关接口：[setRoomAttributes]，设置房间属性。[deleteRoomAttributes]，删除房间属性。

支持版本：1.3.0。

ZIMRoomAttributesBatchOperatedCallback

public ZIMRoomAttributesBatchOperatedCallback

房间属性组合操作结果的返回。

参数

名称	类型	描述
roomID	const std::string &	房间 ID
errorInfo	ZIMError	房间属性批处理操作的错误码。0 代表房间属性批处理操作成功，非 0 为房间属性批处理操作失败。若出现房间属性批处理操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性组合操作结果的返回。

业务场景：进行自定义属性组合操作后，成功与否可以通过该回调得知。
通知时机：房间属性组合操作结束后的结果返回。
相关接口：[beginRoomAttributesBatchOperation]，开始房间属性组合操作。[endRoomAttributesBatchOperation]，完成房间属性组合操作。

支持版本：1.3.0。

errorInfo

方法

ZIMConversationNotificationStatusSetCallback

public ZIMConversationNotificationStatusSetCallback

会话通知状态设置的回调。

参数

名称	类型	描述
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	设置回话通知状态的错误码。0 代表设置回话通知状态成功，非 0为设置回话通知状态失败。若出现设置回话通知状态失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置群通知状态后通过该回调返回群通知的结果。

业务场景：可在该回调内做设置群通知状态后的逻辑。
通知时机：设置群通知状态后触发。
相关接口：[setConversationNotificationStatus]。

支持版本：2.0.0 及以上。