功能总览

2026-09-18

ZEGO 即时通讯 SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为开发者提供全平台互动、海量并发、超低延时、消息必达的通信服务，助力打造大型直播、语聊房等场景。

初始化相关的前置功能

方法名	描述
getVersion	获取 SDK 版本号。
create	初始化 ZIM SDK
getInstance	获取 ZIM 单例对象。
setAdvancedConfig	设置 ZIM 进阶配置。
setGeofencingConfig	设置地理围栏相关配置。
setLogConfig	设置日志相关配置。
setCacheConfig	设置缓存相关配置。
setAndroidEnv	设置 Android 环境。
setPushID	设置推送 ID。
destroy	销毁 ZIM 实例。
setEventHandler	设置事件通知回调，传 [null] 则清空已设置的回调。
uploadLog	上传日志，设置日志路径和创建实例后调用。
login	登录，在使用所有功能之前必须先登录。
logout	登出 ZIM 服务。
renewToken	更新鉴权 Token。
callExperimentalAPI	调用实验性 API。
updateUserName	更新用户的用户名。
updateUserAvatarUrl	更新用户的用户头像URL。
updateUserExtendedData	更新用户的用户扩展字段。
updateUserOfflinePushRule	修改离线推送的自定规则。
updateUserCustomStatus	用于更新用户自定义状态。
updateUserCustomStatus	更新用户的自定义状态。
updateUserBadge	更新 iOS 离线通知徽标数量。
queryUsersInfo	查询用户信息。
queryUsersStatus	批量查询其他用户的用户状态。
querySelfUserInfo	查询自身用户信息、用户规则。
subscribeUsersStatus	订阅其他用户的用户状态。
unsubscribeUsersStatus	用于批量取消订阅当前用户订阅列表中的目标用户。
querySubscribedUserStatusList	用于查询当前用户用户状态订阅列表。
onError	错误信息回调。
onExperimentalEventReceived	实验性 API 回调。
onTokenWillExpire	Token 将要过期的提醒回调。
onConnectionStateChanged	连接状态发生改变的事件回调。
onUserInfoUpdated	用户信息更新的回调。
onUserRuleUpdated	用户规则变更的回调。
onUserStatusUpdated	用户在线状态变更通知。

会话功能

方法名	描述
queryConversationList	查询会话列表。
queryConversationList	查询会话列表。
queryConversation	查询单个会话。
queryConversationPinnedList	查询置顶会话列表。
updateConversationPinnedState	修改会话置顶状态。
deleteConversation	删除会话。
deleteAllConversations	删除全部会话。
clearConversationUnreadMessageCount	清除会话未读数。
clearConversationTotalUnreadMessageCount	清除全部会话未读数。
queryConversationTotalUnreadMessageCount	按照配置项查询会话未读消息总数。
setConversationNotificationStatus	设置会话通知状态。
sendConversationMessageReceiptRead	设置会话所有已接收的回执已读。
setConversationDraft	设置会话草稿。
setConversationMark	设置或取消设置会话标记。
setConversationMessageDestructDuration	设置会话内消息定时销毁时长。
searchLocalConversations	基于本地消息搜索本地会话。
onConversationChanged	收到会话更新的通知回调。
onConversationTotalUnreadMessageCountUpdated	会话总未读数更新的通知回调。
onConversationMessageReceiptChanged	收到回执的会话已读更新的通知回调。
onConversationsAllDeleted	所有会话被删除时触发此回调。
onConversationSyncStateChanged	会话列表与服务端的同步状态变更事件通知

消息功能

方法名	描述
sendMessage	发送消息。
downloadMediaFile	下载媒体文件的内容。
queryHistoryMessage	查询历史消息。
queryMessages	批量查询指定序列号的会话消息。
deleteMessages	删除消息。
deleteAllMessage	通过会话ID删除消息。
deleteAllConversationMessages	删除所有会话的所有消息。
insertMessageToLocalDB	向本地 DB 插入一条消息。
sendMessageReceiptsRead	设置一批消息的回执变成已读。
queryMessageReceiptsInfo	查询一批消息的回执信息。
revokeMessage	撤回消息。
updateMessageLocalExtendedData	更新消息的本地拓展字段。
editMessage	编辑消息。
cancelSendingMessage	取消发送中的消息。
searchLocalMessages	搜索本地消息列表。
searchGlobalLocalMessages	搜索全局本地消息列表。
addMessageReaction	增加消息表态
addMessageReaction	增加消息表态
deleteMessageReaction	删除消息表态
deleteMessageAllReactions	删除自己在该消息下的所有表态
queryMessageReactionUserList	拉取消息表态用户列表
queryCombineMessageDetail	拉取合并消息详情
replyMessage	发送回复消息。
queryMessageRepliedList	查询回复列表。
pinMessage	置顶或取消消息。
pinMessage	置顶消息。
queryPinnedMessageList	查询置顶消息列表。
queryLocalFileCache	查询当前用户本地消息缓存。
clearLocalFileCache	清理当前用户本地消息缓存。
onPeerMessageReceived	接收单聊消息事件回调
onRoomMessageReceived	接收房间消息事件回调
onGroupMessageReceived	接收群消息事件回调
onMessageReceived	接收消息事件回调
onBroadcastMessageReceived	接收广播消息事件回调
onMessageSentStatusChanged	消息发送状态改变事件回调
onMessageReceiptChanged	收到回执的消息已读更新的通知回调。
onMessageRevokeReceived	收到撤回消息的回调。
onMessageReactionsChanged	收到表态变更的回调。
onMessageReactionsChanged	消息的表态内容发生变更时的回调。
onMessageDeleted	消息删除事件回调
onMessageRepliedInfoChanged	消息的回复信息变更事件回调
onMessageRepliedCountChanged	消息的回复数量变更事件回调
onMessageEdited	消息编辑事件回调
onMessagePinStatusChanged	消息置顶事件回调

