Function Overview

2026-07-24

ZEGO ZIM SDKs provide rich APIs for you to quickly build in app chat capabilities into your applications.

ZEGO ZIM SDKs are available for all major platforms, including Android, iOS, Mac, Windows, and Web.

Method	Description
getVersion	Gets the SDK's version number.
createWithAppConfig:	Create a ZIM instance.
getInstance	Get the ZIM singleton object.
setAdvancedConfigWithKey:value:	Set ZIM advanced configuration.
setGeofencingConfigWithAreaList:type:	Set geofence-related configurations.
setLogConfig:	Set log related configuration.
setCacheConfig:	Set cache related configuration.
setCustomDispatchQueue	Set a custom GCD dispatch queue.
destroy	Destroy the ZIM instance.
setEventHandler:	Set the event notification callbacks that need to be handled. If the eventHandler is set to [null], all the callbacks set previously will be cleared.
uploadLog:	Upload log and call after setting up log path.
loginWithUserID:config:callback:	Login, you must log in before using all functions.
logout	Log out of ZIM service.
renewToken:callback:	Update the authentication token.
callExperimentalAPIWithParams:callback:	Call the experimental API.
updateUserName:callback:	Update user's user name.
updateUserAvatarUrl:callback:	Update user's avatar URL.
updateUserExtendedData:callback:	Update user's user extended data.
updateUserOfflinePushRule:callback:	Update user's custom rule of offline push.
updateUserCustomStatus:callback:	It is used to update the user-defined status.
updateUserCustomStatus:config:callback:	Update user's custom status.
updateUserBadge:callback:	Update the number of iOS offline notification badges.
queryUsersInfo:config:callback:	Query user information.
queryUsersStatusByUserIDs:callback:	Query the user statuses of other users.
querySelfUserInfo:	Query user information and user rules.
subscribeUsersStatus:config:callback:	Subscribe to the user status of other users
unsubscribeUsersStatus:callback:	This command is used to batch unsubscribe the target users in the current user subscription list.
querySubscribedUserStatusListWithConfig:callback:	This command is used to query the user status subscription list of the current user.
zim:errorInfo:	The callback for error information.
zim:experimentalEventReceived:	Experimental API callback.
zim:tokenWillExpire:	A reminder callback that the token is about to expire.
zim:connectionStateChanged:event:extendedData:	The event callback when the connection state changes.
zim:userInfoUpdated:	In the multi-terminal login scenario, after the user modifies their information on device A, other online multi-terminal devices will receive this callback. For offline devices, after the user goes online, they need to call the [queryUsersInfo] interface to actively query user information.
zim:userRuleUpdated:	Triggered when the user rule changes.
zim:userStatusUpdated:	User online status change notification.

Conversation functions

Method	Description
queryConversationListWithConfig:callback:	Query the conversation list.
queryConversationListWithConfig:option:callback:	Query the conversation list.
queryConversation:conversationType:callback:	Query a conversation by conversation ID and conversation type.
queryConversationPinnedListWithConfig:callback:	Query the conversation pinned list.
updateConversationPinnedState:conversationID:conversationType:callback:	Modify the conversation pinned state.
deleteConversation:conversationType:config:callback:	delete the conversation.
deleteAllConversationsWithConfig:callback:	delete all conversations.
clearConversationUnreadMessageCount:conversationType:callback:	clear session unreads.
clearConversationTotalUnreadMessageCount:	clear all conversations unreads.
queryConversationTotalUnreadMessageCountWithConfig:callback:	Query the conversations total unread message count by config.
setConversationNotificationStatus:conversationID:conversationType:callback:	Set the conversation notification state.
sendConversationMessageReceiptRead:conversationType:callback:	Sets all received receipts for the conversation as read.
setConversationDraft:conversationID:conversationType:callback:	Set a conversation draft.
setConversationMark:enable:conversationInfos:callback:	Set the conversation marked status.
setConversationMessageDestructDuration:conversationID:conversationType:callback:	Set the timed message self-destruction duration for a conversation.
searchLocalConversationsWithConfig:callback:	Search local conversations on local messages.
zim:conversationChanged:	Received notification callback for session update.
zim:conversationTotalUnreadMessageCountUpdated:	Received notification callback for session update.
zim:conversationMessageReceiptChanged:	Received notification callback when the message receiver has read this receipt message.
zim:conversationsAllDeleted:	When multiple login ends delete all sessions, the local end triggers the callback to notify the local end that all sessions are deleted.
zim:conversationSyncStateChanged:	Notification of synchronization status change events between the conversation list and the server

