文档中心
即时通讯
客户端 API
功能总览

功能总览

更新时间：2024-11-06 18:13

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

API 返回的错误码，请参考 https://doc-zh.zego.im/article/11606。

初始化相关的前置功能

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

房间功能

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

消息功能

方法名	描述
sendMessage:message:toConversationID:conversationType:config:notification:callback:	发送消息。
sendMediaMessage:message:toConversationID:conversationType:config:notification:callback:	发送媒体消息。
insertMessageToLocalDB:message:conversationID:conversationType:senderUserID:callback:	向本地 DB 插入一条消息。
clearLocalFileCacheWithConfig:config:callback:	清理当前用户本地消息缓存。
queryLocalFileCacheWithConfig:config:callback:	查询当前用户本地消息缓存。
exportLocalMessagesToFolderPath:folderPath:config:progress:callback:	导出当前用户本地消息。
importLocalMessagesToFolderPath:folderPath:config:progress:callback:	导入当前用户本地消息。
sendConversationMessageReceiptRead:conversationID:conversationType:callback:	设置会话所有已接收的回执已读。
sendMessageReceiptsRead:messageList:conversationID:conversationType:callback:	设置一批消息的回执变成已读。
queryMessageReceiptsInfoByMessageList:messageList:conversationID:conversationType:callback:	查询一批消息的回执信息。
queryGroupMessageReceiptReadMemberListByMessage:message:groupID:config:callback:	查询群消息已读成员列表。
queryGroupMessageReceiptUnreadMemberListByMessage:message:groupID:config:callback:	查询群消息未读成员列表。
searchLocalMessagesByConversationID:conversationID:conversationType:config:callback:	搜索本地消息列表。
searchLocalConversationsWithConfig:config:callback:	基于本地消息搜索本地会话。
searchGlobalLocalMessagesWithConfig:config:callback:	搜索全局本地消息列表。
replyMessage:message:toOriginalMessage:config:notification:callback:	发送回复消息。
queryMessageRepliedListByMessage:message:config:callback:	查询回复列表。
sendMediaMessage:message:toConversationID:conversationType:config:progress:callback:	发送媒体消息。
downloadMediaFileWithMessage:message:fileType:progress:callback:	下载媒体消息内容。
sendPeerMessage:message:toUserID:config:callback:	发送点对点消息。
sendRoomMessage:message:toRoomID:config:callback:	发送房间消息。
sendGroupMessage:message:toGroupID:config:callback:	发送群组消息。
queryHistoryMessageByConversationID:conversationType:config:callback:	查询历史消息。
queryMessagesByMessageSeqs:messageSeqs:conversationID:conversationType:callback:	根据消息seq列表查询消息。
deleteAllConversationMessagesWithConfig:config:callback:	删除所有会话的所有消息。
queryCombineMessageDetailByMessage:message:callback:	拉取合并消息详情
revokeMessage:message:config:callback:	撤回消息。
deleteMessages:messageList:conversationID:conversationType:config:callback:	删除消息。
addMessageReaction:reactionType:message:callback:	增加消息表态
deleteMessageReaction:reactionType:message:callback:	删除消息表态
queryMessageReactionUserListByMessage:message:config:callback:	拉取消息表态用户列表
deleteAllMessageByConversationID:conversationID:conversationType:config:callback:	通过会话ID删除消息。
updateMessageLocalExtendedData:localExtendedData:message:callback:	更新消息的本地拓展字段。
zim:groupMessageReceived:info:fromGroupID:	收到群消息的回调。
zim:peerMessageReceived:info:fromUserID:	收到单聊消息的回调。
zim:roomMessageReceived:info:fromRoomID:	收到房间消息的回调。
zim:messageRevokeReceived:	收到撤回消息的回调。
zim:messageSentStatusChanged:	收到消息发送状态变化的回调。
zim:broadcastMessageReceived:	收到全员推送消息的回调。
zim:messageReactionsChanged:	收到表态变更的回调。
zim:messageDeleted:	消息被删除的回调。
zim:receivePeerMessage:fromRoomID:	收到点对点消息的回调。
zim:messageRepliedCountChanged:	回复消息树的数量发生变更的事件。
zim:messageRepliedInfoChanged:	回复消息的回复信息的变更事件。
zim:receiveGroupMessage:fromGroupID:	收到群消息的回调。

群组功能

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

会话功能

方法名	描述
queryConversation:conversationID:conversationType:callback:	查询单个会话。
queryConversationListWithConfig:callback:	查询会话列表。
queryConversationListWithConfig:callback:	按照过滤项查询会话列表。
queryConversationPinnedListWithConfig:config:callback:	查询置顶会话列表。
queryConversationTotalUnreadMessageCountWithConfig:callback:	按照配置项查询会话未读消息总数。
updateConversationPinnedState:isPinned:conversationID:conversationType:callback:	修改会话置顶状态。
deleteAllConversationsWithConfig:config:callback:	删除全部会话。
deleteConversation:conversationType:config:callback:	删除会话。
setConversationDraft:draft:conversationID:conversationType:callback:	设置会话草稿。
clearConversationTotalUnreadMessageCount:callback:	清除全部会话未读数。
clearConversationUnreadMessageCount:conversationType:config:callback:	清除会话未读数。
setConversationMark:markType:enable:conversationInfos:callback:	设置或取消设置会话标记。
setConversationNotificationStatus:conversationID:conversationType:callback:	设置会话通知状态。
zim:conversationChanged:	收到会话更新的通知回调。
zim:conversationMessageReceiptChanged:	收到回执的会话已读更新的通知回调。
conversationsAllDeleted:zim:info:	收到全部会话删除的通知回调。
zim:messageReceiptChanged:	收到回执的消息已读更新的通知回调。
zim:conversationTotalUnreadMessageCountUpdated:	会话总未读数更新的通知回调。

