发布日期:2024-05-16
问题修复
修复已知问题。
发布日期:2024-05-06
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
群组角色 | 新增群组角色 “管理员”,拥有大部分群主上限,可以对修改普通群成员昵称、撤回普通群成员消息、踢人、禁言单独群成员和特定群角色。 如需了解群组角色与对应权限,请参考 群成员管理 - 设置群成员角色 |
setGroupMemberRole |
入群验证 |
|
|
Tips 消息 | 支持将群内用户的某些群组操作(如创建群组、解散群组等) 转换为特殊类型消息(Tips)。凭借群组消息回调获得操作信息后,开发者可以自行构造并在 UI 上展示相关事件的描述文本。 如需了解 Tips 消息种类和扩展信息,以及调接收后的处理操作,请参考 接收 Tips 消息 |
|
自定义推送规则 | 支持用户在多端登录场景下,自行决定需要接收离线推送的平台,以及查询当前的离线推送规则。 如需了解接口调用细节,请参考 自定义推送规则 |
|
消息导出导入 | 支持将用户本地终端的历史消息导出作为备份,可用于更换设备时迁移聊天记录,或恢复被删除的消息。 如需了解接口调用细节,请参考 导出导入消息 |
|
缓存管理 | 支持查询当前登录用户的本地缓存文件大小,并清理本地缓存。 如需了解接口调用细节,请参考 缓存管理 |
|
退出所有房间 | 支持用户在多房间场景下一次性退出所有房间;也可用于开发者退出单一房间而不提前传入 roomID 的场景。 | leaveAllRoom |
数据迁移 | 支持用户通过 ZIM 服务端接口将用户数据迁移至 ZIM 服务。实现方案请参考 迁移方案。 | - |
服务端查询会话列表 | 支持在服务端分页查询用户最新的 1000 个会话(单聊与群聊)。 | 查询会话列表 |
服务端查询历史消息 | 支持在服务端分页查询用户指定单聊或群聊会话的历史消息列表。 | |
服务端修改群组规格 | 支持在服务端修改群组的入群验证模式、邀请模式、邀请目标验证模式和群成员人数上限。 | 修改群规格限制 |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
检测邀请是否送达 | 支持在发起呼叫邀请时配置参数 enableNotReceivedCheck,检测呼叫是否触达被叫,以便主叫更快感知被叫网络状态并实现提示。 | ZIMCallInviteConfig > enableNotReceivedCheck |
服务端创建群组接口新增参数 | 新增 CreateGroupTime 参数,支持设置创建群组的事件。 |
创建群组 |
服务端添加群成员接口新增参数 | 新增 GroupMemberInfos 参数,支持定义入群用户的入群时间和入群模式。 |
添加群成员 |
发布日期:2024-03-16
问题修复
修复已知问题。
发布日期:2024-03-08
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
多端登录 | “多平台登录”策略支持配置互踢逻辑,当前仅支持 android、iOS 设备互踢,Windows、Mac 设备互踢。 | login |
离线登录 | 支持用户在离线状态登录 IM 服务,访问本地 SDK 数据。 | login |
黑名单管理 | 用户可以查询自己的黑名单、将指定用户拉黑(不再接收该用户消息)、移出黑名单、以及检查指定用户是否在黑名单内。 | |
插入本地消息 | 支持向房间会话插入本地消息。 | insertMessageToLocalDB |
呼叫邀请 | 新增回调 callInvitationCreated,呼叫邀请发起者可通过监听此回调,得知呼叫邀请已创建。 | callInvitationCreated |
合并转发 |
|
|
收发 @ 消息 | 支持用户在某个会话发送消息时,为消息设置提及指定用户(可以不在当前会话)或提及全部会话内成员。 | |
删除消息 | 支持用户一次性删除全部会话的所有消息。 | deleteAllConversationMessages |
保存会话草稿 | ZIM 支持用户退出单聊和群聊会话后仍在本地保存会话草稿,以便后续编辑。 | setConversationDraft |
单聊会话免打扰 | 在原有“群聊会话免打扰”的基础上,新增支持对单聊会话设置免打扰。单聊会话接收新消息后,不推送通知。 | setConversationNotificationStatus |
禁止发言 | 支持群主对群组实现群组禁言和指定群成员禁言。群组禁言支持全体禁言、普通成员禁言、指定角色成员禁言。 | |
好友管理 | 用户可以直接添加和删除好友、查看看好友列表、向用户发起好友申请、同意或拒绝好友申请、查看好友申请列表、检查其他用户与自己的好友关系、查询或修改好友信息,以及搜索好友。 | |
设置安全审核敏感词 | 开通安全审核后,支持开发者添加额外敏感词。当用户发送消息包含敏感词时,对该消息进行审核、替换内容或拦截。 如需使用此功能,请联系 ZEGO 技术支持。 |
- |
服务端撤回消息 | 支持从服务端调用接口撤回单聊消息和群聊消息。 | |
服务端修改用户资料 | 支持从服务端调用接口修改用户资料信息,包括用户昵称、头像等。 | 修改用户资料 |
服务端设置会话免打扰 | 支持在服务端对群聊会话和单聊会话设置免打扰状态。 | 设置会话消息免打扰 |
服务端置顶会话 | 支持在服务端为用户设置会话的置顶状态。 | 置顶会话 |
服务端修改群资料 | 支持在服务端修改置顶群组的头像、名称和公告。 如需使用此功能,请联系 ZEGO 技术支持了解详情。 |
- |
服务端管理好友 | 支持在服务端为用户添加和删除好友,查询好友列表,检查好友关系,更新好友备注和属性。 | |
服务端管理黑名单 | 支持在服务端为用户批量拉黑、解除黑名单、查询黑名单、检查黑名单关系。 |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
优化 roomID 长度限制 | 支持最长 128 字节的 roomID。 | ZIMRoomInfo > roomID |
用户信息相关类新增用户头像字段 | ZIMUserInfo 和 ZIMGroupMemberInfo 新增 userAvatarUrl 字段,用于设置或说明用户头像地址。暂不支持获取房间成员的用户头像字段,即通过 queryRoomMemberList 和 queryRoomMembers 拿到的 |
|
优化 roomStateChanged 回调逻辑 | 当开发者调用 ZIM 服务端接口在后台销毁房间后,roomStateChanged 回调描述房间状态变化的原因修改为 RoomNotExist 。 |
roomStateChanged |
发送单聊消息服务端接口新增响应参数 | 新增 SuccessList 参数,成员参数包含 UserId 、MsgId 和 MsgSeq ,说明消息接受成功用户的相关信息。MsgSeq 可用于 撤回单聊消息。 |
发送单聊消息 |
发送群聊消息服务端接口新增响应参数 | 新增 MsgSeq ,可用于 撤回群聊消息。 |
发送群聊消息 |
消息发送后服务端回调新增字段 | 新增 user_list 字段,用于批量返回消息接收用户信息。仅当开发者调用服务端接口 发送单聊消息 时,此字段有值。 |
消息发送后回调 |
废弃删除
废弃项 | 废弃描述 | 相关接口 |
---|---|---|
废弃 login 接口 |
废弃旧版登录接口,新增新版登录接口 login。新版登录接口支持通过 ZIMLoginConfig 进行更多配置,如是否使用 Token 鉴权、是否离线登录。 | login |
部分用户信息相关类废弃旧版头像字段 |
|
发布日期:2023-12-04
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
地理围栏 | 提供地理围栏服务,保证 IM 数据存储在运营本地,适用于海外高安全场景。 | setGeofencingConfig |
群消息管理 | 支持新进入群组成员自动获取群历史消息。 如需使用此功能,请联系 ZEGO 技术支持配置。 |
|
一键已读 | 支持清除所有会话的消息未读数和总消息未读数。 | clearConversationTotalUnreadMessageCount |
呼叫邀请 | 支持呼叫外用户主动加入进阶模式呼叫,或呼叫内用户切换设备。 | callJoin |
删除所有会话列表 | 支持清空当前会话列表 | deleteAllConversations |
多端登录 | 支持配置双平台或多平台登录策略,用户可在多平台、多设备上同时登录同一账户,实现会话、消息、群组等数据多端互通。如需了解多端登录对其他功能的影响,请参考 多端登录。 仅支持专业版或旗舰版套餐用户使用此功能,且需联系 ZEGO 技术支持进行配置登录策略。 |
login |
服务端新增添加群成员接口 | 支持将指定用户拉进至群组中。 | 添加群成员 |
服务端新增解散群组接口 | 支持解散指定群组。 | 解散群组 |
服务端新增转让群主接口 | 支持将群主转让给指定的群成员。 | 转让群主 |
服务端新增设置群成员昵称接口 | 支持为指定群成员设置其群昵称。 | 设置群成员昵称 |
服务端消息支持附带回执 | 通过服务端发送单聊消息、群聊消息时,可以附带回执功能,以便得知消息是否已读。支持的消息类型包含文本、图片、文件、音频、视频、自定义消息,详情请参考 MessageBody 说明。 | |
服务端新增登录登出回调 | 在用户登录、退出时,ZIM 服务端会主动回调通知给开发者服务端。 | 登录登出回调 |
全员离线推送 | 在调用服务端接口进行全员推送时,支持选择推送类型,实现离线推送。 | 全员推送 |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
登录逻辑优化 | 优化登录逻辑,避免了弱网环境下多设备异常互踢的情况。 | - |
呼叫创建服务端回调 | 呼叫创建服务端回调新增 caller 字段说明发起呼叫的用户,详情请参考 呼叫创建回调。 |
- |
新增服务端信令消息支持类型 | 支持通过服务端发送经 base64 编码后的二进制信令消息,详情请参考 MessageBody 说明。 | - |
优化删除会话后的置顶逻辑 | 删除某置顶会话后,不会自动更改该会话的置顶状态(ZIMConversation > isPinned)为 No 。当该会话有新消息,再次出现在会话列表时,仍为置顶会话。 |
- |
发布日期:2023-11-06
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
多端登录 | 支持配置双平台或多平台登录策略,用户可在多平台、多设备上同时登录同一账户,实现会话、消息、群组等数据多端互通。如需了解多端登录对其他功能的影响,请参考 多端登录。 仅支持专业版或旗舰版套餐用户使用此功能,且需联系 ZEGO 技术支持进行配置登录策略。 |
login |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
新增服务端信令消息支持类型 | 支持通过服务端发送经 base64 编码后的二进制信令消息,详情请参考 MessageBody 说明。 | - |
优化删除会话后的置顶逻辑 | 删除某置顶会话后,不会自动更改该会话的置顶状态(ZIMConversation > isPinned)为 No 。当该会话有新消息,再次出现在会话列表时,仍为置顶会话。 |
- |
发布日期:2023-10-23
问题修复
修复已知问题。
发布日期:2023-09-18
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
消息表态 | 支持对单聊和群聊消息做出反应(即表态),一般可用于表情回复消息等场景,也可用于发起群组投票、确认群组结果等操作。此外,还支持删除自己做出的表态,以及查询某个表态相关的用户信息。 | |
服务端发送单聊消息接口支持发送者无感知 | 新增 SenderUnaware 字段,允许通过服务端发送单聊消息后,请求参数中的 FromUserId (发送方用户 ID)所对应的客户端对此次发送无感知。 |
发送单聊消息 |
服务端新增全员推送接口 | 支持向所有在线用户(包括消息发送用户自己)发送特定内容的消息,如文本、图片等。本功能适用于全员活动公告、送礼跨房间飘屏等场景。 | |
服务端新增查询用户是否在房间内接口 | 支持通过此接口,查询指定用户是否在目标房间内。 | 查询用户是否在房间内 |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
用户昵称 UserName 长度上限调整 | 从 64 字节扩展至 256 字节,支持更长昵称,适用于 2.0.0 及以后版本的 ZIM SDK。 | ZIMUserInfo > userName |
发布日期:2023-07-28
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
呼叫邀请新增模式 | 新增进阶模式,支持用户在呼叫中邀请、退出呼叫和结束呼叫。 | |
撤回他人消息 | 群组会话中,群主可以撤回他人发送的消息。 | revokeMessage |
获取房间成员信息 | 支持调用服务端接口,根据房间 ID 获取房间成员的信息,包括房间用户数量、用户 ID 及名称。 | 获取房间成员信息 |
服务端消息发送接口新增支持更多消息类型 | 支持通过服务端接口发送图片、文件、音频、视频、自定义和弹幕类型消息,详情请参考 MessageBody 说明。 | |
下载外部富媒体消息 | 支持调用 downloadMediaFile 接口,通过外部 URL 下载富媒体消息。 | downloadMediaFile |
设置消息拓展字段 | 新增仅本端可见的消息拓展字段,支持更新该字段,可用于展示消息翻译状态或其他内容。 | |
搜索本地消息 | 通过关键字、用户 ID 等条件对单个或所有 单聊 和 群聊 会话的本地消息进行搜索,获取符合条件的消息列表;也可以基于本地消息搜索会话。 |
|
搜索群组 | 支持基于关键字对群组名称进行搜索,同时支持将群成员名称和群成员昵称纳入搜索范围。 | searchLocalGroups |
搜索群成员 | 支持基于关键字对指定群内的群成员名称进行搜索,同时支持将群成员昵称纳入搜索范围。 | searchLocalGroupMembers |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
呼叫邀请接收回调 | 优化呼叫邀请普通模式,支持在呼叫邀请的超时时间内,离线用户收到呼叫邀请在上线后能够立即被通知。 | callUserStateChanged |
废弃删除
废弃接口 | 废弃说明 | 废弃版本 |
---|---|---|
为便利开发者监听呼叫邀请中用户的呼叫状态变化,新增 callUserStateChanged,替代原呼叫邀请回调 callInvitationAccepted 、callInvitationRejected 和 callInviteesAnsweredTimeout 。 |
2.9.0 |
发布日期:2023-06-08
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
置顶会话 | 用户可以选择想要优先查看的会话,将其固定在会话列表顶部。 | |
自定义消息类型 | 新增自定义类型消息,开发者可自定义消息的类型,如投票类型、接龙类型、视频卡片类型等,并自行完成消息的解析。ZIM SDK 不负责定义和解析自定义消息的具体内容。 | ZIMCustomMessage |
查询会话信息 | 通过指定会话 ID 查询会话的详细信息。 | queryConversation |
查询房间内用户状态 | 通过指定若干 userID 和 roomID,查询目标用户是否在指定房间内,从而进行业务逻辑设计,如邀请连麦。 最多支持一次性查询 10 名用户的信息。 |
queryRoomMembers |
消息发送前回调 | 通过设置服务端回调,在用户发送单聊、群聊或房间聊天消息时,ZIM 向开发者服务端发送请求,开发者可实现:
|
消息发送前回调 |
消息发送后回调 | 通过设置服务端回调,在用户发送单聊、群聊、房间消息成功或失败后,ZIM 向开发者服务端发送请求,开发者可实现:
|
消息发送后回调 |
批量注册用户 | 支持调用服务端接口,指定用户信息(用户 ID 等),开发者可实现发起一次请求,注册多名用户。 最多支持一次性注册 100 名用户。 |
批量注册用户 |
查询 App 下的群列表 | 支持调用服务端接口获取 App 中所有群组的 ID。 | 查询 App 下的群列表 |
查询群成员列表 | 支持调用服务端接口,指定群组 ID,获取对应群组的成员列表。 | 查询群成员列表 |
移除群成员 | 支持调用服务端接口,指定群组 ID 和用户 ID,批量群成员。 最多支持一次性移除 50 名群成员。 |
移除群成员 |
废弃删除
废弃项 | 废弃描述 | 相关接口 |
---|---|---|
废弃系统消息类型 | ZIMMessageType 废弃了系统消息(值为 30),开发者请使用功能更完善的自定义消息(值为 200)替代。 | ZIMMessageTypeCustom |
其他事项
具体说明,请参考 App Store submission requirement starts April 25 及 Xcode 14 Release Notes。
具体说明,请参考 Xcode 14 Release Notes。
发布日期:2023-03-27
问题修复
修复调用 sendMessageReceiptsRead 接口报错问题。
发布日期:2023-03-16
问题修复
修复已知问题。
发布日期:2023-03-09
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
优化用户登录时 userName 置空逻辑 | 区分了用户名修改接口和登录接口。用户登录时,若将 userName 置空,不再会因此修改 userName,优化用户登录体验。 | userName |
优化会话消息拉取时机 | SDK 会智能检测当前用户的会话活跃情况,优化数据同步的时机,提升用户查询速度与体验。 | - |
优化断网重连时机 | 当 APP 断网后,SDK 会实时检测网络状态变化以及 APP 前后台变化,加快用户重连速度。 | - |
发布日期:2023-01-13
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
服务端新增呼叫邀请相关回调 | 用户可以通过 ZIM 服务端的回调,明确呼叫邀请的结果,适用于网络环境不好时,SDK 反馈的结果不稳定。 | |
消息体增加扩展字段 | ZIMMessage 增加 extendedData 字段,用户可以将用户头像和昵称等信息传入该字段,在聊天对话发送消息时实时展示。 | extendedData |
新增发送消息状态回调 | 开发者可以通过监听此回调来完善消息发送状态的逻辑。根据消息状态的变更,开发者可以在 UI 上做相应提醒等。 | messageSentStatusChanged |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
优化弱网情况下消息发送的逻辑 | 用户在弱网环境下发送消息时,SDK 会通过策略逻辑尽可能保证消息发送状态的正确性。 | - |
发布日期:2022-12-06
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
消息撤回 | 撤回发送成功的消息,默认撤回 2 分钟内的消息。撤回操作仅支持撤回单聊和群聊的消息,不支持撤回房间内消息。 如需配置撤回时间,请联系 ZEGO 技术支持。 |
|
消息回执 | ZIMMessageSendConfig 新增 hasReceipt 参数,支持在单聊和群聊会话中发送附带回执的消息。 ZIM SDK 支持在单聊和群聊会话查看其他用户是否阅读本端发送的信息,以及支持查看群聊中已读消息和未读消息的数量,以及对应的用户信息,但是不支持信令消息、弹幕消息、以及房间内消息使用回执。 |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
变更 ZIMPushConfig 的额外字段命名 | 为避免开发者接入概念混淆,ZIMPushConfig 的 extendedData 参数修改为 payload 参数,功能不变。 | - |
发布日期:2022-10-26
问题修复
修复已知问题。
发布日期:2022-10-20
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
管理房间用户属性 | 支持房间内的用户自定义用户属性。例如:用户等级、勋章、状态等信息。 | |
新增系统消息 | 新增系统消息类型,支持 SDK 触发进群通知、群主替换等系统性消息。可以通过 插入本地消息 功能实现。 | - |
插入本地消息 | 支持直接向本地插入一条任意消息类型的消息。开发者可结合系统消息类型,在客户端将回调通知(例如:邀请某人进群、把某人移出群等),转为系统消息类型,插入本地 DB,以达到系统提示的效果。 | insertMessageToLocalDB |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
优化消息发送接口 | 优化消息对象,在发送前和发送后是同一个对象。开发者在发送“视频”等内容较大的消息时,可以在消息上传完成前,缓存该消息对象,直到收到 SDK 发送成功通知时,通过比较对象相同来实现发送前 Loading 的效果。 | sendMessage |
优化断网重连逻辑 | 优化在无网状态下、以及断网重连后的逻辑。 | - |
优化性能 | 优化数据库性能。 | - |
接口变更
新增接口 | 接口描述 | 上线版本 |
---|---|---|
sendMessage | 新增发送消息接口,支持发送单聊、房间、群组消息。 | 2.4.0 |
sendMediaMessage | 新增富媒体消息发送接口 sendMediaMessage(同名重载),支持获取媒体上传前的信息,可发送文件、图片、音频、视频等富媒体信息。 | 2.4.0 |
废弃接口 | 变更说明 | 废弃版本 |
---|---|---|
废弃单聊消息 sendPeerMessage、房间消息 sendRoomMessage、群组消息 sendGroupMessage 3 个消息发送接口,统一使用 sendMessage 接口替代,发送消息方式更加规范。 | 2.4.0 | |
sendMediaMessage | 原有的发送富媒体消息 sendMediaMessage 接口废弃,替换为同名的 sendMediaMessage 接口,接口参数不同,请注意切换使用。 | 2.4.0 |
发布日期:2022-09-16
改进优化
问题修复
修复已知问题。
发布日期:2022-08-30
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
新增扩展字段 | 支持用户通过扩展字段,设置自己的个人信息,例如用户头像、个性签名、性别等个人信息。 | updateUserExtendedData |
新增头像字段 | 用户信息及群组新增头像字段,用户可以上传自己的头像、或自定义群组头像。 | |
支持 AppSign 鉴权 | uni-app、React Native 平台支持 AppSign 鉴权,降低开发者接入门槛。 开发者在调用 create 接口,传入 AppSign,进行鉴权,鉴权通过即可使用 ZIM 相关功能。 |
create |
图片/视频消息支持宽、高设置 | 方便开发者设计图片展示效果:
|
|
增加单例对象接口 | 便于开发者获取 ZIM 单例对象。 | getInstance |
改进优化
优化项 | 优化描述 | 相关接口 |
---|---|---|
逻辑优化 |
|
- |
性能优化 | 优化线程切换性能。 | - |
接口变更
发布日期:2022-08-02
新增功能
功能项 | 功能描述 | 相关接口 |
---|---|---|
获取群组人数 | 支持获取群组里的成员人数。 | queryGroupMemberCount |
发布日期:2022-06-29
uni-app 2.1.6 版本首次发布,对齐 iOS/Android/macOS/Windows 等平台的 2.1.6 版本。
首次发布,支持功能如下:
功能项 | 功能描述 | 相关接口 |
---|---|---|
会话管理 |
|
|
房间系统 |
|
|
群组系统 | 支持用户登录后,创建、加入、退出、解散群聊;同时配备转让群主、设置群公告等常用功能。 | |
消息管理 |
|
|
呼叫邀请 |
|
|
安全审核 | 支持对单聊、群聊和房间内的通讯消息(文本消息)进行安全审核,审核范围包含:鉴黄、暴恐、违禁、涉政、广告等。 |
联系我们
文档反馈