TIMSDK/README.md

English | [简体中文](./README_ZH.md)

# Tencent Cloud Chat SDK (IM SDK)

Tencent Chat SDK provides a powerful **Chat API**, **messaging SDK**, and **UIKit** components to help developers build full-featured real-time messaging — including **one-to-one chat**, **channel chat**, **message push**, **offline push notifications**, and **send message** functionality — across **Android, iOS, MAC, Windows, Web, Flutter, React Native**, and more.

## About

Tencent Chat SDK powers billions of messages daily across Tencent's ecosystem. Drop in our pre-built **UIKit** to ship a full-featured chat experience in under 10 minutes, or use the **Core SDK** to build your own UI on top of a battle-tested messaging infrastructure — available across every major platform.

<img src="https://qcloudimg.tencent-cloud.cn/raw/9c893f1a9c6368c82d44586907d5293d.png" style="zoom:50%;"/>

## Core Capabilities

- **UIKit** — Build a fully-featured chat app in just ten minutes using UIKit components
- **Various Message Types** — Support multiple message types, such as text, images, audio, and video messages
- **Message Status** — Real-time read receipts, online/offline status, and typing indicators for a responsive chat experience
- **Notifications** — Timely notify users of app messages and drive higher conversion rates
- **Channel** — Create channels, manage channel members, and customize profiles
- **Conversation Management** — View information about unread messages, recent, pinned, or deleted chats
- **Large-Scale Communities** — Support communities up to 1,000,000 members with topic-based sub-channels for fan groups, events, and more
- **Advanced Features** — Cloud-based message search, real-time text translation, Official Channels, and message merging for power users

## Get Started

This is the central hub repository for Tencent Chat SDK. Choose your platform below to find the dedicated repo and integration guide.

> Tencent Chat SDK offers a **[free plan](https://trtc.io/free-chat-api)** — 1,000 MAU/month, no concurrency limits, push notifications included, free forever.

### UIKit — Platform Routing

| Platform | Repository | Integration Guide |
|---|---|---|
| Android (View) | [chat-uikit-android](https://github.com/TencentCloud/chat-uikit-android) | [UIKit for Android](https://trtc.io/document/60520) |
| Android (Compose) | [TUIKit_Android_Compose](https://github.com/Tencent-RTC/TUIKit_Android_Compose) | [UIKit for Android (Compose)](https://trtc.io/document/60520) |
| iOS (UIKit) | [Chat_UIKit](https://github.com/Tencent-RTC/Chat_UIKit) | [UIKit for iOS](https://trtc.io/document/60521) |
| iOS (SwiftUI) | [TUIKit_iOS_SwiftUI](https://github.com/Tencent-RTC/TUIKit_iOS_SwiftUI) | [UIKit for iOS (SwiftUI)](https://trtc.io/document/60521) |
| Web (React) | [chat-uikit-react](https://github.com/TencentCloud/chat-uikit-react) | [UIKit for React](https://trtc.io/document/50055) |
| Web (Vue) | [chat-uikit-vue](https://github.com/TencentCloud/chat-uikit-vue) | [UIKit for Vue](https://trtc.io/document/58644) |
| Flutter | [TUIKit_Flutter](https://github.com/Tencent-RTC/TUIKit_Flutter) | [UIKit for Flutter](https://trtc.io/document/58585) |
| React Native | [chat-demo-react-native](https://github.com/TencentCloud/chat-demo-react-native) | [UIKit for React Native](https://trtc.io/document/56573) |

### Core SDK — Platform Routing

| Platform | Repository | Integration Guide |
|---|---|---|
| Android | [chat-uikit-android / ChatSDK](https://github.com/TencentCloud/chat-uikit-android/tree/main/ChatSDK) | [SDK Integration (Android)](https://trtc.io/document/34306) |
| iOS | [chat-uikit-ios / ChatSDK](https://github.com/TencentCloud/chat-uikit-ios/tree/main/ChatSDK) | [SDK Integration (iOS)](https://trtc.io/document/34307) |
| Mac | [TIMSDK / Mac](https://github.com/TencentCloud/TIMSDK/blob/master/Mac/IMSDK/README_CHAT.md) | [SDK Integration (Mac)](https://trtc.io/document/34308) |
| Windows | [TIMSDK / Windows](https://github.com/TencentCloud/TIMSDK/tree/master/Windows/IMSDK) | [SDK Integration (Windows)](https://trtc.io/document/34310) |
| Flutter | [pub: tencent_cloud_chat_sdk](https://pub.dev/packages/tencent_cloud_chat_sdk) | [SDK Integration (Flutter)](https://trtc.io/document/46264) |
| React Native | [npm: @tencentcloud/chat](https://www.npmjs.com/package/@tencentcloud/chat) | [SDK Integration (React Native)](https://trtc.io/document/48865) |
| Web (JS) | [npm: @tencentcloud/chat](https://www.npmjs.com/package/@tencentcloud/chat) | [SDK Integration (JavaScript)](https://trtc.io/document/34309) |

## Use Cases

Build industry-specific solutions using Tencent Chat SDK:

- 💬 [Official Channel](https://trtc.io/document/69925) — WhatsApp Channel-style broadcast & subscription for brand engagement
- 🎮 [Discord-style Community](https://trtc.io/document/53499) — Servers, channels, threads, and reactions for large-scale communities
- 🤖 [AI Chatbot](https://trtc.io/document/54925) — Integrate LLM-powered chat bots for customer service, companionship, and more
- 🧧 [Red Packet](https://trtc.io/document/78288) — Send red packets in one-on-one and group chats using custom messages and payment integration

## Quick Links

- 🤖 [Build with AI](https://trtc.io/document/72277) — Integrate AI capabilities into your chat experience
- 🎮 [Live Demo](https://trtc.io/demo/homepage/#/detail?scene=messenger) — Try Tencent Chat SDK in your browser
- 📡 [REST API Reference](https://trtc.io/document/34620?product=chat&menulabel=restfulapi) — Server-side APIs for user management, messaging, and more
- 🏠 [Product Home](https://trtc.io/products/chat) — Overview, pricing, and enterprise features
- 🖥️ [Console](https://console.trtc.io) — Manage your applications and monitor usage
- 🔄 [Chat SDK V2 API Upgrade Guide](https://docs.qq.com/sheet/DS3lMdHpoRmpWSEFW)

## Contact Us

- **Stack Overflow**: Tag your questions with [`trtc.io`](https://stackoverflow.com/questions/tagged/trtc.io)
- **Telegram**: [Join our developer community](https://t.me/+EPk6TMZEZMM5OGY1)
- **WhatsApp**: [Chat with our team](https://chat.whatsapp.com/Gfbxk7rQBqc8Rz4pzzP27A)
- **GitHub Issues**: [Report a bug or request a feature](https://github.com/TencentCloud/TIMSDK/issues)