# Chat

> In-app messaging SDK and API for one-to-one chat, group chat, community chat, rich messages, offline push, read receipts, message recall, translation, moderation, UIKit integration, Core SDK customization, and AI-assisted development.

This index is the entry point for LLMs. It links to shared product-level docs and to one `llms.txt` per supported platform. Each linked page also has a `.md` twin (append `.md` to the URL) containing the raw markdown.

## Platforms

https://pre.trtc.io/llms/chat/android.txt
https://pre.trtc.io/llms/chat/ios-and-macos.txt
https://pre.trtc.io/llms/chat/vue.txt
https://pre.trtc.io/llms/chat/react.txt
https://pre.trtc.io/llms/chat/react-native.txt
https://pre.trtc.io/llms/chat/flutter.txt
https://pre.trtc.io/llms/chat/javascript.txt
https://pre.trtc.io/llms/chat/windows.txt
https://pre.trtc.io/llms/chat/unity-game-solution.txt
https://pre.trtc.io/llms/chat/unreal-engine-game-solution.txt

## Basics

- [Product Introduction](https://pre.trtc.io/document/50062.md): TUIKit is a UI component library based on the Chat SDK, designed to help developers quickly build chat-related business logic with universal UI components. It supports conversation, chat, search, contacts, group management, and audio/video call features across Android (View) and iOS (UIKit) platforms. TUIKit offers both classic and minimalist UI versions and includes support for right-to-left languages such as Arabic and Hebrew, enabling flexible and customizable chat experiences.
- [Features Overview](https://pre.trtc.io/document/33515.md): The Chat SDK is a comprehensive communication SDK that supports a wide range of platforms such as Android, iOS, Windows, Mac, Web, and more. It offers global network access with optimized routing to ensure secure and reliable connections worldwide. The SDK provides essential account management features including batch account import, deactivation, deletion, and online status tracking. It supports flexible multi-client login options across different devices and platforms. Additionally, the Chat SDK enables diverse messaging types including text, images, audio, files, custom messages, and system notifications to meet various communication needs.
- [Basic Concepts](https://pre.trtc.io/document/74361.md): Tencent Cloud Instant Messaging (IM) SDK provides a comprehensive platform for managing multiple applications, enabling secure user authentication with UserID and UserSig, and supporting various chat modes including one-on-one C2C chat and multi-user group chats. This overview explains core concepts such as SDKAppID for application identification, App Admin roles, and group types tailored for scenarios like work collaboration, social interaction, meetings, and live streaming.
- [Scenarios](https://pre.trtc.io/document/33514.md): Tencent Cloud Chat SDK is a comprehensive communication platform offering social chat, live streaming interaction, smart customer service, IoT communication, enterprise messaging, system notifications, in-game chat, and online education support. It enables developers to integrate text, audio, video messaging, and real-time calls across diverse scenarios to improve user engagement and operational efficiency.
- [Use Limits](https://pre.trtc.io/document/34381.md): Tencent Cloud Chat SDK provides detailed limits on messaging features, user accounts, conversation management, and group configurations. This overview explains content size restrictions, sending frequencies, file size limits, and message history retention periods across different editions. It also covers user ID rules, custom profile fields, friend and blocklist capacities, and group membership constraints to help developers understand usage boundaries and optimize their applications.
- [Authentication & UserSig](https://pre.trtc.io/document/34385.md): UserSig (User Signature) is a security credential used by Tencent Real-Time Communication (TRTC) to authenticate user identities and protect cloud service traffic. This guide explains how to generate UserSig through console, client-side, and server-side methods, highlighting server-side generation as the recommended secure approach for production. It covers prerequisites, generation steps, and best practices to ensure secure and dynamic UserSig provisioning for TRTC applications.

## Pricing

- [Billing Overview](https://pre.trtc.io/document/34349.md): Chat monthly plans offer core instant messaging capabilities with included monthly active user (MAU) allowances and usage limits. This overview explains the pricing structure, including standard plans, pay-as-you-go overages for additional usage such as message delivery and text translation, and related product billing. Users can utilize the online Pricing Estimator to select the most suitable plan based on their expected scale and costs.
- [Pricing](https://pre.trtc.io/document/67650.md): Chat Monthly Package is a prepaid subscription service offering multiple plans such as Free, Standard, Pro, Pro Plus, and Enterprise tailored for app developers and businesses. It enables flexible billing per app with monthly active user quotas and concurrent connection limits. This overview explains billing rules, pricing, core quotas, and detailed feature comparisons to help users select the appropriate plan for their communication needs.
- [Billing of Chat Out-of-Package Usage](https://pre.trtc.io/document/67651.md): Tencent Cloud Chat Out-of-Package Usage Billing document provides detailed pricing information for on-demand features including overage monthly active users (MAU), community message delivery volume, text message translation, cloud search limited to the Singapore data center, cloud push, and server-side API rate-limit adjustments. This guide is designed for developers and businesses using Chat SDKs who need to understand billing beyond monthly plans, including free trial quotas and monthly postpaid charges across different subscription tiers.

## Build with AI

- [Overview](https://pre.trtc.io/document/72277.md): Tencent RTC Chat integration SDK provides AI-powered tools to scaffold projects, install TUIKit, generate test credentials, and run applications. It supports multiple platforms including Web (React 18, Vue3), Android, iOS, and Flutter. The Model Context Protocol (MCP) server facilitates AI access to integration documentation and management tools. Skill offers Q&A and integration solutions, while Markdown documentation and troubleshooting guides enhance developer experience.
- [Configure MCP server](https://pre.trtc.io/document/78210.md): MCP is an AI-powered SDK that provides Chat knowledge query and UI integration capabilities across Web, Android, iOS, and Flutter platforms. This quickstart guide helps developers configure MCP in AI editors such as Cursor, Codex, and Claude by setting up necessary environment variables and verifying the setup. Follow step-by-step instructions to enable fast and accurate Chat documentation search and feature integration.
- [Install SKILL](https://pre.trtc.io/document/78211.md): TRTC Skill is a chat SDK integration solution offering Chat Knowledge Q&A and Vue3 Headless State API for building chat features. It supports multiple platforms including Web, Mini Program, Android, iOS, Flutter, and uni-app. This guide covers installation steps using CodeBuddy, Cursor, Codex CLI, or Claude Code CLI and demonstrates how to quickly start chat integration by prompting Skill with your requirements.
- [Integration guide](https://pre.trtc.io/document/78212.md): Chat TUIKit integration guide provides step-by-step instructions to incorporate the full-featured chat UI kit into projects across React, Vue3, Flutter, Android, and iOS platforms. It helps developers initialize the SDK, perform user login, and implement conversation lists and chat windows. The guide also includes verification steps for message sending and receiving between test users, along with troubleshooting advice for common integration issues.
- [Integrate Chat window only](https://pre.trtc.io/document/78213.md): The Tencent RTC Chat window component SDK allows developers to embed a single chat window into existing React or Vue web applications. It is designed for apps that already have navigation and only require messaging UI in a specific location. This guide provides step-by-step instructions for integrating the chat window component, customizing it via component API, and locking conversations to specific users, enabling scenarios like customer support, online consultation, and in-meeting chat.
- [FAQ](https://pre.trtc.io/document/78214.md): Tencent RTC Chat SDK FAQ provides solutions for common problems including MCP server connectivity, login credential errors, package installation issues, and platform-specific setup errors on Android, iOS, and Flutter. This guide helps developers quickly identify and resolve issues such as UserSig expiration, SDK_APP_ID and SECRET_KEY mismatches, and permission errors to ensure smooth integration and operation.

## All_Platform

- [RESTful API Overview](https://pre.trtc.io/document/34620.md): The RESTful API is a set of HTTP management APIs designed to provide app backends with management capabilities over HTTPS. It is intended for developers managing Chat applications, enabling secure and powerful backend operations such as user and data management. The API supports POST requests with JSON bodies, requires admin account authentication, and returns structured JSON responses with status and error information.
- [RESTful API List](https://pre.trtc.io/document/34621.md): This RESTful API reference provides detailed endpoints for managing accounts, sending messages, handling profiles, managing relationships, groups, and push notifications within Tencent RTC. It is designed for developers integrating messaging and social interaction capabilities into their applications, offering comprehensive API methods to support real-time communication scenarios.
- [Sending One-to-One Messages to One User](https://pre.trtc.io/document/34919.md): The Send One-to-One Messages API is part of the Tencent RTC Chat SDK, enabling an admin to send messages directly to a specified user account. This API supports flexible sender identity display, message deduplication, and synchronization control to sender devices via the SyncOtherMachine parameter. It does not enforce friendship or mute checks, providing developers with granular control over message delivery and display. The API accepts JSON formatted requests and supports up to 200 calls per second.
- [Sending One-to-One Messages to Multiple Users](https://pre.trtc.io/document/34920.md): The Batch Send One-to-One Messages API of Tencent RTC Chat SDK allows sending messages to up to 500 users simultaneously. It is designed for scenarios requiring fast delivery of time-sensitive messages like marketing and system notifications. This API supports message lifetime control, synchronization options, and does not enforce friendship or mute checks by default. Developers can use this API to efficiently send bulk messages with customizable parameters including message sequence and randomization, ensuring flexible and scalable messaging capabilities.
- [Sending Ordinary Messages in a Group](https://pre.trtc.io/document/34959.md): The send_group_msg API is a RESTful interface provided by Tencent RTC Chat SDK that enables app administrators to send ordinary messages within various group types such as Private, Public, ChatRoom, AVChatRoom, and Community. It supports JSON formatted requests with parameters including sdkappid, identifier, usersig, and random for authentication and message uniqueness. This API embeds sender information automatically to optimize message delivery and reduce server load. It allows specifying a group member as the message sender and supports a maximum call frequency of 200 calls per second.
- [Sending System Messages in a Group](https://pre.trtc.io/document/34958.md): The Sending System Messages in a Group API is a Chat SDK interface that allows app administrators to push system notifications to various group types including Private, Public, ChatRoom, AVChatRoom, and Community groups. It supports sending notifications to all or specific group members except for AVChatRoom which only allows notifications to all members. This API is designed for app admins to manage group communications efficiently, with a maximum call frequency of 200 calls per second and JSON request/response formats. Key parameters include group ID, recipient accounts, and notification content. Error codes and unique request IDs facilitate troubleshooting.
- [Broadcast Message of Audio-Video Group](https://pre.trtc.io/document/49440.md): The Broadcast Message API for audio-video groups is part of the Tencent RTC SDK, enabling developers to send broadcast messages to all audio-video groups. It supports the AVChatRoom group type and requires enabling the feature in the console with a Pro, Pro Plus, or Enterprise edition license. The API accepts JSON-formatted requests with parameters including sdkappid, identifier, usersig, and message content, supporting up to 5 calls per second depending on the edition. The response provides detailed status and message identifiers to ensure reliable message delivery.
- [Importing One-to-One Messages](https://pre.trtc.io/document/35014.md): The Importing One-to-One Messages API for Tencent Cloud Chat SDK allows developers to import chat history from other instant messaging platforms in chronological order. It supports deduplication of messages based on key fields and enables importing both real-time and historical messages with specific flags. This API is designed for app administrators to update conversations without triggering callbacks, supporting up to 200 calls per second. Key parameters include SyncFromOldSystem, From_Account, To_Account, MsgSeq, MsgRandom, and MsgTimeStamp.
- [Importing Group Messages](https://pre.trtc.io/document/34968.md): The Importing Group Messages API in Tencent Cloud Chat enables developers to migrate group message data from other instant messaging systems without triggering callbacks or notifications. It supports importing messages for Private, Public, ChatRoom, and Community group types but excludes audio-video groups (AVChatRoom). This RESTful API accepts JSON requests to import up to seven messages per call, requiring messages to be ordered by timestamp and within valid time boundaries. The API is designed for app administrators to efficiently manage group message data during migration or synchronization processes.
- [Sending Messages in a Official Channel](https://pre.trtc.io/document/60810.md): The Sending Messages API for Official Accounts is a RESTful API that enables App Administrators to broadcast ordinary messages to all subscribers of an official account. It supports JSON formatted requests with parameters including sdkappid, identifier, usersig, and random. The API enforces rate limits of 1 message per second and 2 broadcast messages per hour per official account, and filters duplicate messages sent within 5 minutes. This API is designed for administrators managing official accounts across multiple regions with dedicated domain endpoints.
- [Pulling Historical One-to-one Messages](https://pre.trtc.io/document/35478.md): The Pulling Historical One-to-One Messages API enables app admins to retrieve message histories of one-to-one conversations based on a specified time range from the perspective of a conversation party. It supports querying recalled messages, read receipt status, and handles message retention according to the roaming message storage period. This API is designed for app administrators to manage and audit chat histories effectively, with a maximum call frequency of 200 calls per second and JSON request format.
- [Pulling Historical Group Messages](https://pre.trtc.io/document/34971.md): Tencent Chat Pulling Historical Group Messages API is a RESTful interface that enables app administrators to retrieve historical messages from various group types, including private, public, chat rooms, and communities. It supports fetching messages by sequence number or message count with a maximum of 20 messages per request and a call frequency limit of 200 calls per second. This API excludes audio-video groups (AVChatRoom) due to message storage limitations. Key parameters include GroupId, ReqMsgNumber, ReqMsgSeq, and options for recalled messages and topic filtering.
- [Pulling Historical Official Account Messages](https://pre.trtc.io/document/60812.md): The Pulling Historical Official Account Messages API is part of the Chat SDK that enables app administrators to retrieve historical messages from Official Accounts. It supports pagination through the LastMsgKey parameter and returns detailed message data including sequence and timestamp. This API helps manage message history efficiently with a maximum calling frequency of 200 queries per second.
- [Modifying Historical One-to-one Messages](https://pre.trtc.io/document/47722.md): The Modify Historical One-to-One Messages API in Tencent RTC Chat service enables administrators to update the MsgBody and CloudCustomData fields of past one-to-one messages. This API requires the unique MsgKey of the message, which can be obtained via callbacks or query APIs. It supports JSON requests and provides detailed response status and error codes. Designed for app administrators, it facilitates message content management across multiple regions with a maximum call frequency of 200 requests per second.
- [Modifying Historical Group Messages](https://pre.trtc.io/document/47948.md): The Modify Historical Group Messages API is part of the Chat platform SDK, enabling administrators to update the MsgBody and CloudCustomData fields of historical group chat messages. It is designed for app administrators to manage message content in group chats, excluding audio-video groups. The API supports JSON request format, requires authentication via UserSig, and enforces a maximum call frequency of 200 calls per second. It provides detailed response codes and error information to facilitate troubleshooting and integration.
- [Deleting Messages Sent by a Specified User](https://pre.trtc.io/document/34970.md): The Delete Group Messages by Sender API in Tencent RTC Chat allows recalling messages sent by a specified user within the last 1,000 messages of a group. It supports multiple group types including Private, Public, ChatRoom, and Community, excluding AVChatRoom which lacks historical message storage. This API performs silent recall by marking messages as recalled on the server without client notification. It is intended for app administrators to manage group message history with a maximum call frequency of 200 requests per second. Key parameters include group ID, sender account, and optional topic ID for topic-enabled communities.
- [Clearing Historical Group Messages](https://pre.trtc.io/document/65970.md): The Clearing Historical Group Messages API is part of the Tencent RTC Chat SDK that allows app administrators to mark group chat messages as deleted, preventing the SDK from retrieving them while still allowing administrators to access these messages via the Pull Historical Group Messages API. This API supports various group types including Private, Public, ChatRoom, and AVChatRoom, and requires parameters such as GroupId and MsgSeq to specify the scope of messages to clear. It handles up to 200 calls per second and provides detailed response information and error codes to assist in integration and troubleshooting.
- [Recalling One-to-One Messages](https://pre.trtc.io/document/35015.md): The Recalls One-to-One Messages API is part of the Tencent RTC Chat SDK, allowing administrators to recall individual messages sent between users. It supports recalling messages sent by clients or via specific RESTful APIs using the unique MsgKey identifier. This API removes messages from offline, roaming storage, and client caches without time restrictions. It accepts JSON requests with parameters such as From_Account, To_Account, and MsgKey, and returns JSON responses indicating success or detailed error codes. The API supports up to 200 calls per second, facilitating efficient message management.
- [Recalling Group Messages](https://pre.trtc.io/document/34965.md): The Group Message Recall API is part of the Tencent Cloud Chat platform, enabling administrators to recall group messages valid for roaming across multiple group types including Private, Public, ChatRoom, AVChatRoom, and Community. This API requires specifying the GroupId and a list of message sequences (MsgSeqList) to recall messages sent either from clients or via RESTful APIs. It supports up to 10 message recalls per request and allows a maximum call frequency of 200 calls per second. The API response provides detailed status and error codes for each recalled message, facilitating effective message management in group chats.
- [Marking One-to-One Messages as Read](https://pre.trtc.io/document/38996.md): The Marking One-to-One Messages as Read API is part of the Tencent RTC Chat SDK, enabling app admins to mark messages in one-to-one conversations as read. It supports marking messages before a specified timestamp and handles group read receipts for groups up to 200 members. This API is designed for app administrators to manage message read statuses efficiently with a maximum call frequency of 200 requests per second. Detailed request parameters, response fields, error codes, and debugging tools are provided to facilitate integration and troubleshooting.
- [Pulling Group Message Read Receipt Details](https://pre.trtc.io/document/49438.md): The Pulling Group Message Read Receipt Details API is part of the Chat platform API, enabling app administrators to retrieve lists of group members who have read or not read a specific group message. Available exclusively in the Pro, Pro Plus, or Enterprise editions, this API supports private, public, and chatroom group types. It requires key parameters including GroupId, MsgSeq, Filter, Cursor, and Count, and allows up to 200 calls per second, facilitating efficient management of group message read statuses.
- [Pulling Read Receipts for Group Messages](https://pre.trtc.io/document/49439.md): The Pulling Read Receipts for Group Messages API is a Chat RESTful API designed for Pro, Pro Plus, and Enterprise editions to retrieve read and unread counts for messages in private, public, and chat room groups. It supports batch requests with JSON format and allows up to 200 calls per second. This API is intended for app administrators to monitor message read statuses efficiently.
- [Sending Read Receipts for One-to-One Messages](https://pre.trtc.io/document/77776.md): The Sending Read Receipts for One-to-One Messages API is part of the Tencent RTC Chat SDK, enabling app administrators to programmatically send read receipts for C2C messages. This API is designed for administrators managing message status between two users by specifying sender and recipient user IDs and message keys. It supports region-specific endpoints and returns detailed status and error information to facilitate integration and troubleshooting.
- [Pulling the Message Extension of a One-to-One Message](https://pre.trtc.io/document/51194.md): The Chat API allows app admins and conversation members to retrieve the message extension of one-to-one messages, which consists of custom key-value pairs. This API supports specifying message identifiers and sequence numbers to pull message extensions efficiently. It requires authentication parameters such as sdkappid, identifier, and usersig, and supports up to 200 calls per second. The response provides detailed status, error codes, and the list of key-value pairs sorted by sequence, facilitating precise message data retrieval in chat applications.
- [Configuring Message Extension for a One-to-One Message](https://pre.trtc.io/document/51195.md): The Configuring Message Extension for One-to-One Messages guide explains how app admins and conversation members can set, delete, or clear custom key-value pairs for individual messages using the Chat API. This feature supports up to 300 key-value pairs per message and requires specific editions and console settings. The guide details API request parameters, usage examples, and call frequency limits to help users effectively manage message extensions in one-to-one communication scenarios.
- [Pulling Message Extension of a Group Message](https://pre.trtc.io/document/52169.md): Tencent Cloud Chat API provides an interface to pull message extensions, which are custom key-value pairs attached to group messages. This API is designed for app administrators and group members to retrieve extensions for Private, Public, and ChatRoom group types. It supports JSON requests, requires the Pro or higher edition, and offers up to 200 calls per second, enabling efficient management of message metadata in chat applications.
- [Configuring Message Extension for a Group Message](https://pre.trtc.io/document/52170.md): The Configuring Message Extension for Group Messages API enables app admins and group members to set custom key-value pairs for group messages in Tencent RTC Chat. This API supports private, public, and ChatRoom group types, allowing operations such as setting, deleting, or clearing extensions for specific message sequences. It requires the Enterprise edition and proper feature activation in the Chat console. The API supports up to 300 key-value pairs per group message and allows up to 200 calls per second.
- [API for Pushing to All Users](https://pre.trtc.io/document/37165.md): Push to All Users API is a RESTful messaging service within the Chat SDK that enables applications to push messages to all users, by user tag, or by user attribute. It supports online and offline push notifications on Android and iOS, offline message retention for up to 7 days, and customizable message delivery. This API is designed for applications requiring efficient group messaging to enhance user engagement and operational goals, available to Pro and Enterprise account holders after approval.
- [Pushing to All/Tagged Users](https://pre.trtc.io/document/67814.md): The All-user/Tag Push API is a messaging SDK feature that enables sending targeted push notifications to all users or specific user groups based on tags and attributes. It supports personalized content delivery, push delivery reports, and troubleshooting tools. This API is designed for app administrators to efficiently manage user acquisition, activation, and engagement by sending messages via HTTPS POST requests with defined parameters. It includes controls for message roaming, offline push settings, and sender identity customization, with regional endpoints for global deployment and a default call frequency limit of 100 times per day.
- [Obtaining Application Attribute Names](https://pre.trtc.io/document/67815.md): The Get Application Attribute Names API is part of the Tencent RTC Instant Messaging SDK, enabling administrators to retrieve attribute names configured for their application. This API requires administrator credentials and supports HTTPS POST requests with parameters such as usersig, identifier, sdkappid, and random. It returns attribute names and their corresponding account types, facilitating management of user attributes within the application. The API enforces a call frequency limit of 100 requests per second and provides detailed error codes for troubleshooting.
- [Setting Application Attribute Names](https://pre.trtc.io/document/67816.md): The Set Application Attribute Names API allows applications to define up to 10 custom User Attributes for push notifications. This API supports HTTPS POST requests with parameters including usersig, identifier, sdkappid, and random. It enforces a call frequency limit of 100 requests per second and returns structured response packets indicating success or error details. Developers can use the RESTful API Online Test tool for debugging and refer to detailed error codes for troubleshooting.
- [Obtaining User Attributes](https://pre.trtc.io/document/67817.md): The Get User Attributes API is part of Tencent RTC's Instant Messaging SDK, enabling administrators to retrieve attribute information for up to 100 users simultaneously. This API requires an admin account and supports HTTPS POST requests with region-specific endpoints. It provides detailed user attribute data and error handling to facilitate user management and customization within applications.
- [Setting User Attributes](https://pre.trtc.io/document/67818.md): The Set User Attributes API in Tencent RTC Instant Messaging SDK allows administrators to assign custom attributes to up to 100 users per request. This API supports HTTPS POST requests with required parameters such as usersig, identifier, sdkappid, and random. It enables management of user-specific key-value attributes, with a call frequency limit of 100 requests per second. The API returns detailed response information including success status and error codes for troubleshooting. Regional domain endpoints are provided to optimize request routing based on the SDKAppID location.
- [Deleting User Attributes](https://pre.trtc.io/document/67819.md): The Deleting User Attributes API allows administrators to remove specific attributes from up to 100 user accounts at a time. This API is part of the Tencent RTC Instant Messaging SDK and requires prior configuration of application attribute names. It supports HTTPS POST requests with authentication parameters and provides detailed response codes for success, partial success, and errors to help manage user attribute data effectively.
- [Obtaining User Tags](https://pre.trtc.io/document/67820.md): The Get User Tags API is part of the Tencent RTC Instant Messaging SDK that enables administrators to retrieve tags associated with up to 100 users per request. This API requires admin account permissions and uses HTTPS POST requests with parameters such as usersig, identifier, sdkappid, and random. It supports multiple regional domains and returns detailed user tag information along with error codes for handling failures. The call frequency limit is 100 requests per second, ensuring efficient tag management for applications.
- [Adding User Tags](https://pre.trtc.io/document/67821.md): The Adding User Tags API allows administrators to manage user tags within an application by adding or overwriting tags for up to 100 users per request. This API supports HTTPS POST requests with parameters such as usersig, identifier, and sdkappid, enabling efficient tag management with a limit of 10 tags per user per request and a maximum of 100 tags per user overall. It is designed for application administrators to organize user attributes and supports a call frequency of up to 100 times per second.
- [Deleting User Tags](https://pre.trtc.io/document/67822.md): The Delete User Tags API is part of the Tencent RTC Instant Messaging SDK, enabling administrators to remove tags from up to 100 users per request. This API uses HTTPS POST requests with JSON payloads and requires App Administrator permissions. It supports detailed response codes and error messages to facilitate precise error handling and debugging. The API enforces a call frequency limit of 100 requests per second and supports multiple regional endpoints.
- [Deleting All User Tags](https://pre.trtc.io/document/67823.md): The Deleting All User Tags API allows administrators to remove all tags from up to 100 users simultaneously. This API is part of the Tencent RTC Instant Messaging SDK and requires administrator permissions. It supports HTTPS POST requests with parameters such as usersig, identifier, sdkappid, and random. The API provides detailed response information including success status, error codes, and error messages to help manage user tags efficiently.
- [Pulling a conversation list](https://pre.trtc.io/document/43087.md): The Pulling a Conversation List API is part of the Tencent Cloud Chat API, enabling developers to retrieve paginated conversation lists for a specified user account. It supports filtering by conversation type, sorting order, and includes pinned and general conversations. This API is designed for app administrators to efficiently manage and query user conversations with a maximum call frequency of 200 requests per second.
- [Setting the Unread Message Count of a Member](https://pre.trtc.io/document/34909.md): The SetUnreadMsgNum API in Tencent Cloud Chat allows app administrators to set the unread message count for members of supported group types. This RESTful API uses HTTPS POST requests and requires authentication parameters such as SDKAppID and usersig. It supports private, public, and community groups but excludes ChatRoom and AVChatRoom types. The API does not trigger callbacks or notifications and enforces a maximum call frequency of 200 calls per second. Response packets provide detailed status and error information to facilitate integration and troubleshooting.
- [Querying Unread One-to-One Message Count](https://pre.trtc.io/document/41046.md): The Querying Unread One-to-One Message Count API is part of the Chat platform API suite. It enables app administrators to retrieve the unread message count for a specific one-to-one conversation or all one-to-one conversations of a user. This API supports querying multiple conversations simultaneously and returns detailed unread counts along with error codes for precise troubleshooting. It is designed for use by app admins to monitor message statuses efficiently with a maximum call frequency of 200 requests per second.
- [Pin a conversation](https://pre.trtc.io/document/78304.md): The Pin a Conversation API in Tencent Cloud Chat REST API enables administrators to pin or unpin one-to-one and group conversations. This API supports JSON requests and requires an App administrator's UserSig for authentication. It helps manage conversation order for users by marking important chats. The API endpoint varies by region and enforces a rate limit of 200 requests per second. Detailed error codes assist in troubleshooting.
- [Deleting a conversation](https://pre.trtc.io/document/43088.md): The Delete Conversation API is part of the Chat RESTful API suite, enabling app administrators to delete one-to-one or group conversations and optionally clear roaming messages. It requires authentication parameters such as sdkappid, user signature, and supports JSON request format. This API handles up to 200 calls per second and provides detailed response codes and error information to assist in integration and troubleshooting.
- [Creating Conversation Group Data](https://pre.trtc.io/document/53437.md): The Create Conversation Group API is part of the Tencent Cloud Chat RESTful API suite, enabling developers to create and manage conversation group data. It supports creating conversation groups with initial conversation lists, handling one-to-one and group conversations. The API requires authentication parameters and supports JSON format requests with a call frequency limit of 200 per second. This API is intended for app administrators managing chat groups within Pro, Pro Plus, or Enterprise editions, providing detailed response data including operation results and error codes for effective group management.
- [Updating Conversation Group Data](https://pre.trtc.io/document/53439.md): The Update Conversation Group Data API is part of the Tencent Cloud Chat RESTful API suite, enabling developers to modify conversation group names and manage conversations within groups. It supports operations such as adding or removing conversations from groups and updating group names. This API is designed for app administrators managing chat sessions with limits on group creation and session membership. It requires enabling Pro, Pro Plus, or Enterprise editions and enforces call frequency and session caps to ensure service stability.
- [Deleting Conversation Group Data](https://pre.trtc.io/document/53441.md): The Deleting Conversation Group Data API in the Chat SDK allows app administrators to remove specific conversation groups for users. It supports JSON requests to delete one conversation group at a time per user, with a maximum of 20 groups per user and session limits enforced. This API requires Pro Edition or higher and includes detailed error codes for troubleshooting. The API supports up to 200 calls per second and operates independently from recent contacts management.
- [Creating or Updating Conversation Mark Data](https://pre.trtc.io/document/53438.md): The Conversation Mark Data API is part of the Tencent RTC Chat SDK, enabling developers to create or update both standard and custom conversation marks. It supports managing conversation groups and marks for one-to-one and group conversations, with limits on the number of groups and sessions per user. This API requires Pro, Pro Plus, or Enterprise editions and allows up to 200 calls per second. It provides detailed parameters for setting or clearing marks and supports JSON request and response formats.
- [Searching for Conversation Group Marks](https://pre.trtc.io/document/53442.md): The Search Conversation Group Marks API is part of the Chat platform and allows querying conversation group mark data for specified conversations. It supports both one-to-one and group conversations and enables retrieving standard and custom marks along with group membership information. This API requires Pro Edition or higher and enforces limits on the number of groups and sessions per user. It supports up to 200 calls per second and requires authentication parameters including sdkappid and usersig. The response provides detailed mark data and group info for effective conversation management.
- [Pulling Conversation Group Mark Data](https://pre.trtc.io/document/53440.md): The Pulling Conversation Group Mark Data API is a RESTful interface provided by Tencent RTC for batch retrieving users' conversation group and mark data. It supports operations on conversation grouping and marking, including standard and custom marks, and requires Pro Edition or higher. The API allows querying conversation groups and marks with pagination and returns detailed conversation and group information. It is designed for developers managing chat session metadata with a maximum call frequency of 200 requests per second.
- [Getting All Groups in an App](https://pre.trtc.io/document/34960.md): The Get All Groups API in Tencent Cloud Chat allows app administrators to retrieve the IDs of all groups within an app. It supports filtering by group types such as Public, Private, ChatRoom, AVChatRoom, BChatRoom, and Community, and provides pagination controls through Limit and Next parameters to efficiently handle large group lists. This API is essential for managing group data and supports a maximum call frequency of one request per second.
- [Creating a Group](https://pre.trtc.io/document/34895.md): The Create Group API is part of the Chat group management API that allows app administrators to create different types of groups including Private, Public, ChatRoom, AVChatRoom, and Community. It supports specifying group owners and members except for AVChatRoom groups, which require users to join via SDK requests. The API requires parameters such as sdkappid, admin identifier, user signature, and supports a maximum call frequency of 200 calls per second. This API helps manage group creation with options for group introduction, notification, profile photo, and membership limits.
- [Disbanding a Group](https://pre.trtc.io/document/34896.md): The Disbanding a Group API in the Chat SDK allows app administrators to permanently disband groups across various group types including Private, Public, ChatRoom, AVChatRoom, and Community. This API supports RESTful calls with region-specific endpoints and requires authentication parameters such as sdkappid, identifier, and usersig. It enables administrators to manage group lifecycle by irrevocably deleting groups, with a maximum call frequency of 200 calls per second. The API response provides detailed status and error codes to facilitate integration and troubleshooting.
- [Getting the Groups a User Has Joined](https://pre.trtc.io/document/34925.md): The Get Joined Groups API is part of the Chat SDK that allows app administrators to retrieve the list of groups a specified user has joined. It supports filtering by group types such as Private, Public, and ChatRoom, as well as pagination controls using Limit and Offset parameters. This API excludes inactive work groups by default and requires authentication parameters including sdkappid, identifier, and usersig. It is designed for app admins to efficiently manage and query user group memberships with a maximum call frequency of 200 requests per second.
- [Getting Group Profiles](https://pre.trtc.io/document/34961.md): The Get Group Profiles API is a RESTful interface provided by Tencent Cloud Chat for app administrators to retrieve detailed information about groups by their IDs. It supports various group types including Private, Public, ChatRoom, AVChatRoom, and Community. The API allows querying up to 50 groups per request with a maximum call frequency of 200 calls per second. Administrators can specify filters to selectively pull basic group info, member info, and custom-defined fields. This API is essential for managing group data efficiently in chat applications.
- [Modifying the Profile of a Group](https://pre.trtc.io/document/34962.md): The ModifyGroupBaseInfo API is part of the Chat SDK that enables app administrators to update the profile information of various group types such as Private, Public, ChatRoom, AVChatRoom, and Community. It supports modifying core group attributes including name, introduction, notification, profile photo URL, maximum member count, join permissions, mute settings, and custom-defined fields. This API uses RESTful HTTP requests with JSON format and allows up to 200 calls per second, facilitating efficient group profile management in real-time communication applications.
- [Importing a Group Profile](https://pre.trtc.io/document/34967.md): The Import Group Profile API is a RESTful service within the Tencent Cloud Chat SDK that enables app administrators to import existing group data from other instant messaging systems without triggering callbacks or notifications. It supports multiple group types including Private, Public, ChatRoom, and Community, while excluding AVChatRoom groups. This API facilitates seamless migration and group data management by allowing detailed customization of group attributes such as owner, name, creation time, and custom fields. The API requires authentication parameters and supports up to 200 calls per second, making it suitable for efficient bulk data import scenarios.
- [Adding Group Members](https://pre.trtc.io/document/34921.md): The Add Group Members API in Tencent Cloud Chat SDK enables app administrators to add multiple users to various group types such as private, public, chat rooms, and communities. It supports batch addition of up to 100 members per request and offers a silent mode to add members without sending notifications. This RESTful API requires authentication parameters like sdkappid and usersig, and enforces a maximum call frequency of 200 calls per second. It does not support audio-video groups, returning error 10007 if used on such groups.
- [Deleting Group Members](https://pre.trtc.io/document/34949.md): The Delete Group Members API in the Chat SDK allows app administrators to remove members from various group types such as Private, Public, ChatRoom, and Community groups. It supports batch deletion of up to 100 members per request with options for silent deletion and specifying reasons for removal. This API does not support audio-video groups and handles requests with a maximum frequency of 200 calls per second, providing detailed response codes and error handling for effective group management.
- [Banning Group Members](https://pre.trtc.io/document/50296.md): The Ban Group Members API is part of the Tencent RTC Chat SDK, enabling administrators to ban members from groups. This API supports various group types including Private, Public, ChatRoom, AVChatRoom, and Community. It allows banning up to 20 members per request for a specified duration, preventing them from receiving messages or rejoining the audio-video group during the ban period. The API requires parameters such as GroupId, Members_Account, Duration, and optionally Description. It returns detailed response fields including status and error codes to help diagnose issues like invalid parameters or insufficient permissions.
- [Unbanning Group Members](https://pre.trtc.io/document/50297.md): The Unbanning Group Members API in the Chat SDK allows app administrators to remove bans on members within audio-video groups, enabling them to rejoin and receive messages. This API supports various group types such as Private, Public, ChatRoom, AVChatRoom, and Community. It requires SDK Enhanced edition v6.6 or later, web SDK v2.22.0 or later, and appropriate edition purchase with feature configuration in the console. The API supports up to 20 members per request and a maximum call frequency of 200 calls per second, providing detailed response fields and error codes for effective integration and troubleshooting.
- [Bulk Muting and Unmuting](https://pre.trtc.io/document/34951.md): The Bulk Muting and Unmuting API enables app administrators to mute or unmute multiple group members for a specified duration within Tencent RTC Chat groups. It supports various group types such as Public, ChatRoom, AVChatRoom, and Community, allowing control over member messaging permissions. This API accepts parameters including GroupId, Members_Account, and MuteTime, and returns detailed JSON responses with action status and error codes. The API supports up to 200 calls per second and ensures muted members remain muted upon rejoining groups.
- [Getting the List of Muted Group Members](https://pre.trtc.io/document/34964.md): The Get Muted Group Members List API is part of the Chat RESTful API that enables app administrators to retrieve muted users within a specified group by group ID. It supports various group types such as Private, Public, ChatRoom, AVChatRoom, and Community. The API requires authentication parameters including sdkappid, identifier, and usersig, and returns detailed muted member information including user IDs and mute expiration times in UTC. This API is designed for developers managing group mute settings and supports up to 200 calls per second for efficient querying.
- [Changing Group Owner](https://pre.trtc.io/document/34966.md): The Change Group Owner API is part of the Tencent Cloud Chat API suite, enabling app administrators to transfer the ownership of a group to another member. This API supports various group types including Private, Public, ChatRoom, and Community groups, except AVChatRoom. It requires specifying the group ID and the new owner's account ID, with optional operator designation. The API facilitates management of group roles by ensuring the previous owner reverts to their prior role after transfer. This reference details request parameters, response fields, error codes, and usage examples for effective integration.
- [Querying the Roles of Users in a Group](https://pre.trtc.io/document/34963.md): The Get User Roles in Group API is a RESTful interface provided by Tencent RTC Chat SDK that enables app administrators to batch query the roles of users within various group types such as Private, Public, ChatRoom, and Community. This API supports up to 500 user accounts per request and returns detailed role information including Owner, Admin, Member, and NotMember. It is designed for app admins to manage group user roles efficiently and supports a maximum call frequency of 200 requests per second. Audio-video groups are not supported by this API.
- [Importing Group Members](https://pre.trtc.io/document/34969.md): The Importing Group Members API of Tencent Cloud Chat SDK enables developers to import existing group members into private, public, chatroom, and community groups without triggering callbacks or notifications. This API is intended for applications migrating from other instant messaging systems and supports importing up to 20 members per call with detailed parameters such as member roles and join times. It excludes audio-video groups and enforces a maximum call frequency of 200 requests per second.
- [Getting Group Member Profiles](https://pre.trtc.io/document/34948.md): The Get Group Member Profiles API is part of the Chat platform API suite, enabling app administrators to retrieve detailed profiles of group members by specifying the group ID. It supports multiple group types including Private, Public, ChatRoom, and Community, with pagination and batch retrieval methods to efficiently handle large member lists. This API requires authentication parameters such as sdkappid and usersig, and allows up to 200 calls per second, making it suitable for managing group member information in real-time chat applications.
- [Modifying the Profile of a Group Member](https://pre.trtc.io/document/34900.md): The Modify Group Member Profile API is part of the Chat SDK that enables app administrators to update various attributes of group members across supported group types such as Private, Public, ChatRoom, and Community groups. This API facilitates administrative tasks including assigning admin roles, configuring message blocking preferences, updating group name cards, managing custom member fields, and setting muting periods. It is designed for app admins who need to manage group member profiles efficiently via RESTful JSON requests with a high call frequency limit.
- [Getting Specified Group Member Profiles](https://pre.trtc.io/document/64897.md): The GetSpecifiedGroupMemberInfo API is a RESTful interface in the Chat platform that enables app administrators to retrieve detailed profiles of specified group members by providing the group ID and a list of user IDs. It supports various group types such as Private, Public, ChatRoom, and Community, and allows filtering of member information by specific fields, roles, or custom data. This API is designed for efficient management of group member data with a maximum call frequency of 200 requests per second.
- [Getting Group Custom Attributes](https://pre.trtc.io/document/44187.md): The Get Group Custom Attributes API is part of the Chat platform SDK that allows app administrators to retrieve custom attributes for various group types such as Private, Public, ChatRoom, AVChatRoom, and Community. It supports RESTful calls with parameters including sdkappid, admin identifier, usersig, and group ID. The API handles up to 200 calls per second and returns detailed status and attribute information, enabling efficient management of group metadata. Error codes provide guidance for troubleshooting permission, parameter, and group existence issues.
- [Modifying Group Custom Attributes](https://pre.trtc.io/document/44188.md): The Modify Group Custom Attributes API allows app administrators to update custom attributes for various group types such as Private, Public, ChatRoom, AVChatRoom, and Community within the Chat platform. This API supports JSON requests with parameters including group ID and custom attribute key-value pairs, enforcing limits on attribute size and frequency of calls. It provides detailed response fields and error codes to facilitate effective group attribute management and supports callbacks upon attribute changes.
- [Clearing Group Custom Attributes](https://pre.trtc.io/document/44189.md): The Clear Group Custom Attributes API is part of the Tencent Cloud Chat RESTful API suite, enabling app administrators to remove custom attributes from specified groups. It supports various group types such as Private, Public, ChatRoom, and AVChatRoom, with region-specific endpoints. The API handles requests in JSON format, enforces rate limits up to 200 calls per second, and provides comprehensive error codes and callback support to ensure effective group attribute management.
- [Resetting Group Custom Attributes](https://pre.trtc.io/document/44190.md): The Resetting Group Custom Attributes API in the Chat SDK allows app administrators to reset custom attributes for various group types such as Private, Public, ChatRoom, AVChatRoom, and Community. This RESTful API supports JSON requests and enforces limits on attribute key count, key size, and value size. It provides detailed error codes and responses to help developers manage group attributes effectively.
- [Deleting Group Custom Attributes](https://pre.trtc.io/document/59499.md): The Delete Group Custom Attributes API is a RESTful interface provided by Tencent RTC that enables app administrators to remove custom attributes from various group types such as Private, Public, ChatRoom, AVChatRoom, and Community. This API supports up to 200 calls per second and requires parameters including sdkappid, admin identifier, and user signature. It returns detailed response fields and error codes to help developers manage group attribute deletions efficiently.
- [Setting Live Streaming Group Robots](https://pre.trtc.io/document/60527.md): The Setting Live Streaming Group Robots API is part of the Chat platform SDK that allows app administrators and group owners to add robot accounts to the online member list of live streaming groups. This API is designed for the AVChatRoom group type and requires Pro, Pro Plus, or Enterprise package editions with the live streaming group feature enabled. It sets a special tag for robot accounts, enabling them to appear fixed in the member list regardless of their online status. The API supports JSON requests and requires admin authentication via usersig. It provides key parameters such as GroupId and Member_Account to specify the target group and robot accounts to add. The API returns detailed response codes and messages to indicate success or failure.
- [Deleting Live Streaming Group Robots](https://pre.trtc.io/document/60526.md): The Deleting Live Streaming Group Robots API allows app administrators and group owners to remove robot accounts from the live streaming group's online member list by deleting the special tag (500). This API is available for the Pro, Pro Plus, or Enterprise editions with the live streaming group online member list feature enabled in the Chat console. It supports the AVChatRoom group type and enforces a maximum call frequency of 200 requests per second. The API requires parameters such as GroupId and Member_Account and returns detailed response and error codes for effective integration.
- [Setting/Deleting Live Streaming Group Administrators](https://pre.trtc.io/document/60525.md): The Live Streaming Group Administrator Management API allows app administrators to set or delete administrators for live streaming groups within Tencent RTC. This API supports AVChatRoom group types and requires the Pro, Pro Plus, or Enterprise edition with the live streaming group online member list feature enabled. It enables managing up to five administrators per group, who can retain their status even if they leave and rejoin the group. The API provides parameters for specifying group ID, administrator accounts, and operation type, facilitating effective group administration.
- [Obtaining the List of Live Streaming Group Administrators](https://pre.trtc.io/document/60524.md): The Get Live Streaming Group Administrators List API is part of the Chat platform API, enabling app administrators to retrieve the list of administrators for a live streaming group by specifying the group ID. This API supports AVChatRoom group types and is available to Pro, Pro Plus, and Enterprise edition users with the live streaming group online member list feature enabled. Key parameters include sdkappid, admin identifier, usersig, and request format. The API supports up to 200 calls per second and returns detailed administrator information along with status and error codes to facilitate integration and error handling.
- [Checking Whether Users Are in a Live Streaming Group](https://pre.trtc.io/document/60523.md): The Check Live Streaming Group Membership API in Tencent Cloud Chat SDK allows app administrators to verify if multiple users belong to a specified live streaming group by group ID. This API supports AVChatRoom group types and requires the Pro, Pro Plus, or Enterprise edition with the live streaming group online member list feature enabled. It provides user membership status with a maximum call frequency of 200 requests per second, facilitating efficient group management and monitoring.
- [Getting the Number of Online Users in an Audio-Video Group](https://pre.trtc.io/document/38521.md): The Get Online User Count API is part of the Tencent RTC live stream group management SDK. It enables app administrators to retrieve the current number of online users in various group types such as Private, Public, ChatRoom, AVChatRoom, and Community groups. The API supports HTTPS POST requests with parameters including sdkappid, identifier, usersig, and group ID, and updates the online user count every 10 seconds. This API is designed for applications requiring real-time group user statistics and supports a maximum call frequency of 200 times per second. Detailed error codes and response fields are provided to facilitate integration and troubleshooting.
- [Getting the List of Online Members in Audio-Video Group](https://pre.trtc.io/document/50293.md): The Get Online Members List API is part of the Chat SDK that allows retrieving the current online members in an audio-video group by group ID. It supports AVChatRoom and Community group types and requires Pro, Pro Plus, or Enterprise editions with the feature enabled. The API returns up to 1,000 latest online members from a cache updated every 40 seconds. Key parameters include sdkappid, identifier, usersig, and group ID, with a maximum call frequency of 200 requests per second.
- [Setting Audio-Video Group Member Marks](https://pre.trtc.io/document/50294.md): The Setting Audio-Video Group Member Marks API in Tencent RTC allows app admins and group owners to assign and manage distinct marks for members of audio-video groups. This API supports marking online members to differentiate roles or types within the group, requiring Pro, Pro Plus, or Enterprise editions with the online member list feature enabled. It provides parameters for specifying group ID, command type for setting or deleting marks, and member lists, enabling efficient management of up to 10 marks per group and 1,000 members per mark.
- [Getting the List of Banned Group Members.](https://pre.trtc.io/document/50295.md): The Get Banned Group Members API is part of Tencent RTC's audio-video group management SDK. It allows app administrators to retrieve paginated lists of banned members within various group types such as Private, Public, ChatRoom, AVChatRoom, and Community. This API requires the Pro, Pro Plus, or Enterprise edition and is supported by SDK Enhanced edition v6.6+ and web SDK v2.22.0+. Key parameters include GroupId, Limit, and Offset for controlling the data returned. The API supports up to 200 calls per second and returns detailed response fields including banned member accounts and ban expiration times.
- [Creating Topic](https://pre.trtc.io/document/49471.md): The Create Topic API is part of the Chat SDK that allows app administrators to create topics within topic-enabled community groups. This API supports customization of topic IDs and requires prior configuration of the community and topic features in the Tencent Cloud console. It facilitates topic management by providing parameters such as GroupId, TopicName, and optional fields like From_Account and Notification, enabling efficient group communication organization.
- [Deleting Topic](https://pre.trtc.io/document/49470.md): The DestroyTopic API is a RESTful interface for deleting topics within topic-enabled communities in Tencent Cloud Chat. It is designed for app administrators to manage community topics by specifying group IDs and topic ID lists. The API supports up to 200 calls per second and provides detailed response information including success status and error codes. This reference details the request parameters, response structure, error codes, and usage constraints for efficient topic management.
- [Getting Topic Profile](https://pre.trtc.io/document/49469.md): The Get Topic Profile API is a RESTful interface designed for retrieving detailed information about topics within topic-enabled communities in Tencent Chat. It is intended for developers managing community groups who need to access topic profiles by specifying group IDs and optional topic lists. The API supports filtering response fields and enforces a maximum call frequency of 200 calls per second, providing flexible and efficient access to topic data.
- [Modifying Topic Profile](https://pre.trtc.io/document/49468.md): The ModifyTopicProfile API in Tencent Chat allows developers to update topic profiles within topic-enabled communities. It supports modifying attributes such as topic name, notification, introduction, profile photo URL, mute settings, and custom strings. This RESTful API is intended for use by app administrators managing community groups with the topic feature enabled via Tencent Cloud console. The API accepts parameters including GroupId, TopicId, and From_Account, with a maximum call frequency of 200 requests per second.
- [Importing Topic Profiles](https://pre.trtc.io/document/53448.md): The Importing Topic Profiles API is a RESTful interface in Tencent RTC Chat that enables app administrators to import topic data into topic-enabled communities without triggering callbacks or notifications. This API is designed for apps migrating from other instant messaging systems and supports specifying group IDs, topic names, creation times, and optional topic details. It provides a controlled method to manage topic data with a call frequency limit of 200 calls per second.
- [Creating Permission Groups](https://pre.trtc.io/document/61232.md): The Creating Permission Groups API in the Chat SDK enables app administrators to create new permission groups for managing user permissions within community groups. This API supports specifying group IDs, permission group names, permission bits, and custom fields. It is designed for app admins to efficiently manage permissions via RESTful calls with a maximum frequency of 200 requests per second. The API response provides detailed status and error information along with the assigned permission group ID.
- [Terminating Permission Groups](https://pre.trtc.io/document/61233.md): The DestroyPermissionGroup API is a Chat permission group management API that allows app administrators to terminate existing permission groups within Community type groups. It supports JSON request and response formats and enforces a maximum calling frequency of 200 queries per second. The API requires app admin credentials and region-specific endpoints based on SDKAppID. Detailed request parameters, response fields, and error codes are provided to facilitate integration and troubleshooting.
- [Modifying Permission Group Information](https://pre.trtc.io/document/61234.md): The Modify Permission Group Information API in Tencent RTC Chat enables app administrators to update details of permission groups specifically for Community group types. This RESTful API requires authentication parameters and supports JSON request format. It facilitates management of group permissions, names, and custom fields, with a maximum call rate of 200 requests per second. The API returns detailed response codes and error messages to assist in troubleshooting and integration.
- [Obtaining Permission Group Information](https://pre.trtc.io/document/61235.md): The GetPermissionGroup API is part of the Chat SDK that enables app administrators to retrieve detailed information about permission groups, specifically supporting the Community group type. This API requires authentication parameters such as sdkappid, identifier, and usersig, and supports pagination with parameters like Limit and Next. It is designed for app admins to efficiently query permission group details with a maximum frequency of 200 calls per second.
- [Adding Topic Permissions](https://pre.trtc.io/document/61236.md): The Add Topic Permissions API is part of the Chat SDK and enables app administrators to assign topic permissions to permission groups within the Community group type. This API is intended for app admins who need to manage granular permissions for topics in chat groups. It supports JSON request format and includes parameters such as GroupId, PermissionGroupId, and a list of topic permissions. The API handles up to 200 calls per second and provides detailed response codes to indicate success or specific errors.
- [Modifying Topic Permissions](https://pre.trtc.io/document/61237.md): The Modifying Topic Permissions API in the Chat SDK allows app administrators to update topic permissions within a permission group, specifically supporting the Community group type. This API requires admin credentials and supports region-specific endpoints. It handles requests with parameters such as GroupId, PermissionGroupId, and TopicPermissionList, enabling precise permission management. The response provides detailed status and error information to facilitate integration and troubleshooting.
- [Deleting Topic Permissions](https://pre.trtc.io/document/61238.md): The Delete Topic Permissions API in the Chat SDK enables app administrators to remove topic permissions from a specified permission group within a community group. This API is designed for app admins who need to manage group permissions programmatically by specifying the group ID, permission group ID, and the list of topic IDs to be deleted. It supports a maximum of 50 topics per request and allows up to 200 calls per second. The API returns detailed response codes and error messages to facilitate troubleshooting and integration.
- [Obtaining Topic Permissions](https://pre.trtc.io/document/61239.md): The GetTopicPermissionGroup API is a RESTful interface provided by Tencent RTC Chat service that enables app administrators to retrieve topic permissions within a specified permission group. This API supports the Community group type and requires authentication via app admin credentials. It facilitates management of topic-level permissions by returning detailed permission data for all or specified topics within a group. The API supports regional endpoints, enforces a maximum call rate of 200 queries per second, and returns structured response data including status and error codes.
- [Adding Members to a Permission Group](https://pre.trtc.io/document/61240.md): The Add Members to Permission Group API is part of the Tencent RTC Chat SDK, enabling app admins to add new members to specified permission groups within Community group types. This API supports batch addition of up to 100 members per request using JSON format. It requires parameters such as GroupId, PermissionGroupId, and MemberList, and returns detailed results including success status and error codes for each member. The API supports a maximum calling frequency of 200 queries per second, facilitating efficient permission group management.
- [Deleting Permission Group Members](https://pre.trtc.io/document/61241.md): The Deleting Permission Group Members API in the Chat SDK allows app administrators to remove members from permission groups within Community group types. This API supports batch deletion of up to 100 members per request and requires specific parameters including group and permission group IDs, member account details, and authentication credentials. It provides detailed response results for each deletion operation, including success status and error codes, enabling efficient permission group management.
- [Obtaining Permission Group Member List](https://pre.trtc.io/document/61242.md): The Obtaining Permission Group Member List API is a Chat SDK RESTful interface that enables app admins to retrieve detailed information about members of a permission group by specifying the group ID and permission group ID. This API supports Community group types and includes features such as batch retrieval with pagination and field filtering. It is designed for app administrators to manage group member permissions efficiently with a maximum calling frequency of 200 queries per second.
- [Getting the List of Online Members in Community Group](https://pre.trtc.io/document/66883.md): The Get Online Member Count API is a Chat SDK interface that enables app administrators to query the number of online users in a Community group by specifying the Group ID. It supports only Community group types and updates online member counts every 4 minutes to accommodate large group sizes. The API requires authentication parameters including sdkappid, admin identifier, and usersig, and supports up to 200 requests per second. The response provides detailed status and error codes to help diagnose issues during API calls.
- [Getting Group Counters](https://pre.trtc.io/document/53427.md): The Get Group Counters API is a Chat platform RESTful API that enables app administrators to retrieve counters for various group types such as Private, Public, ChatRoom, and AVChatRoom. This API requires the Pro, Pro Plus, or Enterprise edition and supports JSON request format with a maximum call frequency of 200 calls per second. It returns detailed group counter key-value pairs along with status and error information to help manage group data effectively.
- [Updating Group Counters](https://pre.trtc.io/document/53428.md): The Update Group Counters API is part of the Tencent Cloud Chat SDK, enabling app administrators to set, increase, or decrease counters for various group types including private, public, chat rooms, and AV chat rooms. This API supports RESTful calls with JSON format and requires Pro, Pro Plus, or Enterprise editions. It helps manage group statistics efficiently with a maximum call frequency of 200 calls per second and provides comprehensive error handling and response details.
- [Deleting Group Counters](https://pre.trtc.io/document/53429.md): The Deleting Group Counters API in Tencent Cloud Chat SDK enables app administrators to remove specific or all counters from groups such as private, public, chatroom, and AVChatRoom types. This API requires a Pro, Pro Plus, or Enterprise edition license and supports region-specific endpoints. It accepts parameters including sdkappid, admin identifier, user signature, and group ID, with a maximum call frequency of 200 requests per second. The response provides detailed status and error codes to facilitate effective error handling.
- [Importing a Single Account](https://pre.trtc.io/document/34953.md): The Account Import API is a RESTful API in the Chat service that allows importing an app-owned account and creating an internal ID to enable the account to use Chat. It is designed for app administrators to manage user accounts by providing parameters like sdkappid, identifier, usersig, and supports up to 200 calls per second. The API returns detailed response fields and error codes to facilitate integration and troubleshooting.
- [Importing Multiple Accounts](https://pre.trtc.io/document/34954.md): The Multi-Account Import API of the Chat SDK allows batch importing of up to 100 app-owned user accounts, creating internal IDs to enable Chat services. This API supports updating existing accounts with new user information such as nickname and avatar URL. It accepts JSON-formatted requests and provides detailed response structures including error codes for effective integration and troubleshooting. The API supports multiple regional endpoints and enforces a maximum call frequency of 100 requests per second.
- [Deleting Accounts](https://pre.trtc.io/document/34955.md): The Chat Account Deletion API is part of the Chat SDK, enabling developers to programmatically delete user accounts and their associated data such as contacts, profiles, groups, and sessions. This API supports batch deletion of up to 100 accounts per request with a maximum call frequency of 100 calls per second. It is applicable to Chat trial editions by default and must be enabled for other editions like TRTC and Enterprise via the console. The API requires HTTPS POST requests with parameters including sdkappid, admin identifier, user signature, and content type. Detailed response information and error codes help developers handle deletion results effectively.
- [Querying Accounts](https://pre.trtc.io/document/34956.md): The Account Query API in the Chat SDK allows developers to check if app-owned accounts have been imported, supporting batch queries of up to 100 accounts per request. It is designed for app administrators to verify account import status efficiently with a call frequency limit of 100 requests per second. The API provides detailed response information including action status, error codes, and account import states to facilitate integration and debugging.
- [Setting Profiles](https://pre.trtc.io/document/34916.md): The Profile Setting API of Tencent Cloud Chat SDK enables developers to set both standard and custom profile fields for users. It supports JSON formatted requests with parameters including sdkappid, identifier, usersig, and others, and allows up to 200 calls per second. The API returns detailed response fields and specific error codes to facilitate integration and troubleshooting across multiple regional endpoints.
- [Pulling Profiles](https://pre.trtc.io/document/34917.md): The Pulling Profiles API is a Chat service API under Tencent RTC that enables developers to retrieve standard and custom profile fields of friends and other users. It supports batch requests for up to 100 users per call to ensure efficient data retrieval and avoid response failures. Key parameters include sdkappid, identifier, usersig, and contenttype, with a maximum call frequency of 200 calls per second. This API is essential for applications requiring user profile information management.
- [Invalidating Account Login States](https://pre.trtc.io/document/34957.md): The Invalidate Account Login State API is part of the Chat platform SDK, designed to invalidate the login status of a specific app account by expiring all previous UserSig tokens. Intended for app administrators, this API helps manage account security by preventing malicious users from logging in with old credentials. It supports HTTPS POST requests to regional endpoints, requires admin credentials, and returns detailed JSON responses including error codes. The API allows one account invalidation per call and supports up to 200 calls per second.
- [Querying Account Online Status](https://pre.trtc.io/document/35477.md): The Querying Account Online Status API is a RESTful API provided by the Chat platform to retrieve the current login status of specified user accounts. It supports batch queries for up to 500 users per request and returns detailed login states including Online, Offline, and PushOnline. The API requires HTTPS POST requests with parameters such as sdkappid, app admin identifier, usersig, and a random number. It is designed for developers managing user presence and session status in real-time communication scenarios, supporting up to 200 calls per second with region-specific endpoints.
- [Adding Friends](https://pre.trtc.io/document/34902.md): The Friend Add API in Tencent Cloud Chat SDK allows adding one or multiple users to a friend list with support for batch operations and detailed friend attributes. It is designed for app administrators to manage user friendships efficiently by specifying parameters such as From_Account, AddFriendItem, and optional remarks or group names. The API supports JSON format requests and provides comprehensive response codes and error handling for integration and debugging.
- [Importing Friends](https://pre.trtc.io/document/34903.md): The Friend Import API is part of the Tencent RTC Chat SDK, designed to enable batch importing of one-way friends efficiently. It is intended for app administrators to manage friend lists by sending JSON-formatted requests with up to 1000 friends per call, supporting a maximum of 200 calls per second. This API helps avoid write conflicts by recommending batch imports for the same user and provides detailed response data including friend remarks, groups, and custom friend fields.
- [Updating Friends](https://pre.trtc.io/document/34904.md): The friend_update API is part of the Tencent RTC Chat SDK that enables batch updating of contacts data for multiple friends of a user. It is designed for app administrators to efficiently modify remarks, group memberships, and custom fields of friends in a single request, reducing write conflicts caused by concurrent updates. The API supports JSON formatted requests with a maximum frequency of 200 calls per second and allows updating up to 1000 friends per call.
- [Deleting Friends](https://pre.trtc.io/document/34905.md): The Friend Deletion API is part of the Tencent Cloud Chat SDK, enabling developers to remove friends through one-way or two-way deletion modes. This API is designed for app administrators to manage friend lists efficiently by sending requests with required parameters such as sdkappid, identifier, and usersig. It supports up to 200 calls per second and provides detailed response fields including result codes and error descriptions to handle various scenarios such as permission errors and network issues.
- [Deleting All Friends](https://pre.trtc.io/document/34906.md): The friend_delete_all API is a RESTful interface within the Tencent RTC Chat SDK that deletes both standard and custom friend data for a specified user. It supports one-way and two-way deletion modes and requires app admin authentication via UserSig. This API handles up to 200 calls per second and returns detailed status and error codes to assist developers in managing friend relationships efficiently.
- [Verifying Friends](https://pre.trtc.io/document/34907.md): The Bulk Friendship Verification API is a RESTful interface provided by Tencent RTC to check friendship status between users in bulk. It is designed for app administrators to verify relationships among multiple user accounts efficiently. The API accepts JSON requests with parameters including From_Account, To_Account, and CheckType, supporting up to 1000 user IDs per request and a maximum call frequency of 200 calls per second. Responses provide detailed friendship status, result codes, and error information to facilitate integration and troubleshooting.
- [Pulling Friends](https://pre.trtc.io/document/34908.md): The Pulling Friends API of Tencent Cloud Chat SDK allows developers to retrieve paginated friend data excluding profile information. Designed for app administrators, it supports fetching up to 500 friends per page including both standard and custom friend data. The API requires authentication parameters and returns detailed friend lists with sequence tracking for efficient incremental updates. It supports a maximum call frequency of 200 requests per second and provides comprehensive response fields to manage friend data synchronization.
- [Pulling Specified Friends](https://pre.trtc.io/document/34910.md): The Pulling Specified Friends API is part of the Chat SDK, enabling applications to retrieve data and profiles of specified friends by their UserIDs. It is designed for developers integrating friend management features, supporting batch requests of up to 100 friends to ensure response reliability. The API uses JSON format requests with parameters including sdkappid, identifier, usersig, and random, and returns detailed profile information along with error codes for effective debugging.
- [Adding Lists](https://pre.trtc.io/document/34950.md): The Add Friend List API in Tencent RTC Chat service allows developers to add friend lists in batches and assign specific friends to these lists. This RESTful API supports JSON requests and provides detailed response information including success status and error codes. It is designed for app administrators managing user friend groups, with a maximum call frequency of 200 calls per second and limits on group and friend counts per request.
- [Deleting Lists](https://pre.trtc.io/document/34926.md): The Deleting Friend Lists API is part of the Chat SDK, enabling app administrators to delete specified friend lists by sending JSON requests. It supports up to 32 groups per request and enforces a maximum call frequency of 200 calls per second. The API provides detailed response information including status and error codes to facilitate integration and debugging.
- [Pulling Lists](https://pre.trtc.io/document/40123.md): The Pulling Lists API is part of the Tencent Cloud Chat API suite, enabling applications to retrieve friend lists and their members. Designed for app administrators, this API supports specifying target friend groups and returns detailed information including group names, friend counts, and user IDs. It uses HTTPS POST requests with region-specific endpoints and enforces a maximum call frequency of 200 per second. The API also provides comprehensive error codes for effective debugging and integration.
- [Blocklisting Users](https://pre.trtc.io/document/34911.md): The Blocklisting Users API is part of the Tencent Cloud Chat SDK, enabling administrators to add one or multiple users to a blocklist to restrict interactions. This API supports batch blocking up to 1000 users per request and enforces mutual blocking rules that prevent friend requests and conversations between blocked users. It uses HTTPS POST requests with required parameters including sdkappid, administrator identifier, and user signature. The API returns detailed success or error codes for each user blocked, facilitating effective user management in chat applications.
- [Unblocklisting Users](https://pre.trtc.io/document/34912.md): The Unblocklisting Users API is part of the Tencent RTC Chat SDK that enables app administrators to remove one or multiple users from a user's blocklist. This API supports HTTPS POST requests with parameters such as sdkappid, admin identifier, user signature, and request format. It handles batch removal of up to 1,000 users per request and returns detailed success or error information for each user. The API supports a maximum invocation frequency of 200 times per second and includes specific error codes for parameter validation, permissions, server errors, and concurrency conflicts.
- [Pulling a Blacklist](https://pre.trtc.io/document/34914.md): The Pulling a Blacklist API is a Chat service API under Tencent RTC that enables app admins to retrieve a paginated blocklist of users. It supports parameters for authentication, pagination, and request format, with a maximum call frequency of 200 calls per second. The API response provides detailed blocklist entries, pagination status, and error codes for effective blocklist management.
- [Verifying Users on a Blocklist](https://pre.trtc.io/document/34913.md): The Batch User Blocklist Verification API is part of the Tencent RTC Chat SDK, enabling apps to verify multiple users against a blocklist in a single request. This API supports up to 1,000 UserIDs per call and returns detailed results including blocklist relationships and error codes. It is designed for app administrators to efficiently manage user blocklist status across various regions with a maximum call frequency of 200 requests per second.
- [Following Users](https://pre.trtc.io/document/70345.md): The Follow Users API is a Tencent Cloud Chat service interface that enables batch following of users. It is designed for app administrators who have purchased Pro, Pro Plus, or Enterprise Edition and enabled the follow feature in the Console. This API supports JSON requests with up to 20 users per batch and provides detailed response codes and error messages to facilitate integration and troubleshooting.
- [Unfollow Users](https://pre.trtc.io/document/70346.md): The Unfollow Users API is part of the Tencent Cloud Chat SDK that enables batch unfollowing of users. It is designed for app administrators who have purchased Pro, Pro Plus, or Enterprise editions and enabled the follow feature in the console. This API supports a maximum calling frequency of 200 requests per second and provides detailed request parameters, response fields, and error codes to facilitate integration and troubleshooting.
- [Get The  Fans, Follows, And Mutual Followers Count](https://pre.trtc.io/document/70347.md): The Retrieve Fans, Follows, and Mutual Followers List API is part of the Tencent RTC Chat SDK, enabling paged fetching of fans, follows, and mutual followers for specified users. This API is designed for app administrators who have purchased Pro, Pro Plus, or Enterprise editions and enabled the follow feature in the console. It supports parameters for paging, user identification, and request signing, with a maximum call frequency of 200 requests per second. The response provides detailed follower information, paging cursors for continued retrieval, and error codes for troubleshooting.
- [Checking Follow Relationship](https://pre.trtc.io/document/70349.md): The Follow Relationship Check API is part of the Tencent RTC Chat SDK that enables batch verification of follow relationships between users. It is intended for app administrators who have purchased Pro, Pro Plus, or Enterprise Edition and enabled the follow feature in the Console. The API supports up to 200 calls per second and provides detailed response data including follow status and error codes to facilitate user relationship management.
- [Get The  Fans, Follows, And Mutual Followers Count](https://pre.trtc.io/document/70350.md): The Get Fans, Followers, and Mutual Followers Count API is part of the Tencent RTC Chat SDK that enables batch retrieval of social relationship metrics for designated users. It is designed for app administrators who have purchased Pro, Pro Plus, or Enterprise Editions and activated the follow feature in the Console. This API supports JSON requests with up to 20 user IDs per call and provides detailed counts of fans, followers, and mutual followers, along with comprehensive error handling and status codes.
- [Setting Global Mute](https://pre.trtc.io/document/34923.md): The Set Global Mute API is part of the Tencent RTC Chat SDK, allowing administrators to enable or disable global muting for one-to-one and group messages on an account. It supports setting temporary or permanent mute durations, blocking message sending during the mute period and returning specific error codes. This API is designed for app admins to manage message muting with parameters including SDKAppID, user signature, and muting time in seconds. The API supports JSON request format and has a maximum call frequency of 200 calls per second.
- [Querying Global Mute](https://pre.trtc.io/document/34924.md): The Querying Global Mute API is a Chat service API that allows app administrators to retrieve the global muting status of one-to-one and group messages for a specified account. It helps determine whether message sending is disabled during a muting period, including permanent muting. The API requires authentication parameters and returns muting durations in seconds, supporting up to 200 calls per second.
- [Pulling Operations Data](https://pre.trtc.io/document/34886.md): The Pulling Operations Data API enables app administrators to retrieve operational data for the last 30 days. This API supports specifying particular data fields or retrieving all available fields by default. It is designed for app admins to monitor and analyze app usage and performance, with a maximum call frequency of 200 requests per second. The API requires authentication parameters such as sdkappid, identifier, and usersig, and returns detailed operational metrics along with error codes for troubleshooting.
- [Downloading Recent Messages](https://pre.trtc.io/document/34885.md): The Downloading Recent Messages API in Tencent RTC Chat SDK enables app admins to retrieve download URLs for one-to-one or group message records from the last seven days. Applicable to Chat SDK 4.X or later, the API supports downloading compressed message logs including multimedia files generated hourly based on Beijing time. This API requires authentication parameters and returns file metadata with expiration details, facilitating backup and statistical analysis of historical chat data.
- [Getting Server IP Addresses](https://pre.trtc.io/document/36742.md): The Get Server IP Addresses API is a Chat service RESTful API that enables app admins to retrieve server IP addresses or IP ranges used by the SDK and webhook. It supports filtering IP lists by region and SDK type through the nettype parameter. This API requires authentication with SDKAppID, admin identifier, and user signature, and allows up to 200 calls per second. The response includes a list of IP addresses, error codes, and messages to facilitate integration and security configuration.
- [Creating Official Channel](https://pre.trtc.io/document/60755.md): The Create Official Channel API allows enterprise app administrators to create and manage official channels within the Tencent RTC Chat platform. This API supports customization of channel IDs, setting channel attributes such as name, introduction, avatar, subscriber limits, and organizational grouping. It is designed for enterprise users to efficiently establish official channels with a maximum call frequency of 200 requests per second. The API response provides status codes and the official channel ID upon successful creation.
- [Terminating Official Channel](https://pre.trtc.io/document/60756.md): The Terminate Official Channel API is part of the Chat Enterprise API, designed for app administrators to disable official channels. This API supports region-specific endpoints and requires authentication parameters including sdkappid, identifier, and usersig. It handles up to 200 calls per second and returns detailed status and error codes to facilitate integration and troubleshooting.
- [Modifying Official Channel Information](https://pre.trtc.io/document/60757.md): The Modify Official Channel Information API allows enterprise app administrators to update details of an official channel, including its name, avatar, introduction, organization, custom string, and maximum subscriber number. This API requires proper authentication and supports regional endpoints. It is designed to help manage official channels efficiently with a maximum call frequency of 200 requests per second. The response provides clear status and error codes to facilitate integration and troubleshooting.
- [Obtaining Official Channel Information](https://pre.trtc.io/document/60758.md): The Get Official Channel Information API is a RESTful API designed for app administrators to retrieve detailed data about official channels. This API is available exclusively to Enterprise users and supports querying up to 50 official channels per request. It provides key information such as creation time, owner account, subscriber count, introduction, and more. The API enforces a maximum call frequency of 200 times per second and requires authentication parameters including sdkappid, identifier, and usersig.
- [Obtaining Subscriber Information of Official Channel](https://pre.trtc.io/document/60759.md): The Get Subscriber Information API is part of the official channel management SDK, designed for enterprise app administrators to retrieve detailed subscriber data. It supports querying subscriber accounts, subscription times, custom fields, and message preferences with a high call frequency limit. This API facilitates efficient management of official channel subscribers across multiple regions.
- [Adding Subscribers](https://pre.trtc.io/document/60760.md): The Add Subscribers API enables app administrators to subscribe users to official channels within the Tencent RTC Chat service. Designed for enterprise use, it supports batch subscription of up to 100 users per request and provides detailed response feedback including success status and error codes. This API requires proper authentication and is subject to call frequency limits, facilitating efficient management of official channel subscribers.
- [Deleting Subscribers](https://pre.trtc.io/document/60761.md): The DeleteSubscriber API is part of the official channel management APIs designed for enterprise app administrators to unsubscribe users from official channels and remove them from subscriber lists. It supports high-frequency calls up to 200 times per second and requires specific parameters including sdkappid, admin identifier, and user signature. The API returns detailed results for each subscriber deletion request, including success or failure status and error codes, enabling precise management of official channel subscribers.
- [Modifying Subscriber Information](https://pre.trtc.io/document/60762.md): The Modify Subscriber Information API in the Chat Enterprise SDK allows app administrators to update subscriber details such as custom fields within official accounts. This API is designed for enterprise users and requires proper permissions and SDKAppID configuration. It supports region-specific endpoints and enforces a maximum call frequency of 200 requests per second. The API returns detailed response codes to indicate success or specific errors, facilitating reliable subscriber management.
- [Obtaining Subscribed Official Channel](https://pre.trtc.io/document/60763.md): The Get Subscribed Official Channel List API is part of the Chat Enterprise API, enabling app administrators to retrieve detailed information about all official channels subscribed by a specific user. This API supports filtering of official channel fields and subscriber information, pagination controls, and is region-specific. It is designed for enterprise users to manage official channel subscriptions efficiently with a maximum call frequency of 200 requests per second.
- [Pulling Chatbot Accounts](https://pre.trtc.io/document/55280.md): The Get All Chatbot Accounts API is part of the Chat platform SDK, designed to retrieve the list of all chatbot accounts whose userids start with @RBT#. It is intended for app administrators to manage chatbot accounts efficiently. The API supports JSON request format, requires authentication parameters including sdkappid and usersig, and allows up to 200 calls per second. The response includes the status, error codes, and an array of chatbot user IDs.
- [Creating Chatbot Accounts](https://pre.trtc.io/document/55281.md): The Create Chatbot Account API is part of the Chat platform SDK, enabling app administrators to create chatbot accounts with user IDs starting with @RBT#. It supports setting nicknames, profile photos, and statuses for chatbots. This API is designed for app admins managing chatbot integrations and allows up to 200 calls per second. Detailed request parameters, response fields, error codes, and debugging tools are provided to facilitate integration and troubleshooting.
- [Deleting Chatbot Accounts](https://pre.trtc.io/document/55282.md): The Delete Chatbot Accounts API is a RESTful interface provided by Tencent Cloud Chat to invalidate chatbot accounts identified by user IDs starting with @RBT#. It is designed for app administrators to manage chatbot lifecycle by setting bot accounts to invalid without removing their UserIDs. The API requires authentication parameters including sdkappid, identifier, and usersig, supports JSON request format, and enforces a maximum call frequency of 200 calls per second. Detailed error codes and response fields enable precise debugging and integration.
- [On-demand Moderation](https://pre.trtc.io/document/77827.md): The On-demand Moderation API of Tencent RTC Content Understanding SDK enables backend applications to submit audio, video, text, or image content for real-time moderation. It supports synchronous responses for text and image content and asynchronous webhook responses for audio and video content. This API is designed for app administrators to configure moderation scenarios and analyze content with detailed results including moderation suggestions, malicious scores, and content labels. It currently supports the Singapore data center with a rate limit of 200 requests per second.
- [On-demand Batch Moderation](https://pre.trtc.io/document/77828.md): The On-demand Batch Moderation API is a REST API provided by Tencent Cloud Chat for submitting batches of text and image content for proactive moderation. It is designed for backend applications to efficiently moderate content by specifying moderation configurations and content details in JSON format. The API supports up to 10 items per request, enforces a rate limit of 200 requests per second, and returns detailed moderation results including labels, scores, and error codes for each content item.
- [Get Blocklists](https://pre.trtc.io/document/77829.md): The Get Blocklists API is part of the Content Understanding SDK that allows backend applications to retrieve keyword library lists for content moderation. It supports querying keyword blocklists with parameters including SDKAppID, administrator credentials, and request formatting. This API is currently available only in the Singapore region and enforces a rate limit of 200 requests per second. The response provides detailed information about keyword libraries, including IDs, names, creation times, and moderation suggestions, enabling effective content filtering and management.
- [Get Blocked Words](https://pre.trtc.io/document/77830.md): The Get Blocked Words API is part of the Cloud Moderation SDK that enables backend applications to retrieve sensitive words from a specified keyword library. It supports pagination and fuzzy search to help manage content moderation effectively. This API is designed for app administrators using the Chat service, currently supporting the Singapore region with a rate limit of 200 requests per second. The response includes detailed sensitive word information and error codes for troubleshooting.
- [Add Blocked Words](https://pre.trtc.io/document/77831.md): The Add Blocked Words API in the Cloud Moderation SDK enables application backends to add sensitive words to keyword libraries for content moderation. This API requires parameters including the application ID, keyword library ID, and an array of sensitive words with optional labels. It supports JSON request format and enforces a rate limit of 200 requests per second. The response provides detailed status and error codes to facilitate integration and error handling.
- [Delete Blocked Words](https://pre.trtc.io/document/77832.md): The Delete Blocked Words API is part of the Content Understanding SDK, enabling app backends to remove sensitive keywords from keyword libraries. This API requires parameters such as SdkAppId, LibID, and a list of keywords to delete, supporting up to 10 keywords per request. It provides detailed response information including deletion status and error codes, with a maximum rate limit of 200 requests per second. This reference is intended for developers managing keyword moderation within Tencent RTC's Content Understanding service.
- [Recalling Push](https://pre.trtc.io/document/67824.md): The Recall Push API in Tencent RTC Chat service allows administrators to terminate, recall, or overwrite push notifications sent to all users or tags within 24 hours of task initiation. This API supports recalling unread or roaming messages and overwriting offline push notifications for supported vendors such as APNS, Google FCM, Huawei, and Honor. It requires HTTPS POST requests with specific parameters and is limited to one invocation per second, enabling precise control over push notification management.
- [Webhook Overview](https://pre.trtc.io/document/34354.md): Chat Webhook is a feature of the Chat SDK that enables app backends to receive HTTP/HTTPS POST requests before or after specific events occur. This allows apps to synchronize data or intervene in event processing, supporting four webhook types including online status and group webhooks. The webhook protocol includes parameters such as SdkAppid and CallbackCommand, with a two-second timeout period and configurable retry options after events. This overview explains webhook classification, protocol details, examples, timeout handling, and security considerations.
- [Webhook Command List](https://pre.trtc.io/document/34355.md): The Webhook Command List provides detailed API references for webhook command words associated with Tencent RTC events. It includes webhook commands for online status changes, profile updates, friend and follower actions, one-to-one messaging events, and group management activities. This documentation is intended for developers integrating Tencent RTC webhooks to handle real-time event notifications effectively.
- [API Overclocking Alarm Callbacks](https://pre.trtc.io/document/60256.md): The API Overclocking Alarm Callbacks feature in the Chat API notifies the app backend via HTTPS POST callback when the API request frequency exceeds 80% of the threshold. This API reference details the callback URL configuration, request parameters such as SDKAppID, CallbackCommand, and OptPlatform, as well as the structure of request and response packets. It is designed for developers integrating alarm callbacks to monitor API usage and ensure security by validating SDKAppID.
- [Status Change Webhooks](https://pre.trtc.io/document/34357.md): Status Change Webhooks provide a callback service within Tencent RTC Chat SDKs that enables app backends to monitor user login, logout, network disconnection, and app crash events in real time. This overview explains the supported platforms including Android, iOS, PC, Web, and Mini Program, the callback trigger scenarios, and key configuration and security considerations for implementing these real-time status updates.
- [After a Profile Is Updated](https://pre.trtc.io/document/48733.md): The Profile Update Callback API in the Chat SDK enables app backends to receive real-time notifications of user profile changes. It supports HTTPS POST requests triggered after successful profile modifications by users or admins. This API requires configuring a callback URL and verifying SDKAppID for security. Key parameters include CallbackCommand, Operator_Account, From_Account, EventTime, and ProfileItem, which detail the updated profile fields and values.
- [Before a Friend Is Added](https://pre.trtc.io/document/43468.md): The PrevFriendAdd Callback API is part of the Tencent RTC Chat SDK, enabling app backends to receive real-time notifications of friend requests and block malicious ones. It triggers an HTTPS POST callback when a user initiates a friend request on the client side, providing detailed request parameters and response fields for effective friend management. This API is essential for apps requiring precise control over friend request processing and security.
- [Before a Friend Request Is Responded](https://pre.trtc.io/document/43467.md): The Sns.CallbackPrevFriendResponse API is a callback interface in the Tencent RTC Chat backend that enables app backends to receive real-time notifications of friend request responses. It supports viewing user responses such as acceptance or rejection and blocking malicious responses. The callback is triggered when a user responds to a friend request within the app, and the app backend must verify the SDKAppID for security. This API helps apps manage friend relationships effectively by providing detailed response data including user IDs, remarks, tags, and response actions.
- [After a Friend Is Added](https://pre.trtc.io/document/34359.md): The Friend Addition Callback in the Chat SDK allows app backends to receive real-time notifications when users add friends. This callback is triggered upon successful friend additions, enabling backend systems to track friend relationships dynamically. It requires configuring a callback URL and enabling the protocol to receive HTTP POST requests containing detailed friend addition information, including initiator accounts and friend pairs. The callback supports various friend addition scenarios and provides structured request and response formats for secure and reliable integration.
- [After a Friend Is Deleted](https://pre.trtc.io/document/34360.md): The Friend Deletion Callback is a Chat API that enables the app backend to receive real-time notifications when users delete friends. It supports HTTPS POST requests containing JSON data about deleted friend pairs. This API helps app backends synchronize friend list changes by verifying SDKAppID and processing callback requests triggered after successful friend deletions. Detailed request parameters, packet formats, and response fields are provided for integration.
- [After a User Is Added to Blocklist](https://pre.trtc.io/document/34361.md): The User Blocklist Addition Callback API is part of Tencent Chat's third-party callback system. It notifies the app backend in real time when users are successfully added to the blocklist via the Chat backend. This API is designed for app backends integrating with Tencent Chat to securely receive blocklist update events through HTTPS POST requests. Key features include request parameter validation, callback triggering scenarios, and response handling to confirm successful processing.
- [After a User Is Removed from Blocklist](https://pre.trtc.io/document/34362.md): The User Removal from Blocklist callback is a feature of the Chat API that enables the app backend to receive real-time notifications when users are removed from a blocklist. This callback is triggered after the Chat backend processes a successful removal request and sends an HTTPS POST request containing relevant user and request details. It is designed for app developers who need to monitor blocklist changes and ensure synchronization between client and backend systems. The callback includes parameters such as SDKAppID, CallbackCommand, and client platform information, with request and response formats defined in JSON.
- [After a One-to-One Message Extension Is Configured](https://pre.trtc.io/document/76006.md): The One-to-One Message Extension webhook is a real-time monitoring API provided by Tencent RTC that enables app backends to track message extension operations in one-to-one chats. It supports triggering via client SDK or REST API configurations and delivers HTTPS POST requests with detailed JSON data about message extension events. This webhook is designed for developers who need to capture and respond to message extension changes, providing key parameters such as SDKAppID, message identifiers, operation types, and timestamps to ensure secure and accurate event handling.
- [Before a One-to-One Message Is Sent](https://pre.trtc.io/document/34364.md): The One-to-One Message Pre-Send Webhook is a real-time message management API provided by Tencent RTC. It allows app backends to record, synchronize, and block non-compliant one-to-one messages such as text, images, and custom messages before they are delivered. This webhook requires configuration of the webhook URL and activation in the app settings. It triggers when a user or admin sends a one-to-one message and operates within a two-second timeout window to ensure timely message handling.
- [After a One-to-One Message Is Sent](https://pre.trtc.io/document/34365.md): The C2C.CallbackAfterSendMsg API is a real-time callback service within the Tencent RTC Chat SDK that enables app backends to manage one-to-one messages. It records message logs, synchronizes messages to other systems, and collects usage statistics. This API triggers a callback after a one-to-one message is sent, providing detailed message data and sending results via HTTPS POST requests. It is designed for app developers who need to monitor and process individual chat messages efficiently.
- [After a One-to-One message Is Marked as Read](https://pre.trtc.io/document/43465.md): The After a One-to-One Message Is Marked as Read API is a Chat backend callback API that notifies the app backend in real time when a one-to-one message is marked as read. It is designed for app developers to track message read statuses by receiving HTTPS POST callbacks containing details like the read reporter, peer account, read time, and unread message count. To use this API, developers must configure the callback URL and enable the corresponding switch in the Chat console. This API supports secure verification of SDKAppID and is triggered both when a user or admin marks a message as read.
- [After A One-to-One Message Is Recalled](https://pre.trtc.io/document/43466.md): The C2C.CallbackAfterMsgWithDraw API is part of the Tencent RTC Chat callback protocol, enabling app backends to receive real-time notifications when one-to-one messages are recalled. This API is intended for app developers who need to handle message recall events securely by configuring callback URLs and validating SDKAppID. It provides essential parameters such as sender and recipient IDs, message unique identifier, and unread message count, facilitating effective message management and user experience.
- [After a Group Message Extension Is Configured](https://pre.trtc.io/document/76007.md): The Group Message Extension webhook is a real-time monitoring SDK feature that enables app backends to track user message extension operations in group chats. It supports triggering via Client SDK or REST API configurations and sends HTTPS POST requests with detailed JSON payloads to a configured callback URL. This webhook helps developers verify operations such as setting, deleting, or clearing message extension key-value pairs, providing essential parameters and response statuses for integration security and reliability.
- [Before a Group Is Created](https://pre.trtc.io/document/34368.md): The Group.CallbackBeforeCreateGroup webhook event is part of the Chat API that enables the app backend to intercept and validate group creation requests in real time before the group is created. It is designed for app developers to control group creation by verifying requests and optionally rejecting them based on business logic. The webhook uses HTTPS POST requests containing detailed parameters about the group and operator. The response must indicate whether the group creation is allowed or denied, ensuring secure and controlled group management.
- [After a Group Is Created](https://pre.trtc.io/document/34369.md): The Group.CallbackAfterCreateGroup callback API in Tencent Cloud Chat SDK notifies the application backend immediately after a group is created successfully. It enables backend synchronization of group data including group ID, operator, owner, type, name, members, and custom fields. This API supports HTTPS POST requests and requires proper callback URL configuration and SDKAppID verification to ensure security.
- [Before Applying to Join a Group](https://pre.trtc.io/document/34370.md): The Group.CallbackBeforeApplyJoinGroup API is part of the Tencent RTC Chat callback SDK, enabling app backends to receive and handle users' group join requests in real time. It allows apps to block or allow join requests before users are added to groups or before admin notifications. The API is triggered via HTTPS POST requests containing detailed parameters such as group ID, requester account, and join messages. App backends must verify SDKAppID for security and respond with action status codes to control request processing.
- [Before Inviting a User to a Group](https://pre.trtc.io/document/34371.md): The Group.CallbackBeforeInviteJoinGroup API is a callback interface in the Tencent Cloud Chat SDK that enables real-time monitoring and control of user invitations to groups on the app backend. It triggers before a user is added to a group, allowing the backend to approve or block invitation requests. This API uses HTTPS POST requests with defined parameters such as SDKAppID, GroupId, and Operator_Account, and expects JSON responses indicating the action status and any refused members. It is designed for app developers managing group membership workflows and requires proper callback URL configuration and security validation.
- [After a User Joins a Group](https://pre.trtc.io/document/34372.md): The After a User Joins a Group callback is a real-time notification API within the Tencent RTC Chat SDK that informs the application backend when a user joins a group. It supports multiple scenarios such as user requests, invitations by members, and admin additions via RESTful API. This callback enables apps to synchronize group membership data promptly by receiving HTTPS POST requests containing detailed join event information. The callback requires configuration of a callback URL and verification of SDKAppID for security.
- [After a User Leaves a Group](https://pre.trtc.io/document/34373.md): The Group Member Exit Callback is a Tencent RTC chat SDK feature that enables app backends to receive real-time notifications when users leave or are removed from groups. It supports secure HTTPS POST requests containing detailed information such as group ID, exit type, operator account, and event timestamp. This callback helps developers record and synchronize user group leaving events efficiently, ensuring accurate group membership management.
- [Before Group Message Is Sent](https://pre.trtc.io/document/34374.md): The Group Message Pre-Send webhook API enables app backends to intercept and inspect group messages in real time before they are delivered to group members. It supports recording message logs and blocking message sending requests, providing control over group communication. This API is designed for app developers integrating Tencent RTC Chat services who need to moderate or synchronize group messages. It operates via HTTPS POST requests with parameters such as SDKAppID, CallbackCommand, and ClientIP, and triggers before message delivery with a default two-second timeout to ensure timely processing.
- [After a Group Message Is Sent](https://pre.trtc.io/document/34375.md): The Group Message Sent webhook API is part of the Tencent RTC Chat webhook service, enabling app backends to receive real-time notifications when group messages are sent successfully. It supports HTTPS POST requests with detailed parameters describing the message, sender, group, and event timing. This API helps developers synchronize group message data securely and efficiently by verifying SDKAppID and processing message details such as MsgId, MsgSeq, MsgBody, and custom cloud data.
- [After a Group Is Full](https://pre.trtc.io/document/34376.md): The After a Group Is Full webhook event in Tencent RTC Chat SDK enables app backends to receive real-time notifications about the status of full groups. It is designed for app developers to track when a group reaches full capacity after members join or fail to join, facilitating timely management of group membership. The webhook requires configuring a secure URL and supports HTTPS POST requests containing key parameters such as group ID and event timestamp. This feature helps maintain active group membership and supports backend logic for group management.
- [After a Group Is Disbanded](https://pre.trtc.io/document/34377.md): The Group Disbanding Callback is a Chat SDK feature that enables real-time notification of group disbanding events to the backend. It is designed for app developers to record or sync group disbanding information securely after a group is disbanded by a user or admin. The callback is triggered via an HTTPS POST request containing detailed group information, and requires backend verification of the SDKAppID and a response confirming receipt. This ensures reliable tracking and handling of group lifecycle events.
- [After Group Profile Is Modified](https://pre.trtc.io/document/34378.md): The After Group Profile Is Modified webhook event is part of the Tencent RTC Chat SDK, enabling app backends to receive real-time notifications of changes to group profiles including group name, introduction, notice, and profile photo. It is designed for app developers and administrators to monitor and synchronize group profile updates efficiently. This webhook triggers an HTTPS POST request upon modifications, requiring proper configuration and security verification of SDKAppID. It supports both client-side and RESTful API modifications, providing detailed request and response structures for integration.
- [Callback After Recalling Group Messages](https://pre.trtc.io/document/46979.md): The Group Message Recall Callback webhook API allows app backends to receive real-time notifications when group messages are recalled. It supports HTTPS POST requests containing detailed information about the recalled messages, operator, and group context. This API is intended for app developers integrating Tencent RTC Chat to monitor message recall events securely by verifying SDKAppID and handling webhook payloads accordingly.
- [Webhook for Online and Offline Status of Audio-Video Group Members](https://pre.trtc.io/document/48734.md): The Webhook for Online and Offline Status of Audio-Video Group Members is a Tencent RTC API feature that enables real-time tracking and synchronization of group member connectivity status. Designed for apps using Tencent RTC Pro, Pro Plus, or Enterprise editions, it helps backend systems receive timely updates on member online and offline events triggered by heartbeat interruptions, recoveries, and group join or exit actions. This webhook supports multi-device scenarios and ensures accurate member state management for audio-video groups.
- [Webhook for Exceptions When Group Messages Are Sent](https://pre.trtc.io/document/49462.md): The Group Message Exception Webhook is an API callback provided by Tencent RTC that allows app backends to monitor and handle exceptions occurring during group message sending. It is designed for app developers and administrators to detect issues such as invalid parameters, message frequency limits, content compliance failures, and muted senders. The callback is triggered via HTTPS POST requests after message delivery failures and includes comprehensive data fields for precise error handling and auditing.
- [Before a Topic Is Created](https://pre.trtc.io/document/49463.md): The Group.CallbackBeforeCreateTopic API is part of the Tencent Cloud Chat SDK, enabling applications to receive real-time callbacks before a topic is created. It allows the application backend to approve or reject topic creation requests initiated by users or admins. The callback is triggered via HTTPS POST with detailed request and response parameters, supporting security checks and error handling. This API is essential for managing topic creation workflows and enforcing custom business logic.
- [After a Topic Is Created](https://pre.trtc.io/document/49464.md): The After a Topic Is Created callback is a feature of the Tencent RTC Chat SDK that notifies the application backend in real time when a topic is successfully created by a user or admin. It enables backend systems to synchronize topic data immediately via an HTTP POST request containing detailed topic information and custom fields. This callback supports secure verification of SDKAppID and requires enabling the topic feature in the console. It is triggered after topic creation on client or RESTful API and provides a response indicating synchronization status.
- [After a Topic Is Deleted](https://pre.trtc.io/document/49465.md): The Topic Deletion Callback is a feature of the Tencent RTC Chat SDK that enables real-time notification of topic deletion events to the application backend. It is designed for app developers who need to track and synchronize topic deletion statuses, supporting scenarios where topics are deleted by users or administrators. The callback delivers detailed deletion information via HTTPS POST requests, ensuring secure verification of SDKAppID and seamless integration with backend systems.
- [Topic Profile Change Webhook](https://pre.trtc.io/document/49466.md): The Topic Profile Change Webhook is a Chat service callback that enables applications to receive real-time notifications of changes to topic profiles, including topic name, introduction, notice, and profile photo. This feature allows backend systems to log changes or synchronize topic information efficiently. It requires configuring a callback URL and enabling the topic feature in the console. The callback is triggered after any topic profile modification by users or administrators and uses HTTPS POST requests to deliver detailed change data.
- [Callback After Group Member Profile Changed](https://pre.trtc.io/document/60393.md): The Group Member Profile Change Callback API is part of the Tencent RTC Chat SDK, enabling app backends to receive real-time notifications when group member information such as identity or group card changes. This API supports HTTPS POST requests with JSON payloads and requires backend verification of SDKAppID for security. It is designed for app developers to synchronize data immediately after group member profile modifications triggered by clients or RESTful APIs. The callback request includes detailed parameters about the group, operator, and member changes, while the backend must respond with a status indicating successful processing.
- [Callback After Group Attribute Changed](https://pre.trtc.io/document/60394.md): The Group.CallbackAfterGroupAttrChanged callback in Tencent Cloud Chat API notifies the app backend of real-time changes to Group Custom Definition Attributes, including modification, clearing, resetting, and deletion. It enables backend synchronization by sending HTTPS POST requests with detailed parameters such as GroupId, Operator_Account, and GroupAttr. The callback requires validation of SDKAppID and supports response handling with status and error codes.
- [Callback After Read Receipt](https://pre.trtc.io/document/60395.md): The Group Message Read Receipt Callback API enables the App Backend to receive real-time updates on the read status of group messages. This API is designed for applications that require synchronization of group message read receipts, triggered when users send or acknowledge read receipts. It uses HTTPS POST requests with JSON payloads containing detailed read receipt information, including group ID, message sequence, and member read status. The App Backend must verify the SDKAppID for security and respond with a structured result indicating processing success or failure.
- [Callback After the Group Owner Changed](https://pre.trtc.io/document/60396.md): The Group Owner Change Callback API in Tencent Cloud Chat service enables app backends to receive real-time notifications when a group owner is transferred. This API supports secure HTTPS POST requests containing detailed information such as the group ID, old and new owner accounts, and event timestamps. It is designed for app developers to synchronize data and maintain accurate group ownership states after changes triggered by users or administrators via client or REST API.
- [Group Creation Daily Net Increase Threshold Alarm Callback](https://pre.trtc.io/document/57455.md): The Group Creation Daily Net Increase Threshold Alarm Callback is a Chat SDK feature that notifies the application backend when the daily net increase of created groups approaches the configured limit. It is designed for app developers and administrators to monitor group creation activities and receive timely alerts via HTTP POST requests. This callback requires URL configuration and enabling the topic feature in the console, providing key parameters such as daily created groups count, limit, and event timestamp to facilitate backend processing and security verification.
- [After a User Is Followed](https://pre.trtc.io/document/70355.md): The After a User Is Followed webhook API enables the app backend to receive real-time notifications when a user successfully follows another user. It supports HTTPS POST requests containing detailed follow event data, including follower and followee user IDs, event timestamps, and client platform information. This API is designed for app backends to track user follow activities securely by verifying SDKAppID and handling follow event callbacks promptly.
- [After a User Is Unfollowed](https://pre.trtc.io/document/70356.md): The User Unfollow Webhook is a real-time notification service that informs the app backend when users unfollow others. It is designed for app developers to monitor unfollow events triggered by users or administrators via client or REST API. The webhook sends HTTPS POST requests with detailed JSON data, enabling apps to respond promptly to changes in user relationships while ensuring security by verifying SDKAppID.
- [Cloud Moderation Webhooks](https://pre.trtc.io/document/78240.md): Cloud Moderation Webhooks API is a Tencent RTC feature that enables app backends to receive real-time content moderation results via HTTPS POST requests. It supports multiple moderation scenarios including C2C chat, group chat, and user profiles, handling various content types such as text, image, audio, and video. The API provides detailed parameters for verifying requests and interpreting moderation outcomes, including violation categories and suggestions, to help developers integrate content compliance efficiently.
- [Callback After Sending a One-to-One Message to a Chatbot](https://pre.trtc.io/document/68952.md): The Bot One-to-One Message Callback API enables app backends to receive real-time HTTPS POST callbacks after a one-to-one message is sent to a chatbot. This API is designed for app developers to perform operations such as message logging, synchronization, and statistical analysis. The callback triggers after the Chat backend forwards a message to a chatbot, requiring proper webhook URL configuration and SDKAppID verification. Detailed request parameters, sample request and response packets, and field descriptions are provided to facilitate integration and ensure secure and accurate message processing.
- [Callback After Reminding a Chatbot in a Group](https://pre.trtc.io/document/68953.md): This API reference details the callback triggered when a user reminds a chatbot in a group within the Tencent RTC Chat service. It explains how to configure the callback URL, the HTTPS POST request format, key parameters such as SDKAppID, CallbackCommand, and the structure of request and response packets. The callback enables app backends to receive real-time notifications with comprehensive message and group information, facilitating chatbot interaction management.
- [Before a Official Channel Is Created](https://pre.trtc.io/document/60795.md): The Official Channel Creation Webhook is a Chat API feature that enables app backends to receive real-time notifications and control requests for creating official channels. It is designed for app administrators to monitor and optionally reject channel creation requests initiated via the REST API. The webhook uses HTTPS POST requests with parameters including SDKAppID and CallbackCommand, providing detailed request and response fields to manage creation permissions securely.
- [After a Official Channel Is Created](https://pre.trtc.io/document/60796.md): The Official Channel Creation Webhook is a feature of the Tencent RTC Chat API that enables app backends to receive real-time notifications when users create official channels. It supports HTTPS POST requests containing detailed information such as operator ID, official account ID, creator, and event timestamp. This webhook facilitates data synchronization and backend operations immediately after an official channel is successfully created, ensuring timely updates and integration.
- [After Official Channel Profile Is Modified](https://pre.trtc.io/document/60797.md): The Official Channel Profile Modification Webhook API enables app backends to receive real-time notifications of changes to Official Channel information, including updates to the channel name, description, avatar, and affiliated organization. This API is designed for developers integrating Tencent RTC services who need to synchronize or log Official Channel data changes. The webhook triggers an HTTPS POST request after successful modifications, providing detailed parameters and requiring verification of SDKAppID for security.
- [After Official Channel Is Destroyed](https://pre.trtc.io/document/60798.md): The Official Channel Destruction Webhook is part of the Chat API that enables app backends to monitor and respond to the real-time dissolution of official channels. It provides detailed callback data including the destroyed channel's ID, owner, name, and event timestamp. This webhook is triggered after an official channel is destroyed via the REST API, allowing apps to log or synchronize this event securely. The documentation covers request parameters, sample requests and responses, and security considerations for proper integration.
- [Before Official Channel Is Subscribed](https://pre.trtc.io/document/60799.md): The Official Channel subscription webhook is a Chat SDK feature that allows app backends to intercept and verify user subscription requests to the Official Channel in real time. It supports HTTPS POST callbacks with detailed request and response parameters, enabling backend systems to approve or block subscription attempts. This capability helps apps manage user subscriptions securely and efficiently before the subscription is finalized.
- [After Official Channel Is Subscribed](https://pre.trtc.io/document/60800.md): The Official Channel subscription webhook is a real-time notification API that enables app backends to receive subscription events immediately after a user subscribes to the Official Channel. It supports HTTPS POST requests containing subscriber details, allowing apps to synchronize data efficiently. This webhook requires proper configuration of the Webhook URL and protocol toggle and includes security checks such as SDKAppID verification. The documentation provides detailed request and response examples, parameter descriptions, and triggering scenarios to assist developers in integration.
- [After a Official Channel Is Full](https://pre.trtc.io/document/60801.md): The Official Channel Subscription Limit Webhook is a Chat SDK feature that enables app backends to monitor in real-time when the subscription count for an Official Channel reaches its maximum. It is designed for app developers to receive timely notifications after users subscribe or admins add subscribers via REST API. The webhook triggers an HTTPS POST request containing subscription details, which the backend must verify and respond to with processing status. This ensures effective management of subscription limits and user subscription flow.
- [After Official Channel Is Unsubscribed](https://pre.trtc.io/document/60802.md): The Official Channel Unsubscription Webhook is a real-time notification API that enables app backends to track user unsubscriptions from official channels. It supports scenarios where users unsubscribe via client or administrators remove subscribers via REST API. The webhook sends HTTPS POST requests containing detailed information such as unsubscribed user accounts, operator IDs, and event timestamps. This allows backend systems to log, synchronize, or process unsubscription events securely by verifying SDKAppID and handling the webhook payload accordingly.
- [Before Official Channel Message Is Sent](https://pre.trtc.io/document/60803.md): The Official Channel Message Pre-Send Webhook is a real-time monitoring and control SDK feature that enables app backends to intercept and manage broadcast messages before they are sent to subscribers. It is designed for developers who need to record messages, synchronize them to other systems, or block message sending requests on official channels. The webhook triggers an HTTPS POST request with detailed message data, allowing backend systems to decide whether to allow, prohibit, or silently discard messages, thereby providing flexible message management capabilities.
- [Callback After Sending an Official Channel Message](https://pre.trtc.io/document/60804.md): The Official Channel Message Callback webhook is a real-time monitoring SDK that allows app backends to receive notifications when official channel messages are sent successfully. It supports secure HTTPS POST requests with detailed message information, enabling apps to synchronize data efficiently after message delivery to subscribers. This webhook is essential for applications managing official account communications and ensures timely updates on message status.
- [Webhook After Recalling Official Channel Messages](https://pre.trtc.io/document/60805.md): The Official Channel Message Recall Webhook is a real-time notification API that enables app backends to monitor message revocations in Official Channels. It is designed for app developers and administrators who need to track message recalls triggered by users or via REST API. The webhook sends HTTPS POST requests with JSON data including message identifiers and event timestamps, allowing secure and timely processing of recall events. Verification of SDKAppID in requests enhances security.
- [New Console Introduction](https://pre.trtc.io/document/66875.md): The new Chat console is a management platform that integrates multiple Tencent Cloud communication services, including Chat, RTC Engine, Call, Conference, Live, and Beauty AR. It supports multilingual access and allows users to create applications, configure chat services, monitor real-time usage statistics, and manage subscription packages. This guide provides step-by-step instructions to help users quickly understand and operate the new console interface for efficient resource management and service configuration.
- [Creating and Upgrading an Application](https://pre.trtc.io/document/34577.md): This guide details the process of creating Free Trial Chat applications and obtaining SDKAppIDs using the Tencent Cloud Chat console. It is intended for developers who want to start with a Developer Edition app and later upgrade to Standard, Pro, Pro Plus, or Enterprise editions. The guide covers prerequisites, creation steps, and upgrade procedures including payment and subscription confirmation.
- [Basic Configuration](https://pre.trtc.io/document/34540.md): This guide details the basic configuration and management of Chat applications within Tencent Cloud Console. It explains how to upgrade application packages, disable or delete applications, extend trial edition validity, edit application information, obtain application keys, and manage offline push certificates. The instructions help developers and administrators efficiently control their Chat apps and related services, ensuring smooth operation and compliance with billing and service policies.
- [Feature Configuration](https://pre.trtc.io/document/34419.md): Chat Feature Configuration provides detailed settings for login and messaging within the Chat Console. It enables users to manage multi-client login policies, message recall periods, message extensions, notification do not disturb, historical message storage, and user-related notifications. Designed for Pro, Pro Plus, Enterprise, and Standard editions, it supports enhanced customization and control over chat functionalities, requiring specific SDK versions for advanced features.
- [Account Management](https://pre.trtc.io/document/50301.md): Tencent Cloud Chat Account Management guide provides detailed instructions on creating, deleting, editing, and exporting user accounts within the Chat console. It is designed for administrators managing user identities and permissions to efficiently handle account lifecycle and settings. The guide covers key steps such as configuring account types, lifting deletion restrictions, editing user profile details, and exporting account data.
- [Group Management](https://pre.trtc.io/document/34578.md): The Chat Group Management guide provides step-by-step instructions for managing groups within the Chat console and via RESTful APIs. It covers adding groups, viewing and modifying group details, managing group members, sending messages, and deleting groups. This guide is designed for developers and administrators who need to efficiently organize and control group communications in their applications.
- [Official Channel Management](https://pre.trtc.io/document/77714.md): The Chat Official Channel Management guide provides step-by-step instructions for managing official channels through the Chat Console or REST APIs. It enables users to create, edit, and delete official channels, as well as create posts in various formats such as text, image, and text-and-image. This guide is designed for users who need to efficiently handle official channel operations and content publishing within the Chat platform.
- [Webhook Configuration](https://pre.trtc.io/document/34520.md): Tencent Cloud Chat webhook configuration guide explains how to set up callback URLs and enable event webhooks for real-time user and operation data retrieval. It covers configuring webhook URLs, activating event callbacks, and subsequent operations to ensure proper webhook functionality within the Chat console.
- [Viewing Guide for Resource Packages](https://pre.trtc.io/document/70341.md): This guide explains how to view resource packages for community message volume and plug-in usage within the Chat Console. It is intended for Chat users who need to monitor their monthly package coverage and plug-in activations such as cloud search and speech-to-text. The steps include navigating to specific configuration and advanced features sections in the Chat Console to access detailed resource usage information.
- [Usage Statistics](https://pre.trtc.io/document/34579.md): The Chat console is a data analysis platform that provides detailed statistics on user activity, messaging, group dynamics, community message delivery, cloud search, and text message translation. It is designed for app administrators and developers to monitor and analyze their application's performance through daily updated metrics, enabling insights into user engagement and message trends.
- [Real-Time Monitor](https://pre.trtc.io/document/69873.md): Chat Real-Time Monitoring is a beta feature of the Chat SDK that provides detailed insights into online user activity, message statistics, login performance, callback and API request success rates, and offline push notifications. It supports data collection from Chat SDKs version 4.8.10 or later on iOS, Android, Windows, and macOS platforms. This monitoring tool helps developers and operators track real-time usage and performance metrics to optimize their chat applications.
- [Auxiliary Development Tools](https://pre.trtc.io/document/34580.md): Tencent Cloud Chat Auxiliary Development Tools provide developers with essential utilities to troubleshoot offline push notification failures, check user client status, generate and verify UserSig signatures, and query backend logs within the last three days. These tools enable efficient debugging and issue resolution for chat applications by offering step-by-step operations such as push content testing, user status verification, signature generation, and log filtering.
- [Grant Console Access Permissions to Sub-Accounts](https://pre.trtc.io/document/78415.md): This guide details two methods for granting console access permissions to sub-accounts in the TRTC service. It is intended for main account holders who need to authorize sub-accounts to view and manage TRTC applications in the Console. The guide covers global authorization via CAM policies and tag-based authorization that limits sub-account access to applications with specific tags. Step-by-step instructions include policy selection, tag configuration, and completion of authorization to ensure sub-accounts can properly access and operate TRTC Console resources.
- [One-to-One Message](https://pre.trtc.io/document/33523.md): One-to-One Message is an Instant Messaging SDK feature of Tencent RTC that enables direct communication between two users. It supports diverse message types such as text, emoji, images, voice, files, and system notifications. The SDK offers comprehensive messaging capabilities including sending, receiving, offline message handling, multi-device synchronization, and permission controls like friend-only messaging and blocking. It is designed for app developers and administrators to implement robust C2C chat functionality with message history retrieval and offline push support across major mobile platforms.
- [Message Storage](https://pre.trtc.io/document/33524.md): Message Storage Chat is a messaging SDK that supports roaming message history across devices, unread message storage with limits for C2C and group chats, recent contacts tracking, and local message storage with API access. It enables users to maintain chat continuity and access historical messages seamlessly on multiple platforms.
- [Offline Push](https://pre.trtc.io/document/33525.md)
- [Group Message](https://pre.trtc.io/document/33526.md): Group Message is a core feature of the Chat SDK that enables group members and app admins to send, receive, and manage various types of messages within groups. It supports real-time messaging, offline push notifications on major mobile platforms, message history retrieval, and system notifications. The feature includes a SEQ mechanism for message identification and allows app admins to send messages or system notifications without joining groups, facilitating efficient group communication and management.
- [Message Formats](https://pre.trtc.io/document/33527.md): Tencent Cloud Chat MsgBody API defines the structure for message content supporting multiple message elements such as text, location, emoji, custom, voice, image, file, and video. This documentation details the format of each TIMMsgElement type, their key fields, and usage scenarios for developers integrating Tencent Cloud Chat messaging capabilities.
- [Login Authentication](https://pre.trtc.io/document/33517.md): Login Authentication in the Chat SDK is a core feature that enables secure user login using UserID and UserSig credentials. This SDK, evolved from the QQ instant messaging system, is designed for app developers to integrate messaging capabilities. It supports a login process where UserSig is generated securely by the app server and has a configurable validity period. Additionally, the Chat SDK provides app admin roles with elevated permissions for managing groups and users, configurable through the console.
- [Online Status Management](https://pre.trtc.io/document/33518.md): Tencent Chat SDK provides an online status management system that categorizes user presence into Online, PushOnline, and Offline states. This SDK supports mobile, desktop, web, and mini program platforms, enabling real-time detection and notification of user status changes. It helps developers understand user connectivity, manage message delivery, and query user statuses via RESTful APIs to enhance communication reliability.
- [Group System](https://pre.trtc.io/document/33529.md): The Group System is an instant messaging SDK that enables multi-participant communication with robust group management features such as creation, disbanding, member and profile management. It supports stable messaging with permission controls, muting, callbacks, and message roaming. Various group types including Work, Public, Meeting, AVChatRoom, and Community cater to different use cases with member limits up to 100,000 and customizable options like custom IDs and fields. The system also defines distinct member roles with specific permissions to facilitate efficient group administration.
- [Group Management](https://pre.trtc.io/document/33530.md): Tencent Cloud Chat provides a comprehensive group management SDK that supports creating, transferring, and disbanding various default group types such as Work Group, Public group, Meeting Group, AVChatRoom, and Community. It enables users to manage group profiles including names, announcements, and custom fields, as well as handle group member information and roles. This guide is designed for developers integrating group communication features to efficiently manage group lifecycle and member data.
- [Profile Management](https://pre.trtc.io/document/33520.md): Chat Profile Management is a comprehensive user profile hosting service within Instant Messaging (Chat) that enables easy storage, reading, and writing of both standard and custom profile fields. It supports key-value formatted profile data with robust features such as remote disaster recovery, cross-region deployment, and auto scaling. This service is designed for app developers seeking stable and scalable user profile solutions with professional operation processes and APIs.
- [Relationship Chain Management](https://pre.trtc.io/document/33521.md): Chat Contacts System is a comprehensive SDK that manages user contacts including friend lists and blocklists. It is designed for app developers who want to integrate friend relationship features without maintaining complex backend logic. The system supports standard and custom contact fields, disaster recovery, multi-region deployment, and auto-scaling, ensuring stable service with 99.99% annual uptime. It enables adding, deleting, and managing up to 3,000 friends per user with flexible data fields and easy-to-use APIs.
- [Official channel](https://pre.trtc.io/document/60813.md): Official Account is a feature within Tencent RTC that offers subscription and publishing capabilities similar to WeChat's official accounts. It enables users to create and manage official accounts, publish articles and rich media messages, and interact with subscribers. The backend supports data management through REST API and third-party callbacks. This feature is available in the Enterprise plan with a Free plan option for limited usage. The data structure includes detailed fields for official account and subscriber information, as well as support for custom official account IDs.
- [WhatsApp Channel Implementation Guide](https://pre.trtc.io/document/69925.md): The WhatsApp Channel-style Official Account Integration Solution is a platform feature designed for businesses to efficiently create and manage official accounts, publish rich media content, and interact directly with subscribers. It addresses limitations of traditional instant messaging by supporting diverse content creation, subscriber management, and ongoing interaction. This solution is applicable for real-time information broadcast, brand promotion, convenient services, and local community guides. It provides multiple implementation modes including WeChat-Style, WhatsApp-Style, and Platform Official Account modes to suit different business needs.
- [Discord Implementation Guide](https://pre.trtc.io/document/53499.md): This guide introduces Tencent Cloud Chat SDK and API usage to implement Discord-like real-time messaging features. It covers creating Tencent Cloud Chat apps, understanding key configurations such as SDKAppID and webhook setup, and integrating client and server SDKs. The tutorial helps developers build community servers with channels, threads, and messaging capabilities similar to Discord, targeting gaming, education, and business communication scenarios.
- [How to Integrate Chat into Games](https://pre.trtc.io/document/52717.md): Tencent Cloud Chat SDK is a real-time messaging platform designed for game developers to integrate instant chat features into multiplayer games. This quickstart guide covers essential steps including UserSig calculation, admin account setup, callback configuration, and client SDK integration. It also explains how to implement common game chat functionalities such as user profiles, custom message types, and audio/video chat, helping developers efficiently build scalable and secure in-game communication.
- [AI Chatbot](https://pre.trtc.io/document/54925.md): Tencent Chat AI Chatbot Quickstart Guide helps developers integrate AI service capabilities into Tencent Chat using webhook features. It covers account creation, chatbot setup, webhook configuration, backend service development, and interaction with AI APIs to implement intelligent customer service, creative assistance, and work assistant functionalities.
- [Super Large Entertainment and Collaboration Community](https://pre.trtc.io/document/49713.md): Tencent Chat Community is a scalable messaging SDK designed for entertainment collaboration, supporting a hierarchical community-group-topic structure. It enables managing massive members with fine-grained permissions and delivers reliable messaging with over 99.99% success rate. The community facilitates user expansion, game-based social networking, fan marketing, and organizational communication. It also features advanced message push architecture and comprehensive message status controls. Integration requires the Chat native SDK Enhanced edition v6.2.2363 or later with Pro or Enterprise licenses.
- [End-to-end encrypted chat with Virgil](https://pre.trtc.io/document/53932.md)
- [Send Red Packet](https://pre.trtc.io/document/78288.md): Tencent Cloud Chat provides an SDK for implementing the Red Packet feature, enabling users to send and claim red packets in one-on-one and group chat scenarios. This guide details the overall architecture, core concepts like custom message fields, message extension data for claim records, and message modification for real-time status updates. It also covers integration with external payment and red packet systems to support the complete workflow of sending, claiming, and synchronizing red packet statuses.
- [Retail E-commerce Solution and Live Integration Guide](https://pre.trtc.io/document/78878.md): The Retail E-commerce Live Streaming Solution integrates Tencent RTC's Live and Chat SDKs to enable real-time audio and video interaction combined with online trading. Designed for developers, it addresses complex requirements including low-latency streaming, high concurrency communication, interactive messaging, and marketing event synchronization. The solution also includes advanced Beauty AR integration for enhanced anchor avatars and supports diverse business scenarios such as self-operated and cross-border e-commerce. It provides a comprehensive architecture covering live streaming, transaction management, marketing, customer service, and user domains to facilitate rapid and customizable e-commerce live streaming system development.
- [Firewall Restrictions](https://pre.trtc.io/document/78627.md): This guide explains how to configure firewall allowlist rules to ensure access to Chat services under network restrictions. It covers domain names, IP addresses, protocols, and ports required for Native SDK, Web SDK, and Rich Media across multiple global regions. These configurations help users maintain connectivity despite firewall limitations.
- [Best Practices for Web3 and FinTech Solutions](https://pre.trtc.io/document/81451.md): The Web3 and FinTech Real-Time Interaction Solution is a comprehensive SDK and service suite designed for developers in the financial and blockchain sectors. It addresses key real-time interaction needs such as live streaming, instant messaging, transcription, and translation, leveraging Tencent RTC's TRTC, Chat, and Push capabilities. This solution offers a standardized architecture and best practices to build scalable, multilingual, and compliant live streaming and messaging systems, supporting scenarios like crypto exchanges, social wallets, and investment advisory communities.
- [Migration Solutions](https://pre.trtc.io/document/55456.md): Tencent Cloud Chat migration solutions guide app developers through switching from old instant messaging systems to the new Tencent Cloud Chat service. It offers two main approaches: a mandatory upgrade that forces app version updates after data synchronization, and a compatibility solution allowing coexistence and real-time synchronization between old and new apps. The guide details importing accounts, user profiles, relationships, message histories, and synchronization steps to ensure seamless migration.
- [Migration Solutions Lite](https://pre.trtc.io/document/55457.md): Tencent Cloud Chat Migration Solutions Lite is a guide for app developers to smoothly transition from self-developed or third-party instant messaging services to Tencent Cloud Chat SDK. It outlines a simplified migration plan including simultaneous SDK integration, double writing of chat operations, backend control for display switching, and phased migration steps to minimize workload and ensure stability.
- [Privacy Policy](https://pre.trtc.io/document/71653.md): The Instant Messaging Chat Privacy Policy module outlines how personal information is collected, used, shared, stored, and retained for users of the Instant Messaging feature. It applies globally with optimizations for users in selected regions and covers data processing related to account registration, usage logs, monitoring, and configuration. The policy ensures compliance with legal requirements and supports service performance and improvement.
- [Data Privacy and Security Agreement](https://pre.trtc.io/document/71654.md): The Data Privacy and Security Agreement module for the Instant Messaging Chat feature outlines the processing of personal information and chat message records to provide the feature. It specifies data retention policies based on user preferences and applicable laws, service regions, sub-processors, and special conditions including age restrictions and prohibition of sensitive data processing. This agreement ensures compliance with data protection regulations for users of Tencent RTC's chat service.
- [Error Codes](https://pre.trtc.io/document/34348.md): The Chat SDK Error Codes document provides a comprehensive list of error codes encountered in the Tencent Cloud Chat SDK. It is designed for developers integrating the Chat SDK to identify and resolve common issues such as invalid parameters, local database errors, file handling problems, and API call frequency limits. Each error code includes a detailed description and recommended handling suggestions to facilitate efficient troubleshooting and ensure smooth SDK operation.

## Pricing

- [Billing Overview](https://pre.trtc.io/document/64149.md): Tencent RTC Billing Overview provides detailed information on the prepaid and pay-as-you-go billing models for Tencent RTC services, including Call, Conference, Live, RTC-engine, Chat, and Beauty AR. This guide explains the available monthly subscription and annual top-up prepaid packages, automatic renewal policies, and pay-as-you-go billing for usage exceeding prepaid balances. It helps users understand billing classifications and choose the appropriate plan for their business scenarios.
- [Starter Plan](https://pre.trtc.io/document/60294.md): Tencent Cloud Starter Plan is a subscription package designed for new users to access various Tencent Cloud products at a discounted rate for the first month. It supports multiple products such as Chat, RTC Engine, Call, Conference, Live, and Beauty AR, providing essential features with pay-as-you-go options and free trials. The plan is valid for one month from purchase and is limited to one purchase per product per account, helping new customers minimize initial project costs while exploring Tencent Cloud services.
- [Free Minutes](https://pre.trtc.io/document/42735.md): Tencent RTC Free Minutes is a monthly usage benefit for Tencent Cloud accounts with an active TRTC package, providing 10,000 free minutes for various audio and video services including calls, conferences, live streaming, and AI-powered features. This overview explains eligibility, usage deduction ratios by service type and resolution, expiration policies, and billing transitions when free minutes are exhausted. It helps users understand how free minutes apply to their TRTC usage and manage their package effectively.
- [Package Purchase, Renewal and Upgrade](https://pre.trtc.io/document/74514.md): Tencent Real-Time Communication (Tencent RTC) provides a comprehensive guide for purchasing, renewing, and upgrading service packages through the Tencent RTC Console. This guide is intended for users managing TRTC products who need to understand billing options, manual and auto-renewal processes, and upgrade paths to access enhanced features. It includes step-by-step instructions for binding applications, selecting package versions, completing payments, enabling or disabling auto-renewal, and upgrading packages to higher versions without service interruption.
- [Call Monthly Packages](https://pre.trtc.io/document/54632.md): TRTC Call (TUICallKit) is a multi-platform call SDK with a UI Kit that enables audio and video calling features including one-to-one and group calls. Designed for Android, iOS, web, and Flutter, it offers flexible billing through monthly packages and pay-as-you-go fees. This overview explains the cost structure, package usage rules, billing details, and a limited-time Starter Plan for new users to manage initial costs effectively.
- [Conference Monthly Packages](https://pre.trtc.io/document/59409.md): TRTC Conference (TUIRoomKit) is a multi-person audio and video chat SDK designed for scenarios like business meetings, webinars, and online education. This overview explains the pricing structure including monthly package fees and pay-as-you-go charges, MAU calculation rules, and package validity. It also highlights a limited-time Starter Plan offering 10,000 free minutes for new users. The guide helps users understand cost management and billing details for TRTC Conference features across applications.
- [Live Monthly Packages](https://pre.trtc.io/document/59407.md): TRTC Live (TUILiveKit) is a real-time interactive live streaming SDK that enables developers to integrate interactive live video streaming and voice room features into their apps on Android, iOS, Flutter, and Electron platforms. This overview explains the pricing structure including monthly package fees, pay-as-you-go charges, and MAU billing methods. It also details package validity, billing at the application level, and recommendations for managing subscriptions to ensure uninterrupted service.
- [RTC-Engine Monthly Packages](https://pre.trtc.io/document/56025.md): RTC-Engine monthly subscription packages provide prepaid access to audio/video call minutes and advanced TRTC features for individual applications. Designed for developers using TRTC applications, these packages unlock various service tiers including Free Trial, Lite, Standard, and Pro, each with different pricing, included minutes, and feature sets. The billing cycle spans one month from purchase, and a Starter Plan offers a special introductory offer for new users. Supported platforms include iOS, Android, Windows, Web, Electron, Flutter, and React Native.
- [Beauty AR Web Monthly Packages](https://pre.trtc.io/document/60214.md): Beauty AR SDK Web&H5 is an augmented reality SDK offering three monthly subscription packages—Standard, Professional, and Advanced—that provide various beauty and AR capabilities such as filters, makeup, stickers, and virtual backgrounds. Designed for web and H5 platforms, it supports domain-bound licensing with options for absolute and wildcard domains. This pricing guide helps users choose the right package based on their business needs and explains billing details including license binding, renewal, and usage restrictions.
- [Beauty AR Mobile Monthly Packages](https://pre.trtc.io/document/69949.md): The Beauty AR SDK for Mobile is a software development kit offering facial beautification and augmented reality effects, divided into Standard A series, Advanced S series, and Capabilities. It targets developers needing customizable beauty effects, stickers, makeup, and virtual backgrounds for mobile applications. This SDK supports flexible licensing options including monthly and annual purchases, providing scalable solutions for diverse beautification needs with detailed pricing and feature differentiation.
- [RTC Analytics Monthly Packages](https://pre.trtc.io/document/54481.md): RTC Analytics Monthly Packages is a subscription-based monitoring dashboard service that offers Room Call Investigation, Real-Time Monitoring, and Data Analytics Dashboard capabilities. Designed for users needing detailed call quality analysis and real-time data insights, it supports Standard and Premium editions with different data retention and latency features. This overview explains the package features, billing standards, and subscription management steps including how to subscribe and cancel.
- [Billing Explanation for Subscription Package Duration](https://pre.trtc.io/document/59806.md): Tencent Real-Time Communication (TRTC) subscription package duration billing overview explains how free monthly minutes are used to deduct TRTC audio and video usage. This prepaid package system applies to specific SDKAppIDs and is valid for one month from purchase. It details deduction order, expiration policies, pay-as-you-go charges for excess usage, and refund conditions. The document also clarifies deduction ratios based on media type and video resolution, helping users understand billing calculations and manage their package usage effectively.
- [RTC Engine Top-Up Package](https://pre.trtc.io/document/79594.md): The RTC Engine Top-Up Package is a prepaid usage minutes package for audio/video calls under the Tencent RTC platform. It is designed for users who have exhausted their free minutes or monthly packages, providing additional minutes valid for one year across all applications in the account. This package supports flexible billing with multiple stacking options and follows a clear deduction priority to manage usage efficiently.
- [Billing of Audio and Video Duration](https://pre.trtc.io/document/42734.md): Tencent Real-Time Communication (TRTC) billing documentation explains the audio and video duration billing model for RTC Engine, Call, Conference, and Live Audio Room components. It details daily pay-as-you-go billing, prepaid package usage, pricing by video resolution categories, and free usage quotas. This guide helps developers understand cost calculation, billing cycles, and additional fees for stream relaying and other TRTC services.
- [Billing of Video Live Component](https://pre.trtc.io/document/66078.md): The Video Live component by Tencent RTC is a live streaming SDK designed for large-scale single-room scenarios with millions of concurrent viewers. It offers duration-based billing that covers anchor and audience streaming times, as well as transcoding fees for multi-anchor setups. This overview explains the billing formulas, pricing tiers by resolution and codec, and usage statistics to help users understand cost calculation and manage their live streaming expenses effectively.
- [Billing of On-Cloud Recording and Recording Delivery](https://pre.trtc.io/document/45176.md): Tencent TRTC On-Cloud Recording is a cloud-based audio and video recording service that charges based on recording duration and video resolution. It is designed for developers using TRTC rooms to capture streams via recording robots. This overview explains the billing composition including subscription fees, usage calculation, pricing tiers for different video resolutions, and billing cycles. It also covers Web Page Recording and Recording Delivery components, providing a comprehensive understanding of TRTC recording service charges.
- [Billing of MixTranscoding and Relay to CDN](https://pre.trtc.io/document/47631.md): MixTranscoding is a Tencent RTC paid service that mixes, transcodes, and repackages multiple audio and video streams within a TRTC room. This overview explains the daily pay-as-you-go billing model based on input duration, including audio and video transcoding fees calculated by resolution and codec. It also covers relay fees for streaming to third-party CDNs and details on usage calculation and billing cycles.
- [Billing of Conversational AI Services](https://pre.trtc.io/document/67833.md): The Conversational AI service within Tencent RTC Engine provides real-time voice interaction between humans and large language models. This overview explains the billing components including audio call fees, Conversational AI service fees, and speech-to-text service fees. It targets developers and users integrating or utilizing Conversational AI, detailing free trial usage, monthly package options, and fee calculation methods. Integration guidance is also referenced for implementation.
- [Billing of Speech AI Service](https://pre.trtc.io/document/67832.md): This document provides billing instructions for Tencent RTC's Speech-to-Text, AI Real-Time Translation, and Text-to-Speech services. These postpaid services offer 10,000 free minutes monthly and support multiple languages for real-time audio transcription, multilingual translation, and natural speech synthesis. The guide details pricing, metering, and usage policies to help users understand cost management across these AI recognition capabilities.
- [Clould Slicing and Terminal Video Screenshot](https://pre.trtc.io/document/64803.md): Tencent Cloud Real-Time Communication (TRTC) offers Cloud Slicing and Terminal Video Screenshot SDKs designed for scenarios such as remote education, showroom streaming, and video conferencing. These features enable evidence collection, quality inspection, archiving, and replay by storing entire video call or live streaming processes. Cloud Slicing supports both audio slicing and video screenshot capabilities with billing based on usage duration, while Terminal Video Screenshot is available for Pro edition users with monthly billing. This overview explains pricing, billing formulas, usage statistics, and feature descriptions to help users understand and manage these services effectively.
- [TRTC Overdue and Suspension Policy](https://pre.trtc.io/document/56211.md): Tencent Cloud Real-Time Communication (TRTC) Overdue and Suspension Policy outlines the rules for handling account arrears, service suspension, and resource management for TRTC products including Call, Conference, Live, and RTC-engine. It is designed for Tencent Cloud customers to understand billing cycles, suspension impacts, and recovery options to maintain uninterrupted real-time audio and video services.
- [Chat Suspension Policy](https://pre.trtc.io/document/34352.md): Tencent Cloud Chat service suspension FAQ explains the policies and impacts of service suspension due to prepaid package expiration or account arrears. It guides users on how suspension affects Chat capabilities, resource retention and repossession timelines, and how to prevent suspension by monitoring account balance and renewing packages promptly.
- [FAQs](https://pre.trtc.io/document/42737.md): Tencent Real-Time Communication (TRTC) FAQs provide answers on billing methods, usage statistics, discounts, and package details for audio and video communication services. This guide helps users understand how to view bills, estimate costs using the price calculator, and explains how usage durations and Monthly Active Users (MAU) are calculated across multiple subscription packages.
- [TRTC Monthly Package Refund Instructions](https://pre.trtc.io/document/58588.md): Tencent RTC TRTC monthly package refund instructions provide a step-by-step guide on how users can request a refund within five days of purchase if the package remains unused. This guide explains the refund eligibility criteria, exceptions such as account suspension or usage of gifted call duration, and the procedure to submit a refund ticket via the Tencent Cloud Console. It ensures users understand the refund rules, including non-refundable discounts and the refund method.
- [Chat Monthly Package Refund Instructions](https://pre.trtc.io/document/55095.md): Tencent Cloud Chat refund policy FAQ explains the conditions under which users can request refunds for Chat resource plans or feature packs. It covers the five-day unconditional refund period, usage restrictions, refund calculation methods, and scenarios where refunds are not supported. This guide helps users understand how to manage refunds effectively and the impact of returns on service availability.

## Console Guide

- [Overview](https://pre.trtc.io/document/56765.md): Tencent Real-Time Communication (TRTC) Application Overview provides detailed information on managing applications within the TRTC platform. It is designed for developers and administrators to view and modify application details such as SDKAppID, SDKSecretKey, application version, and service status. The guide explains how to access application information, update names and descriptions, understand service states including normal and disabled, and manage subscription plans to unlock additional features based on business needs.
- [Creating Application](https://pre.trtc.io/document/39077.md): Tencent Real-Time Communication (TRTC) Console provides an application management SDK that enables users to create and manage multiple applications for distinct business projects. This guide explains how to create an application, including entering the application name, selecting the product and deployment region, and accessing key credentials like SDKAppID and SDKSecretKey. It also covers viewing and managing the application list with detailed information such as service status and deployment region, facilitating efficient project isolation and data management.
- [Function Configuration](https://pre.trtc.io/document/39080.md): Function Configuration in Tencent RTC enables users to activate Relay to CDN, On-Cloud Recording, and advanced permission control for their applications. This guide provides step-by-step instructions to enable, configure, switch domain names, and disable these features, helping users manage audio and video streaming and recording efficiently with Tencent Cloud CSS integration.
- [Callback Configuration](https://pre.trtc.io/document/39559.md): The Tencent RTC Event callback service SDK allows developers to configure webhook keys and URLs to receive real-time notifications of audio and video service events. This guide provides step-by-step instructions for setting up webhook configuration in the Tencent RTC console, including prerequisites and key actions to enable event callback notifications for room, media, recording, and relay events.
- [Package Management](https://pre.trtc.io/document/56766.md): Tencent Real-Time Communication (TRTC) Package Management is a console-based feature that allows users to view and manage their package usage and subscriptions. It supports different package types including Free Trial and monthly packages, providing detailed usage statistics and purchase options. This overview helps users understand how to monitor package status, renew subscriptions, and take advantage of discount campaigns to optimize their audio and video service usage.
- [Interactive Audio/Video](https://pre.trtc.io/document/39066.md): TRTC Interactive Audio/Video is a feature within the Tencent RTC console that offers real-time statistics and detailed consumption data for created applications. It is designed for developers and operators to monitor audio and video interaction usage, including paid and free usage, with data updated every five minutes. This helps users understand their application consumption and billing details accurately.
- [On-Cloud Recording](https://pre.trtc.io/document/39067.md): Tencent Real-Time Communication On-Cloud Recording usage statistics provide detailed insights into cloud recording usage based on recording duration. This overview helps users understand how to view usage data in the TRTC console, including application selection and time period filtering. Data updates every 5 minutes with a delay of up to 180 minutes, and durations are rounded for billing accuracy. Billing details are accessible via the Billing Center.
- [On-Cloud MixTranscoding](https://pre.trtc.io/document/44058.md): Tencent Real-Time Communication (TRTC) On-Cloud MixTranscoding consumption statistics provide detailed usage data for MCU cloud mixtranscoding services. This overview explains how users can view consumption details in the TRTC console, including data update frequency, usage duration calculation, and billing references. It is designed for developers and service users who need to monitor and manage their cloud-based mixed-stream transcoding consumption effectively.
- [Relay to CDN](https://pre.trtc.io/document/56767.md): The TRTC Relay to CDN feature is a bypass push service within the Tencent RTC platform. It is designed for users who need to monitor and analyze bandwidth usage and billing details related to content delivery network relay. This overview explains how to access usage statistics, interpret peak bandwidth data in five-minute and daily intervals, and estimate monthly costs based on detailed logs, with actual charges confirmed via the Billing Center.
- [Call List](https://pre.trtc.io/document/39069.md): Tencent RTC Call List is a monitoring dashboard feature that enables developers to view and analyze call details and user call statuses. It supports filtering calls by application, time period, room ID, or user ID, helping developers monitor call quality and user participation effectively.
- [Call Details](https://pre.trtc.io/document/39070.md): The Call Details page in the Tencent RTC monitoring dashboard provides comprehensive information about a specific call room. It is designed for users managing or analyzing call sessions, offering key data such as call room metadata, user roles and activity, SDK versions, device and network types, and detailed statistics on data transmission from both receiver and sender perspectives. This overview helps in understanding call performance and user participation within a selected time range.
- [End-to-End Details](https://pre.trtc.io/document/39071.md): Tencent RTC End-to-End Call Details provide comprehensive insights into data transmission between sender and receiver during audio and video calls. This overview helps users monitor network conditions and device performance, displaying detailed metrics such as video and audio packet loss, frame rates, resolutions, and control parameters. Accessible through the Tencent RTC Console, it supports troubleshooting and optimizing call quality by visualizing multi-dimensional data for both sender and receiver.
- [Real-Time Monitoring](https://pre.trtc.io/document/52069.md): Tencent Real-Time Communication (TRTC) real-time monitoring SDK provides a multi-dimensional, visualized platform to track application performance metrics such as online users, rooms, and quality indicators including video and audio stutter rates. Designed for developers and operators, this monitoring service enables timely detection and troubleshooting of issues with data updated every 10 to 20 seconds. Features include pausing data views, detailed scale and quality metrics, and downloadable room data, accessible through the Tencent RTC Console.
- [Data Insights](https://pre.trtc.io/document/67828.md): The Data Insights on RTC Analytics Data Dashboard is a paid SDK feature designed for application operators to monitor and analyze business operation scale and call quality metrics. It provides key operational metrics such as user counts, room counts, peak hour statistics, and multi-dimensional quality analysis including video and audio stutter rates. Users can filter data by application and time range, view trend charts, and export detailed reports to gain timely insights into call performance and operational trends.
- [UserSig Generation and Verification](https://pre.trtc.io/document/39074.md): UserSig Generation and Verification is a guide for using the TRTC console's Signature (UserSig) Generator and Verifier tools. It is designed for developers to quickly generate UserSig for testing purposes and verify its validity to ensure secure communication by preventing key leakage and unauthorized access. The guide includes step-by-step instructions for generating UserSig with a 180-day expiration and verifying UserSig by inputting UserID and signature details.
- [RTMP Address Generator](https://pre.trtc.io/document/67774.md): The TRTC console provides an RTMP Address Generator tool designed for testing streaming room entry. This quickstart guide helps users generate RTMP streaming addresses by selecting their application, entering the room name and user ID, and generating the address. It is intended for developers to quickly test streaming setups before deploying secure backend address generation for official use.