WuKongIM Developer Docsv3 Beta

Every message.Delivered reliably.

Build real-time communication into your application. Start with your first message, then explore client SDKs, cluster deployment, and the complete API.

Try the demoIntegrate your app
Find a concept, setting, or API
first-message.tsTypeScript
SDK code excerpt
// Once connected, send a message to Bob

await sdk.chatManager.send(
  new MessageText('Hello, WuKongIM!'),
  new Channel('bob', ChannelTypePerson),
);
Read the full quickstart
AAliceSENDER
WuKongIMCLUSTER
BBobRECIPIENT
Verify the server send result and recipient event separately
CHOOSE YOUR PLATFORM
JavaScript / WebAndroidiOSFlutterHarmonyOS

EXPLORE THE DOCS

Find your next step

A clear path from learning the concepts to running in production.

01

LEARN

Guides

Learn WuKongIM and complete your first product integration.

Explore docs
02

DEPLOY

Server

Deploy, configure, operate, and understand a WuKongIM cluster.

Explore docs
03

INTEGRATE

SDK

Integrate WuKongIM across client platforms.

Explore docs
04

REFERENCE

API & Protocols

Reference source-aligned HTTP, webhook, client-protocol, and private-interface boundaries.

Explore docs

YOUR FIRST MESSAGE

New here? Start with one message.

Exchange a message between two test users, then bring the same flow into your application.

Open the quick start
  1. 01

    Start a cluster

    Start a single-node cluster on your computer with Docker.

  2. 02

    Try messaging

    Open the embedded Demo and exchange messages as Alice and Bob.

  3. 03

    Integrate your app

    Choose a platform SDK and bring the working flow into your app.

KEEP BUILDING

Keep these within reach

Core concepts

Messages, channels, users, and conversations

Docker deployment

Images, configuration, and persistent storage

Try the four Demos

Chat, streaming replies, support, and Agent

Configuration reference

TOML, environment variables, and defaults

Health & monitoring

Readiness, metrics, and alerts

WuKongIM HTTP API

Server endpoints and request examples

Open source. Self-hosted. Built for your app.

Grow from a single-node cluster to multiple nodes with the same cluster model.

Explore on GitHub