Guides
开源能力
确认开源版包含的组件、消息能力、服务端开放能力和容量边界。
开源版包含什么
核心组件
| 组件 | 协议 | 定位 | 说明 |
|---|---|---|---|
| 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（闭源） | 纯 JavaScript 客户端 SDK | 通常用于小程序开发 |
| Web 客户端 | ARR（闭源，可免费使用） | 面向终端用户的完整界面 | 可直接使用 |
| 管理后台前端 | ARR（闭源，可免费使用） | APP 管理员后台 | 也可基于 APP 管理员接口自行构建 |
OpenIMClientSDK 和 OpenIMServer 的能力
好友与关系链
- 查找、申请、搜索、添加和删除好友
- 同意或拒绝好友申请
- 设置好友备注和添加好友权限
- 实时同步好友列表和资料
黑名单
- 添加和移出黑名单
- 实时同步黑名单列表
- 限制黑名单用户之间的消息和音视频通话
群组
- 创建和解散群组
- 申请加群、邀请加群、退出群组和移除群成员
- 修改并同步群名称、头像和资料
- 设置进群验证和转让群主
- 控制群成员资料查看和好友添加权限
- 设置和移除管理员
- 搜索群成员并设置群内资料
- 全体禁言和指定成员禁言
- 发布群公告
消息
- 文本、图片、视频、表情、文件、语音、名片、地理位置、自定义和群公告消息
- 离线消息、漫游消息、多端消息和历史消息
- 单条转发和多条合并转发
- 删除、清空、复制和撤回消息
- 撤回后重新编辑
- 群内 @、单聊输入状态、阅后即焚、消息免打扰、新成员查看历史消息和新消息提示
- 本地消息搜索
会话
- 置顶和删除会话
- 搜索本地会话
- 会话已读和免打扰
服务端开放能力
- 认证、用户、关系链、群组、会话和消息管理 REST API
- 群组、消息、推送、关系链和用户 Webhook
容量与部署
- 好友容量最高 3000
- 群组最高支持 10 万人规模
- 支持秒级同步
- 支持源码集群部署
多端登录策略
- 所有平台不互踢
- 每个平台只登录一个设备
- PC、移动端、Pad、Web 和小程序端各登录一个设备
音视频能力
- 开源版提供一对一音视频通话基础能力
- 群组音视频通话或视频会议能力不开源
- 超时未接通、取消等业务逻辑需要接入方自行完善
如何选择组件
- 只需要即时通讯核心能力时，集成 OpenIMClientSDK 并部署 OpenIMServer。
- 还需要注册、登录和 APP 管理能力时，再按需部署 ChatServer。
- 需要完整客户端或管理后台时，应结合 SDK、REST API 和业务要求评估现有扩展组件或自行实现。