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

功能总览

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

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

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

初始化相关的前置功能

方法名	描述
error	错误信息回调。
tokenWillExpire	Token 将要过期的提醒回调。
userInfoUpdated	用户信息更新的回调。
userRuleUpdated	用户规则变更的回调。
querySubscribedUserStatusList	用于查询当前用户在线状态订阅列表。
queryUsersStatus	批量查询其他用户的在线状态。
subscribeUsersStatus	订阅其他用户的在线状态。
unsubscribeUsersStatus	用于批量取消订阅当前用户订阅列表中的目标用户。
updateUserOfflinePushRule	修改离线推送的自定规则
querySelfUserInfo	查询自身用户信息、用户规则。
create	创建 ZIM 实例。
create	创建 ZIM 实例。
getVersion	获取 SDK 版本号。
getInstance	获取 ZIM 单例对象。
on	注册监听事件。
off	删除监听事件。
setLogConfig	设置日志相关配置。
setGeofencingConfig	设置地理围栏相关配置。
setCacheConfig	设置缓存相关配置。
login	登录，在使用所有功能之前必须先登录。
login	登录，在使用所有功能之前必须先登录。
renewToken	更新鉴权 Token。
queryUsersInfo	查询用户信息。
updateUserName	更新用户的用户名。
updateUserAvatarUrl	更新用户的用户头像URL。
updateUserExtendedData	更新用户的用户扩展字段。
uploadLog	上传日志，设置日志路径和创建实例后调用。
logout	登出 ZIM 服务。
destroy	销毁 ZIM 实例。

房间功能

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

消息功能

方法名	描述
groupMessageReceived	收到群消息的回调。
peerMessageReceived	收到单聊消息的回调。
roomMessageReceived	收到房间消息的回调。
messageRevokeReceived	收到撤回消息的回调。
messageSentStatusChanged	收到消息发送状态变化的回调。
broadcastMessageReceived	收到全员推送消息的回调。
messageReactionsChanged	收到表态变更的回调。
messageDeleted	消息被删除的回调。
receivePeerMessage	收到点对点消息的回调。
messageRepliedCountChanged	回复消息树的数量发生变更的事件。
messageRepliedInfoChanged	回复消息的回复信息的变更事件。
receiveGroupMessage	收到群消息的回调。
onMessageAttached	为传入的消息对象赋予 localMessgeID 并返回。
onMediaUploadingProgress	发送媒体消息的进度回调。
onMessageAttached	为传入的消息对象赋予 localMessgeID 并返回。
sendMessage	发送消息。
sendMediaMessage	发送媒体消息。
insertMessageToLocalDB	向本地 DB 插入一条消息。
clearLocalFileCache	清理当前用户本地消息缓存。
queryLocalFileCache	查询当前用户本地消息缓存。
exportLocalMessages	导出当前用户本地消息。
importLocalMessages	导入当前用户本地消息。
sendConversationMessageReceiptRead	设置会话所有已接收的回执已读。
sendMessageReceiptsRead	设置一批消息的回执变成已读。
queryMessageReceiptsInfo	查询一批消息的回执信息。
queryGroupMessageReceiptReadMemberList	查询群消息已读成员列表。
queryGroupMessageReceiptUnreadMemberList	查询群消息未读成员列表。
searchLocalMessages	搜索本地消息列表。
searchLocalConversations	基于本地消息搜索本地会话。
searchGlobalLocalMessages	搜索全局本地消息列表。
replyMessage	发送回复消息。
queryMessageRepliedList	查询回复列表。
sendMediaMessage	发送媒体消息。
downloadMediaFile	下载媒体消息内容。
sendPeerMessage	发送点对点消息。
sendRoomMessage	发送房间消息。
sendGroupMessage	发送群组消息。
queryHistoryMessage	查询历史消息。
queryMessages	根据消息seq列表查询消息。
deleteAllConversationMessages	删除所有会话的所有消息。
queryCombineMessageDetail	拉取合并消息详情
revokeMessage	撤回消息。
deleteMessages	删除消息。
addMessageReaction	增加消息表态
deleteMessageReaction	删除消息表态
queryMessageReactionUserList	拉取消息表态用户列表
deleteAllMessage	通过会话ID删除消息。
updateMessageLocalExtendedData	更新消息的本地拓展字段。
ZIMMediaDownloadingProgress	下载媒体消息的进度回调。
ZIMMessageExportingProgress	导出消息的进度回调。
ZIMMessageImportingProgress	导入消息的进度回调。

群组功能