房间功能

方法名	描述
createRoom	创建并加入一个房间。
createRoom	创建带高级设置的房间。
joinRoom	加入一个房间。
enterRoom	进入房间。若房间不存在，则自动创建。
switchRoom	从一个房间切换至另一个房间，若房间不存在，会根据传入参数决定是否创建对应房间。
leaveRoom	离开一个房间。
leaveAllRoom	离开所有已进入的房间。
queryRoomMemberList	查询房间内的成员列表。
queryRoomMembers	查询指定房间中的特定 userID 的用户信息。
queryRoomOnlineMemberCount	查询房间内在线成员的数量。
setRoomAttributes	设置房间属性（增加、改变房间属性均用此接口）。
deleteRoomAttributes	删除房间属性。
beginRoomAttributesBatchOperation	开启组合房间属性操作。
endRoomAttributesBatchOperation	完成组合房间属性操作。
queryRoomAllAttributes	查询房间所有属性。
setRoomMembersAttributes	设置房间成员属性（增加、改变房间属性均用此接口）。
queryRoomMembersAttributes	批量查询房间内成员的房间用户属性。
queryRoomMemberAttributesList	分页查询房间内拥有房间属性成员的房间用户属性。
onRoomStateChanged	房间连接状态变更事件回调
onRoomMemberJoined	房间有成员加入事件回调
onRoomMemberLeft	房间有成员离开事件回调
onRoomAttributesUpdated	房间属性变更事件回调
onRoomAttributesBatchUpdated	房间属性批量变更事件回调
onRoomMemberAttributesUpdated	房间成员属性变更事件回调

群组功能

方法名	描述
createGroup	创建并加入一个群组。
createGroup	创建并加入一个带群属性的群组。
dismissGroup	解散群组。
joinGroup	加入群组。
leaveGroup	离开群组。
inviteUsersIntoGroup	邀请用户进入群组。
kickGroupMembers	踢出群组成员。
transferGroupOwner	转让群主。
queryGroupInfo	查询群组信息。
queryGroupMemberInfo	查询群成员信息。
queryGroupList	查询群列表。
queryGroupList	查询群列表。
queryGroupMemberList	查询群成员列表。
queryGroupMemberCount	查询指定群内的群成员数量。
updateGroupName	更新群名称。
updateGroupAvatarUrl	更新群头像 URL。
updateGroupNotice	更新群公告。
updateGroupAlias	更新群备注。
updateGroupJoinMode	更新入群模式。
updateGroupInviteMode	更新邀请模式。
updateGroupBeInviteMode	更新邀请目标验证模式。
setGroupAttributes	设置群属性。
deleteGroupAttributes	删除群属性。
queryGroupAttributes	查询群属性。
queryGroupAllAttributes	查询群组全部属性。
setGroupMemberRole	设置群成员角色。
setGroupMemberNickname	设置群成员昵称。
muteGroup	禁言群组。
muteGroupMembers	禁言群成员。
queryGroupMemberMutedList	查询群禁言成员列表。
queryGroupMessageReceiptReadMemberList	查询群消息已读成员列表。
queryGroupMessageReceiptUnreadMemberList	查询群消息未读成员列表。
queryGroupMessageReceiptMemberList	查询群消息回执成员列表。
searchLocalGroups	搜索本地群组。
searchLocalGroupMembers	搜索本地群成员。
sendGroupJoinApplication	发送加群申请。
acceptGroupJoinApplication	同意加群申请。
rejectGroupJoinApplication	拒绝加群申请。
sendGroupInviteApplications	发送邀请入群申请。
acceptGroupInviteApplication	同意邀请入群申请。
rejectGroupInviteApplication	拒绝邀请入群申请。
queryGroupApplicationList	查询入群申请列表。
onGroupStateChanged	群状态变更事件回调
onGroupNameUpdated	群名称变更事件回调
onGroupAvatarUrlUpdated	群头像变更事件回调
onGroupNoticeUpdated	群公告变更事件回调
onGroupAliasUpdated	群别名变更事件回调
onGroupAttributesUpdated	群属性变更事件回调
onGroupMutedInfoUpdated	群禁言事件回调
onGroupVerifyInfoUpdated	群验证信息变更事件回调
onGroupMemberStateChanged	群成员状态变更事件回调
onGroupMemberInfoUpdated	群成员信息变更事件回调
onGroupApplicationListChanged	群申请列表变更事件回调
onGroupApplicationUpdated	群申请信息变更事件回调

