API & Protocols

Reference WuKongIM HTTP API, operations HTTP, webhooks, WKProto, and internal-interface boundaries.

This section classifies every current source interface by audience and protocol. Public contracts are downloadable; private, conditional, and experimental entries are documented as boundaries, not compatibility promises.

Quick links

Conventions

Base URL, JSON, identifiers, cursors, and retry rules.

Authentication & Security

Trust boundaries for WuKongIM HTTP API and Gateway.

WuKongIM HTTP API

All 44 business HTTP operations registered by the current source.

Operations HTTP API

Health, readiness, metrics, Top, Debug, and Bench boundaries.

Webhooks

Three outbound events, payloads, and reliability semantics.

Client Protocols

WKProto frames, lifecycle, encryption, and the EasySDK JSON-RPC core path.

Shared Dictionaries

Channel, device, message-flag, and Reason Code values.

Interface Inventory

Manager, node transport, MCP, plugin, and agent-private contracts.

Specifications

OpenAPI 3.1 and the experimental JSON-RPC Schema.

Usage boundaries

WuKongIM HTTP API is for trusted backends only; do not expose it directly to browsers or mobile clients.
Operations HTTP and Manager belong on an isolated operator network; they are separate contracts.
JSON-RPC supports CONNECT, ping, online SEND/SENDACK, RECV/RECVACK, and server-to-client public stream.* EVENT for EasySDK; batches, subscriptions, offline sync, and general-purpose RPC are outside that contract.
HTTP status, endpoint responses, and CONNACK/SENDACK Reason Codes belong to separate layers and must be handled separately.
See API Compatibility for version coverage and Error Responses for failure handling.