功能总览

2026-06-25

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

初始化相关的前置功能

方法名	描述
getVersion	获取 SDK 版本号。
createWithAppConfig:	初始化 ZIM SDK
getInstance	获取 ZIM 单例对象。
setAdvancedConfigWithKey:value:	设置 ZIM 进阶配置。
setGeofencingConfigWithAreaList:type:	设置地理围栏相关配置。
setLogConfig:	设置日志相关配置。
setCacheConfig:	设置缓存相关配置。
setCustomDispatchQueue	设置自定义 GCD 队列。
destroy	销毁 ZIM 实例。
setEventHandler:	设置事件通知回调，传 [null] 则清空已设置的回调。
uploadLog:	上传日志，设置日志路径和创建实例后调用。
loginWithUserID:config:callback:	登录，在使用所有功能之前必须先登录。
logout	登出 ZIM 服务。
renewToken:callback:	更新鉴权 Token。
callExperimentalAPIWithParams:callback:	调用实验性 API。
updateUserName:callback:	更新用户的用户名。
updateUserAvatarUrl:callback:	更新用户的用户头像URL。
updateUserExtendedData:callback:	更新用户的用户扩展字段。
updateUserOfflinePushRule:callback:	修改离线推送的自定规则。
updateUserCustomStatus:callback:	用于更新用户自定义状态。
updateUserCustomStatus:config:callback:	更新用户的自定义状态。
updateUserBadge:callback:	更新 iOS 离线通知徽标数量。
queryUsersInfo:config:callback:	查询用户信息。
queryUsersStatusByUserIDs:callback:	批量查询其他用户的用户状态。
querySelfUserInfo:	查询自身用户信息、用户规则。
subscribeUsersStatus:config:callback:	订阅其他用户的用户状态。
unsubscribeUsersStatus:callback:	用于批量取消订阅当前用户订阅列表中的目标用户。
querySubscribedUserStatusListWithConfig:callback:	用于查询当前用户用户状态订阅列表。
zim:errorInfo:	错误信息回调。
zim:experimentalEventReceived:	实验性 API 回调。
zim:tokenWillExpire:	Token 将要过期的提醒回调。
zim:connectionStateChanged:event:extendedData:	连接状态发生改变的事件回调。
zim:userInfoUpdated:	用户信息更新的回调。
zim:userRuleUpdated:	用户规则变更的回调。
zim:userStatusUpdated:	用户在线状态变更通知。

会话功能

方法名	描述
queryConversationListWithConfig:callback:	查询会话列表。
queryConversationListWithConfig:option:callback:	查询会话列表。
queryConversation:conversationType:callback:	查询单个会话。
queryConversationPinnedListWithConfig:callback:	查询置顶会话列表。
updateConversationPinnedState:conversationID:conversationType:callback:	修改会话置顶状态。
deleteConversation:conversationType:config:callback:	删除会话。
deleteAllConversationsWithConfig:callback:	删除全部会话。
clearConversationUnreadMessageCount:conversationType:callback:	清除会话未读数。
clearConversationTotalUnreadMessageCount:	清除全部会话未读数。
queryConversationTotalUnreadMessageCountWithConfig:callback:	按照配置项查询会话未读消息总数。
setConversationNotificationStatus:conversationID:conversationType:callback:	设置会话通知状态。
sendConversationMessageReceiptRead:conversationType:callback:	设置会话所有已接收的回执已读。
setConversationDraft:conversationID:conversationType:callback:	设置会话草稿。
setConversationMark:enable:conversationInfos:callback:	设置或取消设置会话标记。
searchLocalConversationsWithConfig:callback:	基于本地消息搜索本地会话。
zim:conversationChanged:	收到会话更新的通知回调。
zim:conversationTotalUnreadMessageCountUpdated:	会话总未读数更新的通知回调。
zim:conversationMessageReceiptChanged:	收到回执的会话已读更新的通知回调。
zim:conversationsAllDeleted:	所有会话被删除时触发此回调。
zim:conversationSyncStateChanged:	会话列表与服务端的同步状态变更事件通知

