提交工单
咨询集成、功能及报价等问题
文档中心
体验 App
客户端 API
服务端 API
常见问题
进入控制台
立即注册
登录控制台
即时通讯
发布日志
更新时间：2022-11-30 22:35
2.5.0 版本
发布日期：2022-11-30
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 消息撤回 | 撤回发送成功的消息，默认撤回 2 分钟内的消息。撤回操作仅支持撤回单聊和群聊的消息，不支持撤回房间内消息。 如需配置撤回时间，请联系 ZEGO 技术支持。 |
|
| 消息回执 | ZIMMessageSendConfig 新增 hasReceipt 参数，支持在单聊和群聊会话中发送附带回执的消息。 ZIM SDK 支持在单聊和群聊会话查看其他用户是否阅读本端发送的信息，以及支持查看群聊中已读消息和未读消息的数量，以及对应的用户信息，但是不支持信令消息、弹幕消息、以及房间内消息使用回执。 |
|
| 呼叫邀请支持离线推送 | ZIMCallInviteConfig 新增 pushConfig 参数，支持向离线用户推送呼叫邀请。离线用户接受呼叫邀请需要搭配 ZPNs SDK 一起使用。 | ZIMCallInviteConfig |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| ZIMPushConfig 的额外字段命名变更 | 为避免开发者接入概念混淆，ZIMPushConfig 的 extendedData 参数修改为 payload 参数，功能不变。开发者在使用 ZPNs SDK 时，通过厂商通道的 extras 里面的 payload 字段即可获取到发送端传入的额外字段，详情请参考 获取 payload 透传字段。 若集成 ZIM SDK 2.5.0 版本后，开发者使用了离线推送功能后出现了接口编译失败的问题，请将 extendedData 改为 payload。 |
- |
| 优化富媒体消息传输协议 | 减少网络传输过程中的协议包大小。 | - |
| 优化 API 调用时的线程安全 | - | - |
2.4.2 版本
发布日期：2022-11-01
问题修复
修复已知问题。
2.4.0 版本
发布日期：2022-10-10
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 管理房间用户属性 | 支持房间内的用户自定义用户属性。例如：用户等级、勋章、状态等信息。 | |
| 新增系统消息 | 新增系统消息类型，支持 SDK 触发进群通知、群主替换等系统性消息。可以通过 插入本地消息 功能实现。 | - |
| 插入本地消息 | 支持直接向本地插入一条任意消息类型的消息。开发者可结合系统消息类型，在客户端将回调通知（例如：邀请某人进群、把某人移出群等），转为系统消息类型，插入本地 DB，以达到系统提示的效果。 | insertMessageToLocalDB |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 优化消息发送接口 | 优化消息对象，在发送前和发送后是同一个对象。开发者在发送“视频”等内容较大的消息时，可以在消息上传完成前，缓存该消息对象，直到收到 SDK 发送成功通知时，通过比较对象相同来实现发送前 Loading 的效果。 | sendMessage |
| 优化断网重连逻辑 | 优化在无网状态下、以及断网重连后的逻辑。 | - |
| 优化性能 | 优化数据库性能。 | - |
接口变更
- 新增接口
| 新增接口 | 接口描述 | 上线版本 |
|---|---|---|
| login | 新增不带 Token 参数的 login 接口。开发者使用 “AppSign 鉴权” 时，可直接使用该接口登录 ZIM，接入更加便捷。 | 2.4.0 |
| sendMessage | 新增发送消息接口，支持发送单聊、房间、群组消息。 | 2.4.0 |
| onMessageAttached | 在 ZIMMediaMessageSentCallback 中新增 onMessageAttached 回调方法，用于监听消息对象发送前的相关信息，否则编译无法通过。 | 2.4.0 |
- 废弃接口
| 废弃接口 | 变更说明 | 废弃版本 |
|---|---|---|
| 废弃单聊消息 sendPeerMessage、房间消息 sendRoomMessage、群组消息 sendGroupMessage 3 个消息发送接口，统一使用 sendMessage 接口替代，发送消息方式更加规范。 | 2.4.0 |
2.3.3 版本
发布日期：2022-09-09
改进优化
问题修复
修复已知问题。
2.3.1 版本
发布日期：2022-08-22
问题修复
修复已知问题。
2.3.0 版本
发布日期：2022-08-12
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增扩展字段 | 支持用户通过扩展字段，设置自己的个人信息，例如用户头像、个性签名、性别等个人信息。 | updateUserExtendedData |
| 新增头像字段 | 用户信息及群组新增头像字段，用户可以上传自己的头像、或自定义群组头像。 | |
| 支持 AppSign 鉴权 | iOS、Android、macOS、Windows 平台支持 AppSign 鉴权，降低开发者接入门槛。 开发者在调用 create 接口，传入 AppSign，进行鉴权，鉴权通过即可使用 ZIM 相关功能。 |
create |
| 图片/视频消息支持宽、高设置 | 方便开发者设计图片展示效果：
|
|
| 增加单例对象接口 | 便于开发者获取 ZIM 单例对象。 | getInstance |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 逻辑优化 |
|
- |
| 性能优化 | 优化线程切换性能。 | - |
| ZPNs SDK 适配优化 | ZPNs SDK 适配 Android 12.0 版本。 | - |
接口变更
- 废弃接口
2.2.4 版本
发布日期：2022-08-02
问题修复
修复已知问题。
2.2.3 版本
发布日期：2022-07-22
问题修复
修复已知问题。
2.2.1 版本
发布日期：2022-07-18
问题修复
修复已知问题。
2.2.0 版本
发布日期：2022-06-30
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 更新用户名称 | 支持用户更新自己的名称 userName。 | |
| 查询用户个人信息 | 支持用户查询个人信息，例如用户名称、签名等信息。 | |
| 获取群组人数 | 支持获取群组里的成员人数。 | queryGroupMemberCount |
2.1.6 版本
发布日期：2022-06-17
问题修复
修复已知问题。
2.1.5 版本
发布日期：2022-06-06
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 安全审核 | 支持对单聊、群聊和房间内的通讯消息（文本消息、图片消息）进行安全审核，审核范围包含：鉴黄、暴恐、违禁、涉政、广告等。 |
问题修复
修复已知问题。
2.1.1 版本
发布日期：2022-05-09
问题修复
修复已知问题。
2.1.0 版本
发布日期：2022-04-29
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 收发富媒体消息 | 支持用户发送和接收图片、语音、视频和文件等类型的富媒体消息。 | |
| 自动创建房间 | 进入房间时，如果房间不存在，支持自动创建房间。 | enterRoom |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| ZIMMessage 成员属性优化 | ZIMMessage 对象的成员属性改为“只读”属性，开发者发送消息时无需关注和修改其属性。 | ZIMMessage |
2.0.0 版本
发布日期：2022-03-21
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 会话管理 |
|
|
| 群组系统 | 支持用户登录后，创建、加入、退出、解散群聊；同时配备转让群主、设置群公告等常用功能。 | |
| 离线消息推送 |
|
|
| 消息管理 |
|
|
| 呼叫邀请 |
|
改进优化
本次迭代，我们对产品的所有已有接口和新增接口，做了统一的风格优化，开发者从 1.x.x 升级至 2.0.0 API 时，需要在代码里做以下适配。
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
API 接口命名优化 |
查询房间成员 接口命名优化：queryRoomMember 重命名为 queryRoomMemberList。 |
|
API 或回调接口新增参数 |
发送单聊/房间消息接口，增加 config 参数，用于设置是否配置离线推送、以及消息优先级等。 |
|
部分回调接口，增加 roomID 参数，便于开发者在调用相关接口时，获取当前操作结果来源的房间 roomID。 |
||
ZIMRoomAttributesOperatedCallback 增加了 roomID 和 errorKeys 参数，便于开发者获取房间属性时，获取当前操作结果来源的房间 roomID，同时操作失败的 key 会返回给开发者。 |
1.3.7 版本
发布日期：2022-02-18
问题修复
修复已知问题。
1.3.1 版本
发布日期：2021-12-27
此版本新增了后台服务端 API 接口，提升后台的消息发送能力。适用的场景更广泛，开发者可应用于在线剧本杀、在线直播、语聊房等场景中，下发场景所需音乐链接、图片链接、大批量文字等信息将更加便捷。
接口变更
- 新增接口
| 新增服务端 API 接口 | 接口描述 |
|---|---|
| 发送单聊消息（POST 方式） | 采用 POST 方式，向指定用户发送消息，消息大小限制为 32 KB。 |
| 发送房间消息（POST 方式） | 采用 POST 方式，向房间内发送消息，并推送给房间内所有在线用户，消息大小限制为 32 KB。 |
- 废弃接口
| 废弃接口 | 变更说明 | 废弃版本 |
|---|---|---|
| 发送单聊消息（GET 方式） | 原有的 GET 请求方法（消息大小限制为 2 KB）废弃，变更为 发送单聊消息（POST 方式），消息大小限制扩大为 32 KB，适用场景更广泛。 | 1.3.1 |
| 发送房间消息（GET 方式） | 原有的 GET 请求方法（消息大小限制为 2 KB）废弃，变更为 发送房间消息（POST 方式），消息大小限制扩大为 32 KB，适用场景更广泛。 | 1.3.1 |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 优化断网重连逻辑 | 优化断网重连逻辑。 | - |
问题修复
修复了请求超时逻辑在特殊场景下的异常问题。
1.3.0 版本
发布日期：2021-11-09
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增“房间属性”功能 | 房间属性指房间内保存的 此功能可用于语聊房、直播等场景，用来记录房间背景图地址、各用户的角色身份、设备状态等自定义信息。 |
接口变更
- 新增接口
| 新增接口 | 接口描述 |
|---|---|
| createRoom | 创建带高级设置的房间。 |
| setRoomAttributes | 设置房间属性。
此接口支持同时设置多个 Key-Value，后台默认最多可设置 10 个 Key-Value 属性对。 |
| deleteRoomAttributes | 删除房间属性。调用此接口，传入 Key 即可删除，支持同时删除多个 Key-Value 属性对。 |
| queryRoomAllAttributes | 查询房间内设置的属性信息。 |
| beginRoomAttributesBatchOperation | 开始进行房间属性的组合式操作，支持组合调用设置和删除房间属性。组合操作可将同一房间中，多个不同操作合并为一个原子操作进行执行，通常用于连续操作时不想被其他用户操作插入执行的场景中。 在此接口之后调用的 setRoomAttributes 和 deleteRoomAttributes 将会被同时发送到后台执行。 |
| endRoomAttributesBatchOperation | 结束进行房间属性的组合式操作。 调用此接口之后将请求后台执行组合式操作。 |
| onRoomAttributesUpdated | 房间内有属性对更新时，相关信息的回调。 |
| onRoomAttributesBatchUpdated | 房间内有使用组合式操作来更新房间属性时，相关信息的回调。 |
问题修复
- 修复部分房间生命周期问题。
- 修复其他已知问题。
1.2.1 版本
发布日期：2021-10-13
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| SDK 接口优化 | onRoomStateChanged 回调新增 roomID 参数。 | onRoomStateChanged |
问题修复
修复在集成 ExpressSDK 与 ZIM SDK 时，会产生相同类冲突等问题。
1.2.0 版本
发布日期：2021-09-07
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 支持 SDK 线上依赖 | 支持开发者使用 JitPack 自动集成 SDK，提升集成效率。 | 实现基本消息收发 - 集成 |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| SDK 错误码优化 | 优化错误码，便于开发者排查问题，提升接入体验。 | 服务端 API - 全局返回码 |
| SDK 内部重连逻辑优化 | 优化内部断网重连逻辑，提高系统稳定性。 | - |
1.1.0 版本
发布日期：2021-08-13
首次发布，支持 1v1 通信、多人房间聊天等功能。
- 免费试用
联系我们
文档反馈