Message functions

Method	Description
sendMessage:toConversationID:conversationType:config:notification:callback:	send message.
downloadMediaFileWithMessage:fileType:config:progress:callback:	Download media file message content.
queryHistoryMessageByConversationID:conversationType:config:callback:	Query historical messages.
queryMessagesByMessageSeqs:conversationID:conversationType:callback:	Query messages based on the message seq list.
deleteMessages:conversationID:conversationType:config:callback:	delete message.
deleteAllMessageByConversationID:conversationType:config:callback:	Delete all message.
deleteAllConversationMessagesWithConfig:callback:	Delete all messages for all conversations.
insertMessageToLocalDB:conversationID:conversationType:senderUserID:callback:	Insert a message to the local DB.
sendMessageReceiptsRead:conversationID:conversationType:callback:	Set the receipt of a batch of messages to become read.
queryMessageReceiptsInfoByMessageList:conversationID:conversationType:callback:	Query the receipt information of a batch of messages.
revokeMessage:config:callback:	revoke message.
updateMessageLocalExtendedData:message:callback:	Update the local expandable field of the message.
editMessage:config:notification:callback:	Edit message.
cancelSendingMessage:config:callback:	Cancels sending of media message.
searchLocalMessagesByConversationID:conversationType:config:callback:	Search local message list.
searchGlobalLocalMessagesWithConfig:callback:	Search global local message list.
addMessageReaction:message:callback:	add message reaction
addMessageReaction:message:config:callback:	add message reaction
deleteMessageReaction:message:callback:	delete message reaction
deleteMessageAllReactionsByMessage:callback:	Delete all of your reactions under this message
queryMessageReactionUserListByMessage:config:callback:	query message reaction userlist
queryCombineMessageDetailByMessage:callback:	query combine message detail
replyMessage:toOriginalMessage:config:notification:callback:	send reply message.
queryMessageRepliedListByMessage:config:callback:	Query message replied list.
pinMessage:isPinned:callback:	Pin or unpin message.
pinMessage:isPinned:config:callback:	Pin message.
queryPinnedMessageListByConversationID:conversationType:callback:	Query pinned message list.
queryLocalFileCacheWithConfig:callback:	Query the local message cache of the current user.
clearLocalFileCacheWithConfig:callback:	Clear the local message cache of the current user.
zim:peerMessageReceived:info:fromUserID:	The callback for receiving peer-to-peer message.
zim:roomMessageReceived:info:fromRoomID:	The callback for receiving room message.
zim:groupMessageReceived:info:fromGroupID:	The callback for receiving group message.
zim:messageReceivedWithResult:	The callback for receiving message.
zim:broadcastMessageReceived:	The callback for receiving broadcast message.
zim:messageSentStatusChanged:	The callback for message sent status changed.
zim:messageReceiptChanged:	Received notification callback when the message receiver confirms that the message has been read.
zim:messageRevokeReceived:	Received notification callback when some one else sends a message and then revoke a message sent by themselves.
zim:messageReactionsChanged:	The callback is received when reactions change
zim:messageReactionsChangedWithResult:	The callback is received when reactions change
zim:messageDeleted:	The callback is received when a message is deleted.
zim:messageRepliedInfoChanged:	The callback is received when the message replied information changes.
zim:messageRepliedCountChanged:	The callback is received when the message replied count changes.
zim:messageEdited:	The callback is received when a message is edited.
zim:messagePinStatusChanged:	The callback is received when a message is pinned.

Room functions