消息功能

方法名	描述
sendMessage:toConversationID:conversationType:config:notification:callback:	发送消息。
downloadMediaFileWithMessage:fileType:config:progress:callback:	下载媒体文件的内容。
queryHistoryMessageByConversationID:conversationType:config:callback:	查询历史消息。
queryMessagesByMessageSeqs:conversationID:conversationType:callback:	批量查询指定序列号的会话消息。
deleteMessages:conversationID:conversationType:config:callback:	删除消息。
deleteAllMessageByConversationID:conversationType:config:callback:	通过会话ID删除消息。
deleteAllConversationMessagesWithConfig:callback:	删除所有会话的所有消息。
insertMessageToLocalDB:conversationID:conversationType:senderUserID:callback:	向本地 DB 插入一条消息。
sendMessageReceiptsRead:conversationID:conversationType:callback:	设置一批消息的回执变成已读。
queryMessageReceiptsInfoByMessageList:conversationID:conversationType:callback:	查询一批消息的回执信息。
revokeMessage:config:callback:	撤回消息。
updateMessageLocalExtendedData:message:callback:	更新消息的本地拓展字段。
editMessage:config:notification:callback:	编辑消息。
cancelSendingMessage:config:callback:	取消发送中的消息。
searchLocalMessagesByConversationID:conversationType:config:callback:	搜索本地消息列表。
searchGlobalLocalMessagesWithConfig:callback:	搜索全局本地消息列表。
addMessageReaction:message:callback:	增加消息表态
addMessageReaction:message:config:callback:	增加消息表态
deleteMessageReaction:message:callback:	删除消息表态
deleteMessageAllReactionsByMessage:callback:	删除自己在该消息下的所有表态
queryMessageReactionUserListByMessage:config:callback:	拉取消息表态用户列表
queryCombineMessageDetailByMessage:callback:	拉取合并消息详情
replyMessage:toOriginalMessage:config:notification:callback:	发送回复消息。
queryMessageRepliedListByMessage:config:callback:	查询回复列表。
pinMessage:isPinned:callback:	置顶或取消消息。
pinMessage:isPinned:config:callback:	置顶消息。
queryPinnedMessageListByConversationID:conversationType:callback:	查询置顶消息列表。
queryLocalFileCacheWithConfig:callback:	查询当前用户本地消息缓存。
clearLocalFileCacheWithConfig:callback:	清理当前用户本地消息缓存。
zim:peerMessageReceived:info:fromUserID:	接收单聊消息事件回调
zim:roomMessageReceived:info:fromRoomID:	接收房间消息事件回调
zim:groupMessageReceived:info:fromGroupID:	接收群消息事件回调
zim:messageReceivedWithResult:	接收消息事件回调
zim:broadcastMessageReceived:	接收广播消息事件回调
zim:messageSentStatusChanged:	消息发送状态改变事件回调
zim:messageReceiptChanged:	收到回执的消息已读更新的通知回调。
zim:messageRevokeReceived:	收到撤回消息的回调。
zim:messageReactionsChanged:	收到表态变更的回调。
zim:messageReactionsChangedWithResult:	消息的表态内容发生变更时的回调。
zim:messageDeleted:	消息删除事件回调
zim:messageRepliedInfoChanged:	消息的回复信息变更事件回调
zim:messageRepliedCountChanged:	消息的回复数量变更事件回调
zim:messageEdited:	消息编辑事件回调
zim:messagePinStatusChanged:	消息置顶事件回调

房间功能

