提交工单
咨询集成、功能及报价等问题
ZEGO 即时通讯 SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为开发者提供全平台互动、海量并发、超低延时、消息必达的通信服务,助力打造大型直播、语聊房等场景。
API 返回的错误码,请参考 https://doc-zh.zego.im/article/11606。
方法名 | 描述 |
---|---|
updateUserOfflinePushRule | 修改离线推送的自定规则 |
querySelfUserInfo | 查询自身用户信息、用户规则。 |
create | 创建 ZIM 实例。 |
create | 创建 ZIM 实例。 |
getVersion | 获取 SDK 版本号。 |
getInstance | 获取 ZIM 单例对象。 |
on | 注册监听事件。 |
off | 删除监听事件。 |
setLogConfig | 设置日志相关配置。 |
setGeofencingConfig | 设置地理围栏相关配置。 |
login | 登录,在使用所有功能之前必须先登录。 |
login | 登录,在使用所有功能之前必须先登录。 |
renewToken | 更新鉴权 Token。 |
queryUsersInfo | 查询用户信息。 |
updateUserName | 更新用户的用户名。 |
updateUserAvatarUrl | 更新用户的用户头像URL。 |
updateUserExtendedData | 更新用户的用户扩展字段。 |
uploadLog | 上传日志,设置日志路径和创建实例后调用。 |
logout | 登出 ZIM 服务。 |
destroy | 销毁 ZIM 实例。 |
error | 错误信息回调。 |
tokenWillExpire | Token 将要过期的提醒回调。 |
userInfoUpdated | 用户信息更新的回调。 |
userRuleUpdated | 用户规则变更的回调。 |
方法名 | 描述 |
---|---|
queryRoomMembers | 查询指定房间中的最多 10 名用户的信息。 |
setRoomMembersAttributes | 设置房间成员属性(增加、改变房间属性均用此接口)。 |
queryRoomMembersAttributes | 批量查询房间内成员的房间用户属性。 |
queryRoomMemberAttributesList | 分页查询房间内拥有房间属性成员的房间用户属性。 |
createRoom | 创建带高级设置的房间。 |
enterRoom | 进入房间。若房间不存在,则自动创建。 |
joinRoom | 加入一个房间。 |
leaveRoom | 离开一个房间。 |
leaveAllRoom | 离开所有已进入的房间。 |
queryRoomMemberList | 查询房间内的成员列表。 |
queryRoomOnlineMemberCount | 查询房间内在线成员的数量。 |
queryRoomAllAttributes | 查询房间所有属性。 |
setRoomAttributes | 设置房间属性(增加、改变房间属性均用此接口)。 |
deleteRoomAttributes | 删除房间属性。 |
beginRoomAttributesBatchOperation | 开启组合房间属性操作。 |
endRoomAttributesBatchOperation | 完成组合房间属性操作。 |
receiveRoomMessage | 收到房间消息的回调。 |
roomStateChanged | 房间连接状态发生改变的事件回调。 |
roomMemberJoined | 其他成员加入房间的回调。 |
roomMemberLeft | 其他成员离开房间的回调。 |
方法名 | 描述 |
---|---|
queryConversation | 查询单个会话。 |
queryConversationList | 查询会话列表。 |
queryConversationList | 按照过滤项查询会话列表。 |
queryConversationPinnedList | 查询置顶会话列表。 |
queryConversationTotalUnreadMessageCount | 按照配置项查询会话未读消息总数。 |
updateConversationPinnedState | 修改会话置顶状态。 |
deleteAllConversations | 删除全部会话。 |
deleteConversation | 删除会话。 |
setConversationDraft | 设置会话草稿。 |
clearConversationTotalUnreadMessageCount | 清除全部会话未读数。 |
clearConversationUnreadMessageCount | 清除会话未读数。 |
setConversationMark | 设置或取消设置会话标记。 |
setConversationNotificationStatus | 设置会话通知状态。 |
conversationChanged | 收到会话更新的通知回调。 |
conversationMessageReceiptChanged | 收到回执的会话已读更新的通知回调。 |
conversationsAllDeleted | 收到全部会话删除的通知回调。 |
messageReceiptChanged | 收到回执的消息已读更新的通知回调。 |
conversationTotalUnreadMessageCountUpdated | 会话总未读数更新的通知回调。 |
方法名 | 描述 |
---|---|
callInvite | 发起呼叫邀请。 |
callJoin | 加入进阶模式呼叫,或者切换进阶模式呼叫的主设备(仅限多端登录) |
callCancel | 取消呼叫邀请。 |
callAccept | 接受呼叫邀请。 |
callReject | 拒绝呼叫邀请。 |
callQuit | 退出当前呼叫邀请。 |
callEnd | 结束呼叫邀请。 |
callingInvite | 邀请其他用户加入呼叫邀请。 |
queryCallInvitationList | 查询呼叫邀请列表。 |
blacklistChanged | 当黑名单列表发生变化时会回调当前方法 |
callInvitationReceived | 被邀请者收到的呼叫邀请的通知回调。 |
callInvitationCreated | 邀请者创建的呼叫邀请回调。 |
callInvitationCancelled | 被邀请者收到的取消邀请的通知回调。 |
callInvitationTimeout | 被邀请者的呼叫邀请超时的通知回调。 |
callInvitationAccepted | 邀请者收到的接受邀请的通知回调。 |
callInvitationRejected | 邀请者收到的被邀请者拒绝邀请的通知回调。 |
callInviteesAnsweredTimeout | 邀请者呼叫邀请超时的通知回调。 |
callInvitationEnded | 呼叫结束的通知回调。 |
callUserStateChanged | 呼叫邀请内的用户状态的通知回调。 |
方法名 | 描述 |
---|---|
getInstance | 获得 ZPNs 实例。 |
register | 该方法用于注册厂商离线推送。 |
unregister | 不需要离线推送时可调用此方法反注册。 |
方法名 | 描述 |
---|---|
addUsersToBlacklist | 添加用户到黑名单。 |
removeUsersFromBlacklist | 将用户移除出黑名单。 |
queryBlacklist | 查询黑名单。 |
checkUserIsInBlacklist | 检查用户是否在黑名单。 |
方法名 | 描述 |
---|---|
addFriend | 直接添加好友。 |
sendFriendApplication | 发送好友申请。 |
deleteFriends | 批量删除好友。 |
checkFriendsRelation | 检查好友关系。 |
updateFriendAlias | 更新好友备注。 |
updateFriendAttributes | 更新好友属性。 |
acceptFriendApplication | 接受好友申请。 |
rejectFriendApplication | 拒绝好友申请。 |
queryFriendsInfo | 批量查询好友信息。 |
queryFriendList | 查询好友列表。 |
queryFriendApplicationList | 查询好友申请列表。 |
searchLocalFriends | 搜索本地好友。 |
friendListChanged | 当好友列表发生变化时会回调当前方法 |
friendApplicationListChanged | 当好友申请列表发生变化时会回调当前方法 |
friendApplicationUpdated | 当好友申请列表发生更新时会回调当前方法 |
friendInfoUpdated | 当好友信息更新时候会触发该回调。 |
联系我们
文档反馈