Method	Description
createRoom:callback:	Create and join a room.
createRoom:config:callback:	Create a room with advanced settings
joinRoom:callback:	Join a room.
enterRoom:config:callback:	Enter the room. If the room does not exist, it will be created automatically.
switchRoomFromRoomID:toRoomInfo:isCreateWhenRoomNotExisted:config:callback:	Switch from one room to another. If the room does not exist, it will decide whether to create the corresponding room based on the passed parameters.
leaveRoom:callback:	Leave a room.
leaveAllRoom:	Leave all rooms entered.
queryRoomMemberListByRoomID:config:callback:	Query the list of members in the room.
queryRoomMembersByUserIDs:roomID:callback:	Query the information of the specified userID in the specified room.
queryRoomOnlineMemberCountByRoomID:callback:	Query the number of online members in the room.
setRoomAttributes:roomID:config:callback:	Set room attributes (use this for all additions and changes).
deleteRoomAttributesByKeys:roomID:config:callback:	Delete room attributes.
beginRoomAttributesBatchOperationWithRoomID:config:	Open combination room attribute operation.
endRoomAttributesBatchOperationWithRoomID:callback:	Complete the property operation of the combined room.
queryRoomAllAttributesByRoomID:callback:	Query all properties of the room.
setRoomMembersAttributes:userIDs:roomID:config:callback:	Set room member attributes (use this for all additions and changes).
queryRoomMembersAttributesByUserIDs:roomID:callback:	Batch query the room user attributes of the members in the room.
queryRoomMemberAttributesListByRoomID:config:callback:	paginate the room user properties that have room property members in the room.
zim:roomStateChanged:event:extendedData:roomID:	The event callback when the room connection status changes.
zim:roomMemberJoined:roomID:	Callback when other members join the room.
zim:roomMemberLeft:roomID:	Callback when other members leave the room.
zim:roomAttributesUpdated:roomID:	Event callback when the room attributes changes.
zim:roomAttributesBatchUpdated:roomID:	Event callback when the room attributes batch changes.
zim:roomMemberAttributesUpdated:operatedInfo:roomID:	Event callback when the room member attributes changes.

Group functions