方法名	描述
createRoom:callback:	创建并加入一个房间。
createRoom:config:callback:	创建带高级设置的房间。
joinRoom:callback:	加入一个房间。
enterRoom:config:callback:	进入房间。若房间不存在，则自动创建。
switchRoomFromRoomID:toRoomInfo:isCreateWhenRoomNotExisted:config:callback:	从一个房间切换至另一个房间，若房间不存在，会根据传入参数决定是否创建对应房间。
leaveRoom:callback:	离开一个房间。
leaveAllRoom:	离开所有已进入的房间。
queryRoomMemberListByRoomID:config:callback:	查询房间内的成员列表。
queryRoomMembersByUserIDs:roomID:callback:	查询指定房间中的特定 userID 的用户信息。
queryRoomOnlineMemberCountByRoomID:callback:	查询房间内在线成员的数量。
setRoomAttributes:roomID:config:callback:	设置房间属性（增加、改变房间属性均用此接口）。
deleteRoomAttributesByKeys:roomID:config:callback:	删除房间属性。
beginRoomAttributesBatchOperationWithRoomID:config:	开启组合房间属性操作。
endRoomAttributesBatchOperationWithRoomID:callback:	完成组合房间属性操作。
queryRoomAllAttributesByRoomID:callback:	查询房间所有属性。
setRoomMembersAttributes:userIDs:roomID:config:callback:	设置房间成员属性（增加、改变房间属性均用此接口）。
queryRoomMembersAttributesByUserIDs:roomID:callback:	批量查询房间内成员的房间用户属性。
queryRoomMemberAttributesListByRoomID:config:callback:	分页查询房间内拥有房间属性成员的房间用户属性。
zim:roomStateChanged:event:extendedData:roomID:	房间连接状态变更事件回调
zim:roomMemberJoined:roomID:	房间有成员加入事件回调
zim:roomMemberLeft:roomID:	房间有成员离开事件回调
zim:roomAttributesUpdated:roomID:	房间属性变更事件回调
zim:roomAttributesBatchUpdated:roomID:	房间属性批量变更事件回调
zim:roomMemberAttributesUpdated:operatedInfo:roomID:	房间成员属性变更事件回调

群组功能

