WuKongIM Docs

Tutorials

Combine identity, Channels, messages, conversations, and scale boundaries into deployable product flows.

Scenario tutorials begin with a product outcome and connect the product service, client SDK, and WuKongIM cluster into one end-to-end path. They are not exhaustive API references; they establish responsibilities, ordering, success criteria, and compensation boundaries.

Establish a trusted boundary first

HTTP commands in these tutorials are for local development or a trusted product service. Current product HTTP routes have no general product-authentication middleware. Browsers and mobile clients must not hold these management capabilities directly.

Choose a path

GoalStart hereMost important boundary
Two users exchange messagesDirect ChatUse the peer UID; the server derives the canonical person Channel
Ordinary group chatGroups & Large GroupsThe product owns group lifecycle and membership; WuKongIM owns the message log
A 100,000-member community or roomGroups & Large GroupsBatched reconciliation, paged post-commit fanout, and hotspot capacity testing
Offline mobile notificationMessage PushThe webhook produces candidates; the product outbox and provider receipts own reliability
Streaming AI answerAI & IoT CommunicationCommit the base first, persist terminal projection, and keep live token streaming product-owned
Device telemetry and controlAI & IoT CommunicationA command-sync cursor is not proof of business execution

Shared success model

product authorization / membership state
        |
        v
SDK SEND or trusted HTTP send
        -> Channel quorum commit -> SENDACK / reason=1
        -> online delivery / webhook / plugin
        -> reconnect sync from the durable log

Treat “message committed,” “one Session received online delivery,” “the user's unread projection changed,” and “the business action completed” as four different outcomes. Strong business consistency belongs in the product service with its database, idempotency keys, and compensation workflow.

All four scenario tutorials are now published. Continue with Use Cases, Integration Architecture, and Messaging to turn these examples into your own product protocol and reliability targets.

On this page