呼叫邀请功能

方法名	描述
callInvite	发起呼叫邀请。
callCancel	取消呼叫邀请。
callAccept	接受呼叫邀请。
callReject	拒绝呼叫邀请。
callingInvite	邀请其他用户加入呼叫邀请。
callJoin	加入进阶模式呼叫，或者切换进阶模式呼叫的主设备（仅限多端登录）
callQuit	退出当前呼叫邀请。
callEnd	结束呼叫邀请。
queryCallInvitationList	查询呼叫邀请列表。
onCallInvitationCreated	呼叫邀请创建事件回调
onCallInvitationReceived	呼叫邀请接收事件回调
onCallInvitationCancelled	呼叫邀请取消事件回调
onCallInvitationEnded	呼叫邀请结束事件回调
onCallInvitationTimeout	呼叫邀请超时事件回调
onCallUserStateChanged	呼叫邀请用户状态变更事件回调

好友功能

方法名	描述
addFriend	直接添加好友。
deleteFriends	批量删除好友。
checkFriendsRelation	检查好友关系。
updateFriendAlias	更新好友备注。
updateFriendAttributes	更新好友属性。
queryFriendsInfo	批量查询好友信息。
queryFriendList	查询好友列表。
searchLocalFriends	搜索本地好友。
sendFriendApplication	发送好友申请。
acceptFriendApplication	接受好友申请。
rejectFriendApplication	拒绝好友申请。
queryFriendApplicationList	查询好友申请列表。
onFriendListChanged	好友列表变更事件回调
onFriendInfoUpdated	好友信息变更事件回调
onFriendApplicationListChanged	好友申请列表变更事件回调
onFriendApplicationUpdated	好友申请信息变更事件回调

黑名单功能

方法名	描述
addUsersToBlacklist	添加用户到黑名单。
removeUsersFromBlacklist	将用户移除出黑名单。
queryBlacklist	查询黑名单。
checkUserIsInBlacklist	检查用户是否在黑名单。
onBlacklistChanged	黑名单变更事件回调

社群功能

方法名	描述
createCommunity	创建社群。
dismissCommunity	解散社群。
joinCommunity	加入社群。
leaveCommunity	退出社群。
inviteUsersIntoCommunity	邀请用户加入社群。
kickCommunityMembers	移出社群成员。
queryCommunityList	查询社群列表。
updateCommunityName	更新社群名称。
updateCommunityAvatarUrl	更新社群头像 URL。
updateCommunityNotice	更新社群公告。
updateCommunityJoinMode	更新社群加入模式。
updateCommunityVisitorFetchMessageCount	更新游客社群拉取消息数量。
updateCommunityVisitorFetchMessageDuration	更新游客社群拉取消息时间。
setCommunityAttributes	设置社群属性。
deleteCommunityAttributes	删除社群属性。
setCommunityNotificationStatus	设置社群消息通知状态。
queryCommunityInfo	查询社群信息。
updateCommunityMemberRole	更新社群成员角色。
transferCommunityOwner	转让社群所有者。
queryCommunityMemberList	查询社群成员列表。
queryCommunityMembers	查询指定社群成员信息。
enterCommunityAsVisitor	以游客身份加入社群。
quitCommunityAsVisitor	以游客身份退出社群。
createCommunityChannel	创建社群频道。
dismissCommunityChannel	解散社群频道。
updateCommunityChannelName	更新社群频道名称。
updateCommunityChannelAvatarUrl	更新社群频道头像 URL。
updateCommunityChannelNotice	更新社群频道公告。
setCommunityChannelAttributes	设置社群频道属性。
deleteCommunityChannelAttributes	删除社群频道属性。
queryCommunityChannelsInfo	查询社群频道信息。
queryCommunityChannelList	查询社群频道列表。
muteCommunityChannels	禁言社群频道。
muteCommunityMembers	禁言社群成员。
sendCommunityJoinApplication	发送加入社群申请。
queryCommunitySelfApplicationList	查询当前用户的社群申请列表。
cancelCommunityJoinApplication	取消加入社群申请。
acceptCommunityJoinApplication	接受加入社群申请。
rejectCommunityJoinApplication	拒绝加入社群申请。
queryCommunityApplicationList	查询社群下的申请列表。
onCommunityListChanged	社群列表发生变更时触发此回调。
onCommunitySelfApplicationListChanged	当前用户的社群申请列表发生变更时触发此回调。
onCommunityApplicationListChanged	社群的申请审核列表发生变更时触发此回调（社群所有者与管理员）。
onCommunityInfoUpdated	社群信息更新时触发此回调。
onCommunityMemberStateChanged	社群成员状态发生变更时触发此回调。
onCommunityMemberInfoUpdated	社群成员信息更新时触发此回调。
onCommunityChannelListChanged	社群频道列表发生变更时触发此回调。
onCommunityChannelInfoUpdated	社群频道信息更新时触发此回调。