方法名	描述
createGroup:userIDs:callback:	创建并加入一个群组。
createGroup:userIDs:config:callback:	创建并加入一个带群属性的群组。
dismissGroup:callback:	解散群组。
joinGroup:callback:	加入群组。
leaveGroup:callback:	离开群组。
inviteUsersIntoGroup:groupID:callback:	邀请用户进入群组。
kickGroupMembers:groupID:callback:	踢出群组成员。
transferGroupOwnerToUserID:groupID:callback:	转让群主。
queryGroupInfoByGroupID:callback:	查询群组信息。
queryGroupMemberInfoByUserID:groupID:callback:	查询群成员信息。
queryGroupList:	查询群列表。
queryGroupListWithCount:config:callback:	查询群列表。
queryGroupMemberListByGroupID:config:callback:	查询群成员列表。
queryGroupMemberCountByGroupID:callback:	查询指定群内的群成员数量。
updateGroupName:groupID:callback:	更新群名称。
updateGroupAvatarUrl:groupID:callback:	更新群头像 URL。
updateGroupNotice:groupID:callback:	更新群公告。
updateGroupAlias:groupID:callback:	更新群备注。
updateGroupJoinMode:groupID:callback:	更新入群模式。
updateGroupInviteMode:groupID:callback:	更新邀请模式。
updateGroupBeInviteMode:groupID:callback:	更新邀请目标验证模式。
setGroupAttributes:groupID:callback:	设置群属性。
deleteGroupAttributesByKeys:groupID:callback:	删除群属性。
queryGroupAttributesByKeys:groupID:callback:	查询群属性。
queryGroupAllAttributesByGroupID:callback:	查询群组全部属性。
setGroupMemberRole:forUserID:groupID:callback:	设置群成员角色。
setGroupMemberNickname:forUserID:groupID:callback:	设置群成员昵称。
muteGroup:groupID:config:callback:	禁言群组。
muteGroupMembers:userIDs:groupID:config:callback:	禁言群成员。
queryGroupMemberMutedListByGroupID:config:callback:	查询群禁言成员列表。
queryGroupMessageReceiptReadMemberListByMessage:groupID:config:callback:	查询群消息已读成员列表。
queryGroupMessageReceiptUnreadMemberListByMessage:groupID:config:callback:	查询群消息未读成员列表。
searchLocalGroupsWithConfig:callback:	搜索本地群组。
searchLocalGroupMembersByGroupID:config:callback:	搜索本地群成员。
sendGroupJoinApplicationToGroupID:config:callback:	发送加群申请。
acceptGroupJoinApplicationFromUserID:groupID:config:callback:	同意加群申请。
rejectGroupJoinApplicationFromUserID:groupID:config:callback:	拒绝加群申请。
sendGroupInviteApplicationsToUserIDs:groupID:config:callback:	发送邀请入群申请。
acceptGroupInviteApplicationFromInviterUserID:groupID:config:callback:	同意邀请入群申请。
rejectGroupInviteApplicationFromInviterUserID:groupID:config:callback:	拒绝邀请入群申请。
queryGroupApplicationListWithConfig:callback:	查询入群申请列表。
zim:groupStateChanged:event:operatedInfo:groupInfo:	群状态变更事件回调
zim:groupNameUpdated:operatedInfo:groupID:	群名称变更事件回调
zim:groupAvatarUrlUpdated:operatedInfo:groupID:	群头像变更事件回调
zim:groupNoticeUpdated:operatedInfo:groupID:	群公告变更事件回调
zim:groupAliasUpdated:operatedUserID:groupID:	群别名变更事件回调
zim:groupAttributesUpdated:operatedInfo:groupID:	群属性变更事件回调
zim:groupMutedInfoUpdated:operatedInfo:groupID:	群禁言事件回调
zim:groupVerifyInfoUpdated:operatedInfo:groupID:	群验证信息变更事件回调
zim:groupMemberStateChanged:event:userList:operatedInfo:groupID:	群成员状态变更事件回调
zim:groupMemberInfoUpdated:operatedInfo:groupID:	群成员信息变更事件回调
zim:groupApplicationListChanged:action:	群申请列表变更事件回调
zim:groupApplicationUpdated:	群申请信息变更事件回调

呼叫邀请功能

方法名	描述
callInviteWithInvitees:config:callback:	发起呼叫邀请。
callCancelWithInvitees:callID:config:callback:	取消呼叫邀请。
callAcceptWithCallID:config:callback:	接受呼叫邀请。
callRejectWithCallID:config:callback:	拒绝呼叫邀请。
callingInviteWithInvitees:callID:config:callback:	邀请其他用户加入呼叫邀请。
callJoin:config:callback:	加入进阶模式呼叫，或者切换进阶模式呼叫的主设备（仅限多端登录）
callQuit:config:callback:	退出当前呼叫邀请。
callEnd:config:callback:	结束呼叫邀请。
queryCallInvitationListWithConfig:callback:	查询呼叫邀请列表。
zim:callInvitationCreated:callID:	呼叫邀请创建事件回调
zim:callInvitationReceived:callID:	呼叫邀请接收事件回调
zim:callInvitationCancelled:callID:	呼叫邀请取消事件回调
zim:callInvitationEnded:callID:	呼叫邀请结束事件回调
zim:callInvitationTimeout:callID:	呼叫邀请超时事件回调
zim:callUserStateChanged:callID:	呼叫邀请用户状态变更事件回调

好友功能

