一、开源版包含什么
核心组件
| 组件 | 协议 | 定位 | 说明 |
|---|
| OpenIMClientSDK | AGPL-3.0 | 客户端 SDK | 负责消息、会话、群组、好友等客户端通信能力，需要开发者集成到自己的应用 |
| OpenIMServer | Apache-2.0 | IM 基础服务端 | 负责即时通讯核心链路、消息同步、REST API、Webhook 等能力 |
| ChatServer | Apache-2.0 | 业务扩展服务端 | 负责注册、登录、APP 管理等业务扩展能力；如果你已有自有账号体系，可按需接入或不部署 |
| 客户端 Demo / 示例 UI | AGPL-3.0 | SDK 集成示例 | 提供示例代码，用于演示如何接入 OpenIMClientSDK，不代表完整商用客户端 |
扩展组件
| 组件 | 协议 | 定位 | 说明 |
|---|
| 纯 JS SDK | ARR(闭源) | 纯 JS 的客户端 SDK | 一般用于小程序开发 |
| Web客户端 | ARR(闭源，可免费使用) | 面向终端用户的完整产品界面 | 开箱即用 |
| 管理后台前端 | ARR(闭源，可免费使用) | APP 管理员使用的后台页面 | 如需管理能力，可基于 APP 管理员接口自行构建 |
二、OpenIMClientSDK + OpenIMServer 开源能力明细
本文重点说明 OpenIMClientSDK 与 OpenIMServer 在开源版中已经提供的核心能力。
1. 好友与关系链
- 支持查找、申请、搜索、添加及删除好友。
- 支持同意和拒绝好友申请。
- 支持好友备注。
- 支持是否允许添加好友的设置。
- 好友列表及好友资料支持实时同步。
2. 黑名单
- 支持限制消息和音视频通话。
- 黑名单列表实时同步。
- 支持添加和移出黑名单。
3. 群组
- 支持创建和解散群组。
- 支持申请加群、邀请加群、退出群组及移除群成员。
- 支持群名、群头像更改及群资料变更通知和实时同步。
- 支持进群验证设置。
- 支持群主转让。
- 支持不允许查看其他群成员资料和不允许添加其他群成员为好友的设置。
- 支持设置和移除群管理员。
- 支持搜索群成员和设置群成员群内资料。
- 支持全体禁言及指定 群成员禁言。
- 支持发布群公告。
4. 消息
- 支持文本、图片、视频、表情、文件、语音、名片、地理位置、自定义及群公告消息。
- 支持离线消息、漫游消息、多端消息及历史消息。
- 支持单选消息转发和多选消息合并转发。
- 支持消息删除、消息清空、消息复制及消息撤回。
- 支持撤回后重新编辑消息。
- 支持群组内 @、单聊正在输入、阅后即焚、新消息勿扰、清空聊天记录、新成员查看群聊历史消息、新消息提示。
- 支持本地消息搜索。
5. 会话
- 支持置顶会话。
- 支持删除会话。
- 支持搜索本地会话。
- 支持会话已读。
- 支持会话免打扰。
6. 服务端开放能力
- 提供认证管理、用户管理、关系链管理、群组管理、会话管理、消息管理等 REST API。
- 提供群组回调、消息回调、推送回调、关系链回调及用户回调等 Webhook 能力。
7. 容量与部署
- 好友容量最高支持 3000。
- 群组最高支持 10 万人规模。
- 支持秒级同步。
- 支持源码部署集群。
8. 多端登录策略
- 支持所有平台不互踢。
- 支持每个平台各登录一个设备。
- 支持 PC 端、移动端、Pad 端、Web 端及小程序端各登录一个设备。
9. 音视频能力
- 支持一对一音视频通话基础能力。
- 群组音视频通话或视频会议能力不开源。
- 一对一音视频通话接入时，超时未接通、取消等业务细节需开发者自行完善。
三、如何理解 OpenIMSDK 的开源范围
- 如果你只需要即时通讯核心能力，重点集成 OpenIMClientSDK，并部署 OpenIMServer。
- 如果你还需要注册、登录、APP 管理等业务扩展能力，再按需部署 ChatServer。
- 如果你需要面向终端用户的完整产品界面或 APP 管理员 后台页面，需要基于 SDK、REST API 与业务需求自行实现。