Method	Description
createGroup:userIDs:callback:	Create groups.
createGroup:userIDs:config:callback:	Create a group with the andvanced info such as group attributes and group notice.
dismissGroup:callback:	Dismiss the group.
joinGroup:callback:	Join a group.
leaveGroup:callback:	Leave the group.
inviteUsersIntoGroup:groupID:callback:	invite some members into the group.
kickGroupMembers:groupID:callback:	kick some members out of the group.
transferGroupOwnerToUserID:groupID:callback:	Transfer the group owner.
queryGroupInfoByGroupID:callback:	Query group information.
queryGroupMemberInfoByUserID:groupID:callback:	Query group member information.
queryGroupList:	Query the group list.
queryGroupListWithCount:config:callback:	Query the group list.
queryGroupMemberListByGroupID:config:callback:	Query the list of group members.
queryGroupMemberCountByGroupID:callback:	Query the number of group members in a specified group.
updateGroupName:groupID:callback:	Update the group name.
updateGroupAvatarUrl:groupID:callback:	Update the group avatar URL.
updateGroupNotice:groupID:callback:	Update group announcements.
updateGroupAlias:groupID:callback:	Update the group alias.
updateGroupJoinMode:groupID:callback:	Update group verification mode.
updateGroupInviteMode:groupID:callback:	Update group verification mode.
updateGroupBeInviteMode:groupID:callback:	Update group verification mode.
setGroupAttributes:groupID:callback:	Add or update group attributes.
deleteGroupAttributesByKeys:groupID:callback:	Delete group attributes.
queryGroupAttributesByKeys:groupID:callback:	Query group attributes by keys.
queryGroupAllAttributesByGroupID:callback:	Query all attributes of the group.
setGroupMemberRole:forUserID:groupID:callback:	Set the group member role.
setGroupMemberNickname:forUserID:groupID:callback:	Set the group member nickname.
muteGroup:groupID:config:callback:	Mute a group.
muteGroupMembers:userIDs:groupID:config:callback:	Mute group members.
queryGroupMemberMutedListByGroupID:config:callback:	Query the list of group muted members.
queryGroupMessageReceiptReadMemberListByMessage:groupID:config:callback:	Query the list of group message read members.
queryGroupMessageReceiptUnreadMemberListByMessage:groupID:config:callback:	Query the list of group message unread members.
queryGroupMessageReceiptMemberListByMessage:groupID:count:config:callback:	Query the receipt member list of a group message.
searchLocalGroupsWithConfig:callback:	Search local groups.
searchLocalGroupMembersByGroupID:config:callback:	Search local group members.
sendGroupJoinApplicationToGroupID:config:callback:	Send an application to join the group.
acceptGroupJoinApplicationFromUserID:groupID:config:callback:	Accept an application to join the group.
rejectGroupJoinApplicationFromUserID:groupID:config:callback:	Reject an application to join the group.
sendGroupInviteApplicationsToUserIDs:groupID:config:callback:	Send an application to invite the group.
acceptGroupInviteApplicationFromInviterUserID:groupID:config:callback:	Accept an application to invite to the group.
rejectGroupInviteApplicationFromInviterUserID:groupID:config:callback:	Reject an application to invite to the group.
queryGroupApplicationListWithConfig:callback:	Query the group application list.
zim:groupStateChanged:event:operatedInfo:groupInfo:	Event callback when the group state changes.
zim:groupNameUpdated:operatedInfo:groupID:	Event callback when the group name changes.
zim:groupAvatarUrlUpdated:operatedInfo:groupID:	Event callback when the group avatar changes.
zim:groupNoticeUpdated:operatedInfo:groupID:	Event callback when the group notice changes.
zim:groupAliasUpdated:operatedUserID:groupID:	Event callback when the group alias changes.
zim:groupAttributesUpdated:operatedInfo:groupID:	Event callback when the group attributes change.
zim:groupMutedInfoUpdated:operatedInfo:groupID:	Event callback when the group is muted.
zim:groupVerifyInfoUpdated:operatedInfo:groupID:	Event callback when the group verification information changes.
zim:groupMemberStateChanged:event:userList:operatedInfo:groupID:	Event callback when the group member status changes.
zim:groupMemberInfoUpdated:operatedInfo:groupID:	Event callback when the group member information changes.
zim:groupApplicationListChanged:action:	Event callback when the group application list changes.
zim:groupApplicationUpdated:	Event callback when the group application information changes.

Call Invitation functions

Method	Description
callInviteWithInvitees:config:callback:	Initiate a call invitation.
callCancelWithInvitees:callID:config:callback:	Cancel the call invitation.
callAcceptWithCallID:config:callback:	Accept the call invitation.
callRejectWithCallID:config:callback:	Reject the call invitation.
callingInviteWithInvitees:callID:config:callback:	Invite other users to join the call invitation.
callJoin:config:callback:	Join an advanced mode call, or switch the main device for the advanced mode call (multi-terminal login only).
callQuit:config:callback:	Quit the current call invitation.
callEnd:config:callback:	End the call invitation.
queryCallInvitationListWithConfig:callback:	Query the call invitation list.
zim:callInvitationCreated:callID:	Event callback when the call invitation is created.
zim:callInvitationReceived:callID:	Event callback when the call invitation is received.
zim:callInvitationCancelled:callID:	Event callback when the call invitation is cancelled.
zim:callInvitationEnded:callID:	Event callback when the call invitation is ended.
zim:callInvitationTimeout:callID:	Event callback when the call invitation times out.
zim:callUserStateChanged:callID:	Event callback when the call invitation user status changes.

Friend functions

