WuKongIM 开发者文档v3 Beta

让每一条消息，可靠抵达。

为你的应用构建实时通信。从第一条消息开始，探索客户端接入、集群部署和完整的 API。

体验 Demo接入应用
查找概念、配置或 API
first-message.tsTypeScript
SDK 代码片段
// 连接成功后，向 Bob 发送消息

await sdk.chatManager.send(
  new MessageText('Hello, WuKongIM!'),
  new Channel('bob', ChannelTypePerson),
);
查看完整接入流程
AAlice发送端
WuKongIM集群
BBob接收端
分别验证服务器发送结果与接收端消息事件
选择你的平台
JavaScript / WebAndroidiOSFlutterHarmonyOS

EXPLORE THE DOCS

找到你的下一步

从了解概念到上线运行，每一步都有清晰的路径。

01

了解与入门

指南

从认识 WuKongIM 到完成第一个业务集成。

阅读文档
02

部署与运维

服务端

部署、配置、运维和理解 WuKongIM 集群。

阅读文档
03

连接与集成

SDK

在不同客户端平台接入 WuKongIM。

阅读文档
04

接口与协议

API 与协议

查阅源码校准的 HTTP、Webhook、客户端协议与私有接口边界。

阅读文档

YOUR FIRST MESSAGE

第一次使用？ 先跑通一条消息。

用两个测试用户完成一次消息收发，再逐步接入你的业务。

打开快速开始
  1. 01

    启动集群

    用 Docker 在电脑上启动单节点集群。

  2. 02

    体验消息收发

    打开内嵌 Demo，让 Alice 和 Bob 互发消息。

  3. 03

    接入你的应用

    选择平台 SDK，复用已经跑通的收发流程。

KEEP BUILDING

开发时，常用这些

核心概念

消息、频道、用户与会话

Docker 部署

镜像、配置与持久化存储

体验四个 Demo

聊天、流式回复、客服与 Agent

配置参考

TOML、环境变量与默认值

健康检查与监控

就绪状态、指标与告警

WuKongIM HTTP API

服务端接口与请求示例

开源。可自托管。为你的应用而构建。

从单节点集群到多节点部署，沿着同一套集群模型扩展。

在 GitHub 上探索