方法名	描述
groupStateChanged	群状态变更通知回调。
groupAliasUpdated	群备注更新通知回调。
groupNameUpdated	群名称更新通知回调。
groupAvatarUrlUpdated	群头像 URL 更新通知回调。
groupNoticeUpdated	群公告更新的通知回调。
groupMutedInfoUpdated	群禁言更新的通知回调。
groupVerifyInfoUpdated	入群验证模式更新的通知回调。
groupAttributesUpdated	群属性更新通知回调。
groupMemberStateChanged	群成员状态变更通知回调。
groupMemberInfoUpdated	群成员基本信息变更通知。
groupApplicationListChanged	当入群申请列表发生变化时会回调当前方法
groupApplicationUpdated	当入群申请列表发生变化时会回调当前方法
searchLocalGroups	搜索本地群组。
searchLocalGroupMembers	搜索本地群成员。
createGroup	创建并加入一个带群属性的群组。
joinGroup	加入群组。
leaveGroup	离开群组。
dismissGroup	解散群组。
kickGroupMembers	踢出群组。
inviteUsersIntoGroup	邀请用户进入群组。
transferGroupOwner	转让群主。
updateGroupAlias	更新群备注。
updateGroupName	更新群名称。
muteGroup	禁言群组。
muteGroupMembers	禁言群成员。
updateGroupAvatarUrl	更新群头像 URL。
updateGroupNotice	更新群公告。
updateGroupJoinMode	更新入群模式。
updateGroupInviteMode	更新邀请模式。
acceptGroupInviteApplication	同意邀请入群申请。
acceptGroupJoinApplication	同意加群申请。
queryGroupApplicationList	查询入群申请列表。
rejectGroupInviteApplication	拒绝邀请入群申请。
rejectGroupJoinApplication	拒绝加群申请。
sendGroupInviteApplications	发送邀请入群申请。
sendGroupJoinApplication	发送加群申请。
updateGroupBeInviteMode	更新邀请目标验证模式。
queryGroupInfo	查询群组信息。
queryGroupList	查询群列表。
setGroupAttributes	设置群属性。
deleteGroupAttributes	删除群属性。
queryGroupAttributes	查询群属性。
queryGroupAllAttributes	查询群组全部属性。
setGroupMemberRole	设置群成员角色。
setGroupMemberNickname	设置群成员昵称。
queryGroupMemberInfo	查询群成员信息。
queryGroupMemberList	查询群成员列表。
queryGroupMemberMutedList	查询群禁言成员列表。
queryGroupMemberCount	查询指定群内的群成员数量。

会话功能

方法名	描述
conversationChanged	收到会话更新的通知回调。
conversationMessageReceiptChanged	收到回执的会话已读更新的通知回调。
conversationsAllDeleted	收到全部会话删除的通知回调。
messageReceiptChanged	收到回执的消息已读更新的通知回调。
conversationTotalUnreadMessageCountUpdated	会话总未读数更新的通知回调。
queryConversation	查询单个会话。
queryConversationList	查询会话列表。
queryConversationList	按照过滤项查询会话列表。
queryConversationPinnedList	查询置顶会话列表。
queryConversationTotalUnreadMessageCount	按照配置项查询会话未读消息总数。
updateConversationPinnedState	修改会话置顶状态。
deleteAllConversations	删除全部会话。
deleteConversation	删除会话。
setConversationDraft	设置会话草稿。
clearConversationTotalUnreadMessageCount	清除全部会话未读数。
clearConversationUnreadMessageCount	清除会话未读数。
setConversationMark	设置或取消设置会话标记。
setConversationNotificationStatus	设置会话通知状态。

呼叫邀请功能

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

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

方法名	描述
addLocalNotification	添加一条本地推送。
applyNotificationPermission	向系统申请推送通知权限
createNotificationChannel	Android 平台时，创建一个通知通道。
enableDebug	是否开启调试模式
getInstance	获得 ZPNs 实例。
registerPush	该方法用于注册厂商离线推送。
setBackgroundMessageHandler	Android 平台 App 杀掉后，接收离线的静默推送通知。
setLocalBadge	设置 app 本地角标数。
setPushConfig	设置各家厂商的推送设置项。
setServerBadge	通过该接口向 ZPNs 服务器上报当前 App 的角标数。
unregisterPush	不需要离线推送时可调用此方法反注册。
notificationArrived	厂商通知展示回调。
notificationClicked	厂商通知点击回调。
registered	生成 PushID 后触发的回调。
throughMessageReceived	厂商透传消息回调。

黑名单功能

方法名	描述
addUsersToBlacklist	添加用户到黑名单。
removeUsersFromBlacklist	将用户移除出黑名单。
queryBlacklist	查询黑名单。
checkUserIsInBlacklist	检查用户是否在黑名单。

好友功能

方法名	描述
friendListChanged	当好友列表发生变化时会回调当前方法
friendApplicationListChanged	当好友申请列表发生变化时会回调当前方法
friendApplicationUpdated	当好友申请列表发生更新时会回调当前方法
friendInfoUpdated	当好友信息更新时候会触发该回调。
addFriend	直接添加好友。
sendFriendApplication	发送好友申请。
deleteFriends	批量删除好友。
checkFriendsRelation	检查好友关系。
updateFriendAlias	更新好友备注。
updateFriendAttributes	更新好友属性。
acceptFriendApplication	接受好友申请。
rejectFriendApplication	拒绝好友申请。
queryFriendsInfo	批量查询好友信息。
queryFriendList	查询好友列表。
queryFriendApplicationList	查询好友申请列表。
searchLocalFriends	搜索本地好友。

语音组件（需单独集成）

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