# WuKongIM

> High-performance distributed instant messaging service documentation

## Docs

- [AI Agent Support](https://wukong.mintlify.app/en/ai/overview.md): WuKongIM natively supports AI Agent functionality, implementing streaming AI conversation experiences through the ag-ui protocol
- [Add Channel Subscribers](https://wukong.mintlify.app/en/api/channel/add-subscribers.md): Add subscribers (members) to a channel
- [Add Channel Blacklist](https://wukong.mintlify.app/en/api/channel/blacklist.md): Add users to channel blacklist
- [Remove Channel Blacklist](https://wukong.mintlify.app/en/api/channel/blacklist-remove.md): Remove specific users from channel blacklist
- [Set Channel Blacklist](https://wukong.mintlify.app/en/api/channel/blacklist-set.md): Set (replace) the entire blacklist for a channel
- [Create Channel](https://wukong.mintlify.app/en/api/channel/create.md): Create new chat channels
- [Delete Channel](https://wukong.mintlify.app/en/api/channel/delete.md): Delete a specified channel
- [Get Channel Whitelist](https://wukong.mintlify.app/en/api/channel/get-whitelist.md): Get the whitelist user list for a channel
- [Update Channel Info](https://wukong.mintlify.app/en/api/channel/info.md): Update or add channel basic information
- [Remove Channel Subscribers](https://wukong.mintlify.app/en/api/channel/remove-subscribers.md): Remove subscribers (members) from a channel
- [Set Temporary Channel Subscribers](https://wukong.mintlify.app/en/api/channel/tmp-subscriber-set.md): Set subscribers for a temporary channel (Internal API)
- [Add Channel Whitelist](https://wukong.mintlify.app/en/api/channel/whitelist.md): Add users to channel whitelist
- [Remove Channel Whitelist](https://wukong.mintlify.app/en/api/channel/whitelist-remove.md): Remove specific users from channel whitelist
- [Set Channel Whitelist](https://wukong.mintlify.app/en/api/channel/whitelist-set.md): Set (replace) the entire whitelist for a channel
- [Kick Connection](https://wukong.mintlify.app/en/api/connection/kick.md): Kick/disconnect a specific connection for a specified user
- [Remove Connection](https://wukong.mintlify.app/en/api/connection/remove.md): Remove a specific connection for a specified user
- [Clear Unread Messages](https://wukong.mintlify.app/en/api/conversation/clear-unread.md): Clear the unread message count for a conversation
- [Delete Conversation](https://wukong.mintlify.app/en/api/conversation/delete.md): Delete a specified user's conversation record
- [Set Conversation Unread Count](https://wukong.mintlify.app/en/api/conversation/set-unread.md): Set the unread message count for a specified conversation
- [Sync User Conversations](https://wukong.mintlify.app/en/api/conversation/sync.md): Sync user's conversation list and status
- [Send Event](https://wukong.mintlify.app/en/api/event/send.md): Send various types of events to channels, including streaming text messages and custom events
- [API Introduction](https://wukong.mintlify.app/en/api/introduction.md): Complete guide to WuKongIM REST API, including security specifications, request formats, and response standards
- [Manager Login](https://wukong.mintlify.app/en/api/manager/login.md): Manager user login to obtain access token
- [Batch Message Search](https://wukong.mintlify.app/en/api/message/batch-search.md): Batch search multiple messages by message ID list
- [Batch Send Messages](https://wukong.mintlify.app/en/api/message/batch-send.md): Send multiple messages in batch
- [Get Channel Max Message Sequence](https://wukong.mintlify.app/en/api/message/max-message-seq.md): Get the maximum message sequence number for a specified channel
- [Sync Channel Messages](https://wukong.mintlify.app/en/api/message/message-sync.md): Sync historical messages from a specified channel
- [Send Message](https://wukong.mintlify.app/en/api/message/send.md): Send messages to specified channels
- [Single Message Search](https://wukong.mintlify.app/en/api/message/single-search.md): Search for a single message by message ID
- [User Message Search](https://wukong.mintlify.app/en/api/message/user-search.md): Search all messages belonging to the current user, supporting multi-dimensional search and Chinese word segmentation
- [Get Connection Information](https://wukong.mintlify.app/en/api/monitoring/connections.md): Get current server connection statistics including connection count and user distribution
- [Get System Variables](https://wukong.mintlify.app/en/api/monitoring/variables.md): Get system variables and performance metrics
- [Batch Get User IM Addresses](https://wukong.mintlify.app/en/api/route/batch-address.md): Batch get IM connection addresses for multiple users
- [Get User IM Address](https://wukong.mintlify.app/en/api/route/get-address.md): Get the IM connection address for users
- [Health Check](https://wukong.mintlify.app/en/api/system/health.md): Check the health status of WuKongIM server and cluster
- [Get Migration Result](https://wukong.mintlify.app/en/api/system/migrate.md): Get the result status of data migration process
- [Add System User IDs](https://wukong.mintlify.app/en/api/user/add-system-uids.md): Add users to the system user ID list
- [Force Device Quit](https://wukong.mintlify.app/en/api/user/device-quit.md): Force user device to quit/disconnect
- [Get User Online Status](https://wukong.mintlify.app/en/api/user/online-status.md): Get online status information for multiple users
- [Remove System User IDs](https://wukong.mintlify.app/en/api/user/remove-system-uids.md): Remove users from the system user ID list
- [Get System User IDs](https://wukong.mintlify.app/en/api/user/system-uids.md): Get the list of system user IDs
- [Update User Token](https://wukong.mintlify.app/en/api/user/token.md): Update user authentication token
- [Webhook Callbacks](https://wukong.mintlify.app/en/api/webhook.md): WuKongIM pushes user online status, offline messages and all messages to third-party applications through webhooks
- [Channel](https://wukong.mintlify.app/en/getting-started/concepts/channel.md): Core structure and management methods of WuKongIM channels
- [Conversation](https://wukong.mintlify.app/en/getting-started/concepts/conversation.md): Core structure and management methods of WuKongIM conversations
- [Device](https://wukong.mintlify.app/en/getting-started/concepts/device.md): Core structure and management methods of WuKongIM devices
- [Message](https://wukong.mintlify.app/en/getting-started/concepts/message.md): Core structure and usage methods of WuKongIM messages
- [User](https://wukong.mintlify.app/en/getting-started/concepts/user.md): Core structure and management methods of WuKongIM users
- [JSON-RPC Protocol](https://wukong.mintlify.app/en/getting-started/learning/jsonrpc.md): Learn about the JSON-RPC 2.0 communication protocol format and message types used by WuKongIM
- [Offline Messages](https://wukong.mintlify.app/en/getting-started/learning/offline-messages.md): Understanding WuKongIM's offline message processing mechanism and recent conversation synchronization
- [Plugin Development](https://wukong.mintlify.app/en/getting-started/learning/plugin-development.md): Learn how to develop WuKongIM plugins to extend and enhance message processing functionality
- [Binary Protocol](https://wukong.mintlify.app/en/getting-started/learning/protocol.md): Detailed specification of WuKongIM communication protocol and packet structure
- [Stress Testing](https://wukong.mintlify.app/en/getting-started/learning/stress-testing.md): Learn how to perform stress testing on WuKongIM, including configuration, stress tester installation, running tests and analyzing reports
- [System Integration](https://wukong.mintlify.app/en/getting-started/learning/system-integration.md): Complete guide for integrating WuKongIM into existing business systems
- [Stress Test Report (Single Node)](https://wukong.mintlify.app/en/getting-started/stress-report.md): Detailed performance stress test report for WuKongIM single node mode
- [Introduction to WuKongIM](https://wukong.mintlify.app/en/index.md): Learn about WuKongIM's core features and capabilities
- [Multi-Node Deployment](https://wukong.mintlify.app/en/installation/docker/multi-node.md): Deploy WuKongIM multi-node cluster using Docker Compose
- [Cluster Scaling](https://wukong.mintlify.app/en/installation/docker/scaling.md): WuKongIM Docker cluster scaling operations guide
- [Docker Single Node](https://wukong.mintlify.app/en/installation/docker/single-node.md): Deploy WuKongIM in single node mode using Docker Compose
- [Version Upgrade](https://wukong.mintlify.app/en/installation/docker/upgrade.md): WuKongIM Docker deployment version upgrade guide
- [Multi-Node Deployment](https://wukong.mintlify.app/en/installation/k8s/multi-node.md): Deploy WuKongIM multi-node cluster in Kubernetes using Helm
- [Cluster Scaling](https://wukong.mintlify.app/en/installation/k8s/scaling.md): WuKongIM Kubernetes cluster scaling operations guide
- [Single Node Deployment](https://wukong.mintlify.app/en/installation/k8s/single-node.md): Deploy WuKongIM single node instance in Kubernetes cluster using Helm
- [Version Upgrade](https://wukong.mintlify.app/en/installation/k8s/upgrade.md): WuKongIM Kubernetes deployment version upgrade guide
- [Monitoring Setup](https://wukong.mintlify.app/en/installation/linux/monitoring.md): Set up monitoring system for WuKongIM Linux deployment
- [Multi-Node Deployment](https://wukong.mintlify.app/en/installation/linux/multi-node.md): Deploy WuKongIM multi-node cluster on Linux systems
- [Cluster Scaling](https://wukong.mintlify.app/en/installation/linux/scaling.md): WuKongIM Linux cluster scaling operations guide
- [Single Node Deployment](https://wukong.mintlify.app/en/installation/linux/single-node.md): Deploy WuKongIM single node instance on Linux system
- [Version Upgrade](https://wukong.mintlify.app/en/installation/linux/upgrade.md): WuKongIM Linux version upgrade guide
- [Installation Overview](https://wukong.mintlify.app/en/installation/overview.md): Choose the right deployment method for your WuKongIM setup
- [5-Minute Android Integration](https://wukong.mintlify.app/en/sdk/easy/android/getting-started.md): Quickly integrate WuKongIM Android EasySDK and implement chat functionality in 5 minutes
- [5-Minute Flutter Integration](https://wukong.mintlify.app/en/sdk/easy/flutter/getting-started.md): Quickly integrate WuKongIM Flutter EasySDK and implement chat functionality in 5 minutes
- [5-Minute iOS Integration](https://wukong.mintlify.app/en/sdk/easy/ios/getting-started.md): Quickly integrate WuKongIM iOS EasySDK and implement chat functionality in 5 minutes
- [5-Minute Web Integration](https://wukong.mintlify.app/en/sdk/easy/javascript/getting-started.md): Quickly integrate WuKongIM Web EasySDK and implement chat functionality in 5 minutes
- [Overview](https://wukong.mintlify.app/en/sdk/easy/overview.md): WuKongIM EasySDK cross-platform quick integration guide
- [SDK Overview](https://wukong.mintlify.app/en/sdk/overview.md): Choose the WuKongIM SDK that fits your project
- [SDK Source Code List](https://wukong.mintlify.app/en/sdk/source-code.md): WuKongIM official SDK source code repository list, including open source implementations for all platforms
- [Advanced Features](https://wukong.mintlify.app/en/sdk/wukongim/android/advance.md): WuKongIM Android SDK advanced features, including custom messages, message extensions, message receipts and message replies
- [Basic Features](https://wukong.mintlify.app/en/sdk/wukongim/android/base.md): WuKongIM Android SDK basic functionality, including initialization, connection management and status monitoring
- [Channel Management](https://wukong.mintlify.app/en/sdk/wukongim/android/channel.md): WuKongIM Android SDK channel management functionality, including channel information retrieval, updates and monitoring
- [Channel Member Management](https://wukong.mintlify.app/en/sdk/wukongim/android/channel-member.md): WuKongIM Android SDK channel member management functionality, including member retrieval, search and management
- [Command Management](https://wukong.mintlify.app/en/sdk/wukongim/android/cmd.md): WuKongIM Android SDK command management functionality, handling command messages sent from the server
- [Conversation Management](https://wukong.mintlify.app/en/sdk/wukongim/android/conversation.md): WuKongIM Android SDK conversation management functionality, including conversation lists, unread messages and conversation monitoring
- [Data Source Configuration](https://wukong.mintlify.app/en/sdk/wukongim/android/datasource.md): WuKongIM Android SDK data source configuration, including file upload/download, conversation sync, channel information and message sync
- [Integration Guide](https://wukong.mintlify.app/en/sdk/wukongim/android/integration.md): WuKongIM Android SDK integration and initialization configuration guide
- [SDK Introduction](https://wukong.mintlify.app/en/sdk/wukongim/android/intro.md): WuKongIM Android SDK design philosophy, architecture overview and core functionality introduction
- [Message Management](https://wukong.mintlify.app/en/sdk/wukongim/android/message.md): WuKongIM Android SDK message management functionality, including message sending/receiving, history messages and message monitoring
- [Reminder Management](https://wukong.mintlify.app/en/sdk/wukongim/android/reminder.md): WuKongIM Android SDK reminder management functionality, handling conversation reminders and notifications
- [Advanced Features](https://wukong.mintlify.app/en/sdk/wukongim/flutter/advance.md): WuKongIM Flutter SDK advanced features, including custom message types and extension functionality
- [Basic Features](https://wukong.mintlify.app/en/sdk/wukongim/flutter/base.md): WuKongIM Flutter SDK basic functionality, including initialization, connection management and status monitoring
- [Channel Management](https://wukong.mintlify.app/en/sdk/wukongim/flutter/channel.md): WuKongIM Flutter SDK channel management functionality, including channel information retrieval and monitoring
- [Channel Member Management](https://wukong.mintlify.app/en/sdk/wukongim/flutter/channel_member.md): WuKongIM Flutter SDK channel member management functionality, including member retrieval, listening and operations
- [Command Management](https://wukong.mintlify.app/en/sdk/wukongim/flutter/cmd.md): WuKongIM Flutter SDK command management functionality, including CMD message listening and processing
- [Conversation Management](https://wukong.mintlify.app/en/sdk/wukongim/flutter/conversation.md): WuKongIM Flutter SDK conversation management functionality, including recent conversation retrieval, listening and operations
- [Data Source Configuration](https://wukong.mintlify.app/en/sdk/wukongim/flutter/datasource.md): WuKongIM Flutter SDK data source configuration, including file upload/download, conversation sync, channel information and message sync
- [Integration Guide](https://wukong.mintlify.app/en/sdk/wukongim/flutter/integration.md): WuKongIM Flutter SDK integration guide, including installation, configuration and initialization
- [SDK Introduction](https://wukong.mintlify.app/en/sdk/wukongim/flutter/intro.md): WuKongIM Flutter SDK design philosophy, architecture overview and core functionality introduction
- [Message Management](https://wukong.mintlify.app/en/sdk/wukongim/flutter/message.md): WuKongIM Flutter SDK message management functionality, including message sending/receiving, listening and history messages
- [Reminder Management](https://wukong.mintlify.app/en/sdk/wukongim/flutter/reminder.md): WuKongIM Flutter SDK reminder management functionality, including @mentions, system reminders and custom reminders
- [Advanced Features](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/advance.md): WuKongIM HarmonyOS SDK advanced features, including custom message types and extension functionality
- [Basic Features](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/base.md): WuKongIM HarmonyOS SDK basic functionality, including initialization, connection management and status monitoring
- [Channel Management](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/channel.md): WuKongIM HarmonyOS SDK channel management functionality, including channel information retrieval and monitoring
- [Channel Member Management](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/channel_member.md): WuKongIM HarmonyOS SDK channel member management functionality, including member retrieval, listening, and operations
- [Command Management](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/cmd.md): WuKongIM HarmonyOS SDK command management functionality, including CMD message listening and processing
- [Conversation Management](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/conversation.md): WuKongIM HarmonyOS SDK conversation management functionality, including recent conversation retrieval, listening and operations
- [Data Source Configuration](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/datasource.md): WuKongIM HarmonyOS SDK data source configuration, including file upload/download, conversation sync, channel information and message sync
- [Integration Guide](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/integration.md): WuKongIM HarmonyOS SDK integration guide, including installation, configuration and initialization
- [SDK Introduction](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/intro.md): WuKongIM HarmonyOS SDK design philosophy, architecture overview and core functionality introduction
- [Message Management](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/message.md): WuKongIM HarmonyOS SDK message management functionality, including message sending/receiving, listening and history messages
- [Reminder Management](https://wukong.mintlify.app/en/sdk/wukongim/harmonyos/reminder.md): WuKongIM HarmonyOS SDK reminder management functionality, including @mentions, system reminders, and custom reminders
- [Advanced Features](https://wukong.mintlify.app/en/sdk/wukongim/ios/advanced.md): WuKongIM iOS SDK advanced features including custom message types and extension functionality
- [Channel Management](https://wukong.mintlify.app/en/sdk/wukongim/ios/channel.md): WuKongIM iOS SDK channel management functionality, including channel information retrieval, updates and monitoring
- [Chat Management](https://wukong.mintlify.app/en/sdk/wukongim/ios/chat.md): WuKongIM iOS SDK chat management functionality, including message sending/receiving, message history and message extensions
- [Connection Management](https://wukong.mintlify.app/en/sdk/wukongim/ios/connection.md): WuKongIM iOS SDK connection management and status monitoring guide
- [Conversation Management](https://wukong.mintlify.app/en/sdk/wukongim/ios/conversation.md): WuKongIM iOS SDK conversation management functionality, including conversation lists, unread messages and conversation extensions
- [Integration Guide](https://wukong.mintlify.app/en/sdk/wukongim/ios/integration.md): WuKongIM iOS SDK integration and initialization configuration guide
- [SDK Introduction](https://wukong.mintlify.app/en/sdk/wukongim/ios/intro.md): WuKongIM iOS SDK design philosophy, architecture overview and core functionality introduction
- [Media Management](https://wukong.mintlify.app/en/sdk/wukongim/ios/media.md): WuKongIM iOS SDK media management functionality including file upload/download and progress management
- [Advanced Features](https://wukong.mintlify.app/en/sdk/wukongim/javascript/advance.md): WuKongIM JavaScript SDK advanced features, including custom message types and extension functionality
- [Basic Features](https://wukong.mintlify.app/en/sdk/wukongim/javascript/base.md): WuKongIM JavaScript SDK basic functionality, including configuration, connection management and status monitoring
- [Channel Management](https://wukong.mintlify.app/en/sdk/wukongim/javascript/channel.md): WuKongIM JavaScript SDK channel management functionality, including channel information retrieval, subscriber management and monitoring
- [Chat Management](https://wukong.mintlify.app/en/sdk/wukongim/javascript/chat.md): WuKongIM JavaScript SDK chat management functionality, including message sending, receiving and history message handling
- [Conversation Management](https://wukong.mintlify.app/en/sdk/wukongim/javascript/conversation.md): WuKongIM JavaScript SDK conversation management functionality, including recent conversation sync, listening and operations
- [Data Source Configuration](https://wukong.mintlify.app/en/sdk/wukongim/javascript/datasource.md): WuKongIM JavaScript SDK data source configuration, including file upload, conversation sync, channel information and message sync
- [Integration Guide](https://wukong.mintlify.app/en/sdk/wukongim/javascript/integration.md): WuKongIM JavaScript SDK integration and initialization configuration guide
- [SDK Introduction](https://wukong.mintlify.app/en/sdk/wukongim/javascript/intro.md): WuKongIM JavaScript SDK design philosophy, architecture overview and core functionality introduction
- [WeChat Miniprogram](https://wukong.mintlify.app/en/sdk/wukongim/miniprogram/intro.md)
- [Uniapp](https://wukong.mintlify.app/en/sdk/wukongim/uniapp/intro.md)
- [Server Configuration](https://wukong.mintlify.app/en/server/configuration.md): Complete WuKongIM server configuration guide

## OpenAPI Specs

- [openapi](https://wukong.mintlify.app/api-reference/openapi.json)

## Optional

- [Chat Demo](http://imdemo.githubim.com/)
- [Admin Demo](http://monitor.githubim.com/web/)
- [Releases](https://github.com/WuKongIM/WuKongIM/releases)
- [Legacy Docs](http://oldv2.githubim.com/)
- [聊天演示](http://imdemo.githubim.com/)
- [后台演示](http://monitor.githubim.com/web/)
- [Releases](https://github.com/WuKongIM/WuKongIM/releases)
- [旧版文档](http://oldv2.githubim.com/)