方法名	描述
addFriendByUserID:config:callback:	直接添加好友。
deleteFriendsByUserIDs:config:callback:	批量删除好友。
checkFriendsRelationByUserIDs:config:callback:	检查好友关系。
updateFriendAlias:userID:callback:	更新好友备注。
updateFriendAttributes:userID:callback:	更新好友属性。
queryFriendsInfoByUserIDs:callback:	批量查询好友信息。
queryFriendListWithConfig:callback:	查询好友列表。
searchLocalFriendsWithConfig:callback:	搜索本地好友。
sendFriendApplicationToUserID:config:callback:	发送好友申请。
acceptFriendApplicationFromUserID:config:callback:	接受好友申请。
rejectFriendApplicationFromUserID:config:callback:	拒绝好友申请。
queryFriendApplicationListWithConfig:callback:	查询好友申请列表。
zim:friendListChanged:action:	好友列表变更事件回调
zim:friendInfoUpdated:	好友信息变更事件回调
zim:friendApplicationListChanged:action:	好友申请列表变更事件回调
zim:friendApplicationUpdated:	好友申请信息变更事件回调

黑名单功能

方法名	描述
addUsersToBlacklistWithUserIDs:callback:	添加用户到黑名单。
removeUsersFromBlacklistWithUserIDs:callback:	将用户移除出黑名单。
queryBlacklistWithConfig:callback:	查询黑名单。
checkUserIsInBlacklistByUserID:callback:	检查用户是否在黑名单。
zim:blacklistChanged:action:	黑名单变更事件回调

社群功能

方法名	描述
createCommunityWithCommunityInfo:config:callback:	创建社群。
dismissCommunityByCommunityID:callback:	解散社群。
joinCommunityWithCommunityID:callback:	加入社群。
leaveCommunityByCommunityID:callback:	退出社群。
inviteUsersIntoCommunityWithUserIDs:communityID:callback:	邀请用户加入社群。
kickCommunityMembersByUserIDs:communityID:callback:	移出社群成员。
queryCommunityListWithCount:config:callback:	查询社群列表。
updateCommunityName:communityID:callback:	更新社群名称。
updateCommunityAvatarUrl:communityID:callback:	更新社群头像 URL。
updateCommunityNotice:communityID:callback:	更新社群公告。
setCommunityAttributes:communityID:callback:	设置社群属性。
deleteCommunityAttributesByKeys:communityID:callback:	删除社群属性。
setCommunityNotificationStatus:communityID:callback:	设置社群消息通知状态。
queryCommunityInfoByCommunityID:callback:	查询社群信息。
updateCommunityMemberRole:forUserID:communityID:callback:	更新社群成员角色。
transferCommunityOwnerToUserID:communityID:callback:	转让社群所有者。
queryCommunityMemberListByCommunityID:count:config:callback:	查询社群成员列表。
queryCommunityMembersByUserIDs:communityID:callback:	查询指定社群成员信息。
createCommunityChannelWithChannelInfo:config:callback:	创建社群频道。
dismissCommunityChannelByChannelID:communityID:callback:	解散社群频道。
updateCommunityChannelName:channelID:communityID:callback:	更新社群频道名称。
updateCommunityChannelAvatarUrl:channelID:communityID:callback:	更新社群频道头像 URL。
updateCommunityChannelNotice:channelID:communityID:callback:	更新社群频道公告。
setCommunityChannelAttributes:channelID:communityID:callback:	设置社群频道属性。
deleteCommunityChannelAttributesByKeys:channelID:communityID:callback:	删除社群频道属性。
queryCommunityChannelsInfoByChannelIDs:communityID:callback:	查询社群频道信息。
queryCommunityChannelListByCommunityID:count:config:callback:	查询社群频道列表。
muteCommunityChannels:channelIDs:communityID:config:callback:	禁言社群频道。
muteCommunityMembers:userIDs:communityID:config:callback:	禁言社群成员。
zim:communityListChangedWithResult:	社群列表发生变更时触发此回调。
zim:communityInfoUpdatedWithResult:	社群信息更新时触发此回调。
zim:communityMemberStateChangedWithResult:	社群成员状态发生变更时触发此回调。
zim:communityMemberInfoUpdatedWithResult:	社群成员信息更新时触发此回调。
zim:communityChannelListChangedWithResult:	社群频道列表发生变更时触发此回调。
zim:communityChannelInfoUpdatedWithResult:	社群频道信息更新时触发此回调。