Method	Description
addFriendByUserID:config:callback:	Add friends directly.
deleteFriendsByUserIDs:config:callback:	Delete friends.
checkFriendsRelationByUserIDs:config:callback:	Check friend relationships.
updateFriendAlias:userID:callback:	Update friend alias.
updateFriendAttributes:userID:callback:	Update friend attributes.
queryFriendsInfoByUserIDs:callback:	Query friend information in batches.
queryFriendListWithConfig:callback:	Query the friends list.
searchLocalFriendsWithConfig:callback:	Search local friends.
sendFriendApplicationToUserID:config:callback:	Send a friend application.
acceptFriendApplicationFromUserID:config:callback:	Accept a friend application.
rejectFriendApplicationFromUserID:config:callback:	Reject a friend application.
queryFriendApplicationListWithConfig:callback:	Query the friend application list.
zim:friendListChanged:action:	Event callback when the friend list changes.
zim:friendInfoUpdated:	Event callback when the friend information changes.
zim:friendApplicationListChanged:action:	Event callback when the friend application list changes.
zim:friendApplicationUpdated:	Event callback when the friend application information changes.

Blacklist functions

Method	Description
addUsersToBlacklistWithUserIDs:callback:	Add users to the blacklist.
removeUsersFromBlacklistWithUserIDs:callback:	Remove the user from the blacklist.
queryBlacklistWithConfig:callback:	Query the blacklist.
checkUserIsInBlacklistByUserID:callback:	Check if the user is on the blacklist.
zim:blacklistChanged:action:	Event callback when the blacklist changes.

Community functions

Method	Description
createCommunityWithCommunityInfo:config:callback:	Create a community.
dismissCommunityByCommunityID:callback:	Dismiss a community.
joinCommunityWithCommunityID:callback:	Join a community.
leaveCommunityByCommunityID:callback:	Leave a community.
inviteUsersIntoCommunityWithUserIDs:communityID:callback:	Invite users into a community.
kickCommunityMembersByUserIDs:communityID:callback:	Kick members from a community.
queryCommunityListWithCount:config:callback:	Query the community list.
updateCommunityName:communityID:callback:	Update the community name.
updateCommunityAvatarUrl:communityID:callback:	Update the community avatar URL.
updateCommunityNotice:communityID:callback:	Update the community notice.
setCommunityAttributes:communityID:callback:	Set community attributes.
deleteCommunityAttributesByKeys:communityID:callback:	Delete community attributes.
setCommunityNotificationStatus:communityID:callback:	Set the community notification status.
queryCommunityInfoByCommunityID:callback:	Query community information.
updateCommunityMemberRole:forUserID:communityID:callback:	Update a community member's role.
transferCommunityOwnerToUserID:communityID:callback:	Transfer the community owner.
queryCommunityMemberListByCommunityID:count:config:callback:	Query the community member list.
queryCommunityMembersByUserIDs:communityID:callback:	Query specific community members' information.
createCommunityChannelWithChannelInfo:config:callback:	Create a community channel.
dismissCommunityChannelByChannelID:communityID:callback:	Dismiss a community channel.
updateCommunityChannelName:channelID:communityID:callback:	Update the community channel name.
updateCommunityChannelAvatarUrl:channelID:communityID:callback:	Update the community channel avatar URL.
updateCommunityChannelNotice:channelID:communityID:callback:	Update the community channel notice.
setCommunityChannelAttributes:channelID:communityID:callback:	Set community channel attributes.
deleteCommunityChannelAttributesByKeys:channelID:communityID:callback:	Delete community channel attributes.
queryCommunityChannelsInfoByChannelIDs:communityID:callback:	Query community channel information.
queryCommunityChannelListByCommunityID:count:config:callback:	Query the community channel list.
muteCommunityChannels:channelIDs:communityID:config:callback:	Mute community channels.
muteCommunityMembers:userIDs:communityID:config:callback:	Mute community members.
zim:communityListChangedWithResult:	Received notification callback for community list changed.
zim:communityInfoUpdatedWithResult:	Received notification callback for community info updated.
zim:communityMemberStateChangedWithResult:	.
zim:communityMemberInfoUpdatedWithResult:	.
zim:communityChannelListChangedWithResult:	Received notification callback for community channel list changed.
zim:communityChannelInfoUpdatedWithResult:	Received notification callback for community info updated.