文档中心
IM 即时通讯
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 即时通讯
  • 客户端 API
  • 功能总览

功能总览

更新时间:2023-09-22 18:23

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

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

初始化相关的前置功能

方法名 描述
Create 创建 ZIM 实例。
GetVersion 获取 SDK 版本号。
SetLogConfig 设置日志相关配置。
SetCacheConfig 设置缓存相关配置。
Login 登录,在使用所有功能之前必须先登录。
Login 登录,在使用所有功能之前必须先登录。
RenewToken 更新鉴权 Token。
QueryUsersInfo 查询用户信息。
UpdateUserName 更新用户的用户名。
UpdateUserAvatarUrl 更新用户的用户头像URL。
UpdateUserExtendedData 更新用户的用户扩展字段。
UploadLog 上传日志,设置日志路径和创建实例后调用。
Logout 登出 ZIM 服务。
Destroy 销毁 ZIM 实例。
OnError 错误信息回调。
OnTokenWillExpire Token 将要过期的提醒回调。

房间功能

方法名 描述
CreateRoom 创建并加入一个房间。
QueryRoomMembers 查询指定房间中的最多 10 名用户的信息。
SetRoomMembersAttributes 设置房间成员属性(增加、改变房间属性均用此接口)。
QueryRoomMembersAttributes 批量查询房间内成员的房间用户属性。
QueryRoomMemberAttributesList 分页查询房间内拥有房间属性成员的房间用户属性。
CreateRoom 创建带高级设置的房间。
EnterRoom 进入房间。若房间不存在,则自动创建。
JoinRoom 加入一个房间。
LeaveRoom 离开一个房间。
QueryRoomMemberList 查询房间内的成员列表。
QueryRoomOnlineMemberCount 查询房间内在线成员的数量。
QueryRoomAllAttributes 查询房间所有属性。
SetRoomAttributes 设置房间属性(增加、改变房间属性均用此接口)。
DeleteRoomAttributes 删除房间属性。
BeginRoomAttributesBatchOperation 开启组合房间属性操作。
EndRoomAttributesBatchOperation 完成组合房间属性操作。
OnReceiveRoomMessage 收到房间消息的回调。
OnRoomStateChanged 房间连接状态发生改变的事件回调。
OnRoomMemberJoined 其他成员加入房间的回调。
OnRoomMemberLeft 其他成员离开房间的回调。

消息功能

方法名 描述
InsertMessageToLocalDB 向本地 DB 插入一条消息。
QueryGroupMessageReceiptReadMemberList 查询群消息已读成员列表。
QueryGroupMessageReceiptUnreadMemberList 查询群消息未读成员列表。
QueryMessageReceiptsInfo 查询一批消息的回执信息。
SearchGlobalLocalMessages 搜索全局本地消息列表。
SearchLocalConversations 基于本地消息搜索本地会话。
SearchLocalMessages 搜索本地消息列表。
SendConversationMessageReceiptRead 设置会话所有已接收的回执已读。
SendMediaMessage 发送媒体消息。
SendMessage 发送消息。
SendMessageReceiptsRead 设置一批消息的回执变成已读。
DownloadMediaFile 下载媒体消息内容。
QueryHistoryMessage 查询历史消息。
AddMessageReaction 增加消息表态
DeleteMessageReaction 删除消息表态
DeleteMessages 删除消息。
QueryMessageReactionUserList 拉取消息表态用户列表
RevokeMessage 撤回消息。
DeleteAllMessage 通过会话ID删除消息。
UpdateMessageLocalExtendedData 更新消息的本地拓展字段。
OnBroadcastMessageReceived 收到全员推送消息的回调。
OnMessageReactionsChanged 收到表态变更的回调。
OnMessageRevokeReceived 收到撤回消息的回调。
OnMessageSentStatusChanged 收到消息发送状态变化的回调。
OnReceivePeerMessage 收到点对点消息的回调。
OnReceiveGroupMessage 收到群消息的回调。

群组功能

方法名 描述
CreateGroup 创建并加入一个群组。
SearchLocalGroupMembers 搜索本地群成员。
SearchLocalGroups 搜索本地群组。
CreateGroup 创建并加入一个带群属性的群组。
JoinGroup 加入群组。
LeaveGroup 离开群组。
DismissGroup 解散群组。
KickGroupMembers 踢出群组。
InviteUsersIntoGroup 邀请用户进入群组。
TransferGroupOwner 转让群主。
UpdateGroupName 更新群名称。
UpdateGroupAvatarUrl 更新群头像 URL。
UpdateGroupNotice 更新群公告。
QueryGroupInfo 查询群组信息。
QueryGroupList 查询群列表。
SetGroupAttributes 设置群属性。
DeleteGroupAttributes 删除群属性。
QueryGroupAttributes 查询群属性。
QueryGroupAllAttributes 查询群组全部属性。
SetGroupMemberRole 设置群成员角色。
SetGroupMemberNickname 设置群成员昵称。
QueryGroupMemberInfo 查询群成员信息。
QueryGroupMemberList 查询群成员列表。
QueryGroupMemberCount 查询指定群内的群成员数量。
OnGroupStateChanged 群状态变更通知回调。
OnGroupNameUpdated 群名称更新通知回调。
OnGroupAvatarUrlUpdated 群头像 URL 更新通知回调。
OnGroupNoticeUpdated 群公告更新的通知回调。
OnGroupAttributesUpdated 群属性更新通知回调。
OnGroupMemberStateChanged 群成员状态变更通知回调。
OnGroupMemberInfoUpdated 群成员基本信息变更通知。

会话功能

方法名 描述
QueryConversation 查询单个会话。
QueryConversationList 查询会话列表。
QueryConversationPinnedList 查询置顶会话列表。
UpdateConversationPinnedState 修改会话置顶状态。
DeleteConversation 删除会话。
ClearConversationUnreadMessageCount 清除会话未读数。
SetConversationNotificationStatus 设置会话通知状态。
OnConversationChanged 收到会话更新的通知回调。
OnConversationMessageReceiptChanged 收到回执的会话已读更新的通知回调。
OnMessageReceiptChanged 收到回执的消息已读更新的通知回调。
OnConversationTotalUnreadMessageCountUpdated 会话总未读数更新的通知回调。

呼叫邀请功能

方法名 描述
CallInvite 发起呼叫邀请。
CallCancel 取消呼叫邀请。
CallAccept 接受呼叫邀请。
CallEnd 结束呼叫邀请。
CallQuit 退出当前呼叫邀请。
CallReject 拒绝呼叫邀请。
CallingInvite 邀请其他用户加入呼叫邀请。
QueryCallInvitationList 查询呼叫邀请列表。
OnCallInvitationReceived 被邀请者收到的呼叫邀请的通知回调。
OnCallInvitationCancelled 被邀请者收到的取消邀请的通知回调。
OnCallInvitationTimeout 被邀请者的呼叫邀请超时的通知回调。
OnCallInvitationAccepted 邀请者收到的接受邀请的通知回调。
OnCallInvitationRejected 邀请者收到的被邀请者拒绝邀请的通知回调。
OnCallInvitationEnded 呼叫结束的通知回调。
OnCallInviteesAnsweredTimeout 邀请者呼叫邀请超时的通知回调。
OnCallUserStateChanged 呼叫邀请内的用户状态的通知回调。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