呼叫邀请功能

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

离线推送功能（需单独集成）

方法名	描述
addLocalNotificationWithContent:content:trigger:completionHandler:	添加一条本地推送。
ZPNsNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:	当用户点击远程推送进入 APP 时，触发此回调方法。
onRegistered:Pushid:	生成 PushID 后触发的回调。
registerAPNs	向 APNs 注册。
setBadge:badge:	通过该接口向 ZPNs 服务器上报当前 App 的角标数。
setDeviceToken:isProduct:	使用该方法将 deviceToken 传入 ZPNs 并得到 PushID。
setPushConfig:	设置各家厂商的推送设置项。
setVoIPToken:voIPtoken:isProduct:	用于向 ZPNs 上传从系统获得的 VoIP 推送 token。
setZPNsNotificationCenterDelegate:delegate:	设置事件通知回调，传 [null] 则清空已设置的回调。
shared	获得 ZPNs 实例。
ZPNsNotificationCenter:willPresentNotification:userInfo:withCompletionHandler:	应用在前台收到推送时会触发此回调方法。
unregisterAPNs	不需要离线推送时可调用此方法反注册。

黑名单功能

方法名	描述
addUsersToBlacklistWithUserIDs:userIDs:callback:	添加用户到黑名单。
removeUsersFromBlacklistWithUserIDs:userIDs:callback:	将用户移除出黑名单。
queryBlacklistWithConfig:config:callback:	查询黑名单。
checkUserIsInBlackListByUserID:userID:callback:	检查用户是否在黑名单。

好友功能

方法名	描述
addFriendByUserID:userID:config:callback:	直接添加好友。
sendFriendApplicationToUserID:userID:config:callback:	发送好友申请。
deleteFriendsByUserIDs:userIDs:config:callback:	批量删除好友。
checkFriendsRelationByUserIDs:userIDs:config:callback:	检查好友关系。
updateFriendAlias:friendAlias:userID:callback:	更新好友备注。
updateFriendAttributes:friendAttributes:userID:callback:	更新好友属性。
acceptFriendApplicationFromUserID:userID:config:callback:	接受好友申请。
rejectFriendApplicationFromUserID:userID:config:callback:	拒绝好友申请。
queryFriendsInfoByUserIDs:userIDs:callback:	批量查询好友信息。
queryFriendListWithConfig:config:callback:	查询好友列表。
queryFriendApplicationListWithConfig:config:callback:	查询好友申请列表。
searchLocalFriendsWithConfig:config:callback:	搜索本地好友。
zim:friendListChanged:friendInfoList:	当好友列表发生变化时会回调当前方法
zim:friendApplicationListChanged:friendApplicationInfoList:	当好友申请列表发生变化时会回调当前方法
zim:friendApplicationUpdated:friendApplicationInfoList:	当好友申请列表发生更新时会回调当前方法
zim:friendInfoUpdated:friendInfoList:	当好友信息更新时候会触发该回调。

语音组件（需单独集成）

方法名	描述
getVersion	获取 ZIM Audio SDK 版本号
setAdvancedConfigWithKey:key:value:	实现高级配置
sharedInstance	获取单例对象。
initWithLicense:license:	初始化 ZIM Audio SDK
uninit	反初始化 ZIM Audio SDK
setEventHandler:eventHandler:	设置 ZIM Audio SDK 事件通知回调
enableANS:enable:	开启噪声控制功能
enableAGC:enable:	开启音量增益功能
setANSParam:param:	设置 ANS 参数
startRecordWithConfig:config:	开始录制音频文件。
completeRecord	完成录制音频文件。
cancelRecord	中断录制音频
isRecording	获取 ZIM Audio SDK 是否正在录制音频
setAudioRouteType:routeType:	设置音频路由类型
startPlayWithConfig:config:	开始播放音频文件
stopPlay	停止音频播放
isPlaying	获取 ZIM Audio SDK 是否正在播放音频
onError:errorInfo:	异常回调
onRecorderStarted	录音开始回调
onRecorderCompleted:totalDuration:	录音完成回调
onRecorderCancelled	录音取消回调
onRecorderProgress:currentDuration:	录制进度通知回调
onRecorderFailed:errorCode:	音频录制失败回调
onPlayerStarted:totalDuration:	音频播放开始回调
onPlayerEnded	音频播放完成回调
onPlayerStopped	音频播放停止回调
onPlayerProgress:currentDuration:	音频播放进度回调
onPlayerInterrupted	音频播放中断回调
onPlayerFailed:errorCode:	音频播放失败回调