开源与开发者

面向工程团队的开放 IM 基础能力

OpenIMX 提供清晰的服务端、客户端和 SDK 模块,适合技术团队审计、扩展、集成和持续演进。GitHub 入口通过环境变量配置,便于不同部署环境保持一致。

const client = new OpenIMX({
  endpoint: "/api",
  websocket: "/ws"
});

await client.connect();
client.on("message", render);
await client.send({
  conversationId,
  content
});

服务端

1

承载连接、消息、会话、群组、文件和管理能力。

Web 客户端

2

用于桌面 Web、管理后台联动和客服接待场景。

App 客户端

3

面向 iOS、Android 和 H5 触达,保持多端体验一致。

SDK

4

把即时通讯能力接入已有产品和内部系统。

模块说明

服务端

承载连接、消息、会话、群组、文件和管理能力。

  • 消息路由
  • 会话与群组
  • 权限与配置

Web 客户端

用于桌面 Web、管理后台联动和客服接待场景。

  • 会话列表
  • 群聊窗口
  • 文件预览

App 客户端

面向 iOS、Android 和 H5 触达,保持多端体验一致。

  • 移动会话
  • 推送入口
  • 主题适配

SDK

把即时通讯能力接入已有产品和内部系统。

  • 统一 API
  • 事件订阅
  • 示例接入

开放能力

带上你的平台、用户场景和现有系统,我们可以一起梳理集成路径和交付边界。

API

用于用户、会话、群组、文件、配置和后台管理的服务端能力。

WebSocket

承载实时消息、在线状态、输入状态和消息回执等事件。

Webhook

用于将消息、线索、通知或业务事件同步到外部系统。

快速集成流程

确认场景

明确是完整产品交付、SDK 接入还是白标定制。

配置环境

准备服务端配置、数据库、域名、HTTPS 和公开环境变量。

接入 SDK

按平台选择 Web、App 或服务端 API,完成登录、会话和消息链路。

联调上线

验证消息、文件、权限、通知和运维监控,再分阶段上线。

Roadmap

  • 完善 SDK 示例
  • 增强后台运营能力
  • 扩展 Webhook 场景
  • 补齐部署与观测文档

License

开源协议和商业交付边界以项目仓库与正式合同为准,官网仅提供产品和技术说明。

查看 GitHub 项目

贡献指南

  • 阅读模块文档
  • 提交 Issue 或讨论
  • 遵循代码规范
  • 通过 Pull Request 参与改进

需要 SDK 集成或私有化技术评估?

带上你的平台、用户场景和现有系统,我们可以一起梳理集成路径和交付边界。

获取私有化方案

需要私有化 IM 或 SDK 集成方案?

告诉我们你的业务场景、预计规模和交付方式,我们会基于 OpenIMX 能力给出清晰方案。