tencent cloud

Tencent Real-Time Communication

Release Notes and Announcements
Release Notes
Recent Product Announcement
TRTC Live (TUILiveKit) Product Launch Announcement
TRTC Conference Official Editions Launched
The commercial version of Conference is coming soon
Terms and Conditions Applicable to $9.9 Starter Package
Rules for the "First Subscription $100 Discount" Promotion
Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
TRTC Call Official Editions Launched
License Required for Video Playback in New Version of LiteAV SDK
TRTC to Offer Monthly Packages
Product Introduction
Overview
Concepts
Features
Strengths
Use Cases
Performance Statistics
Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!
Purchase Guide
Billing Overview
Free Minutes
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
FAQs
Refund Instructions
User Tutorial
Free Demo
Call
Overview
Activate the Service
Run Demo
Integration
Offline Call Push
Conversational Chat
On-Cloud Recording
AI Noise Reduction
UI Customization
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
Release Notes
FAQs
Conference
Overview（TUIRoomKit）
Activate the Service (TUIRoomKit)
Run Demo（TUIRoomKit）
Integration（TUIRoomKit）
Screen Sharing (TUIRoomKit)
Schedule a meeting (TUIRoomKit)
In-meeting Call (TUIRoomKit)
UI Customization（TUIRoomKit）
Virtual Background (TUIRoomKit)
Conference Control (TUIRoomKit)
Cloud Recording (TUIRoomKit)
AI Noise Reduction (TUIRoomKit)
In-Conference Chat (TUIRoomKit)
Robot Streaming (TUIRoomKit)
Enhanced Features (TUIRoomKit)
Client APIs (TUIRoomKit)
Server APIs (TUIRoomKit)
FAQs (TUIRoomKit)
Error Code (TUIRoomKit)
SDK Update Log (TUIRoomKit)
Live
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Run Demo
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDK Download
API Examples
Usage Guidelines
API Reference Manual
Advanced Features
AI Integration
Overview
Configure MCP Server
Install Skills
Integration Guide
FAQ
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
Console Guide
Application Management
Package Management
Usage Statistics
Monitoring Dashboard
Development Assistance
Solution
Real-Time Chorus
FAQs
Migration Guide
Billing
Features
UserSig
Firewall Restrictions
How to Downsize Installation Package
Android and iOS
Web
Flutter
Electron
TRTCCalling for Web
Audio and Video Quality
Others
Legacy Documentation
RTC RoomEngine SDK（Old）
Integrating TUIRoom (Web)
Integrating TUIRoom (Android)
Integrating TUIRoom (iOS)
Integrating TUIRoom (Flutter)
Integrating TUIRoom (Electron)
TUIRoom APIs
On-Cloud Recording and Playback (Old)
RTC Analytics Monthly Packages (Previous Version)
Protocols and Policies
Compliance
Security White Paper
Notes on Information Security
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC Policy
Privacy Policy
Data Processing And Security Agreement
Glossary
DocumentationTencent Real-Time CommunicationRTC RESTFUL APIAPI Category

API Category

PDF
Focus Mode
Font Size
Last updated: 2026-01-22 14:44:10

Room Management APIs

API Name Feature Frequency Limit (maximum requests per second)
RemoveUser Removes a user 20
SetUserBlocked Disables/Enables the audio and video of a user 20
SetUserBlockedByStrRoomId Disables/Enables the audio and video of a user (string-type room ID) 20
DismissRoom Dismisses a room 20
RemoveUserByStrRoomId Removes a user from a room (by room ID in string type) 20
DismissRoomByStrRoomId Closes a room (by room ID in string type) 20

Call Quality Monitoring APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeRoomInfo Queries the room list 20
DescribeUnusualEvent Queries abnormal user experiences 20
DescribeUserEvent Queries the events during a call 20
DescribeCallDetailInfo Queries the user list and call metrics 20
DescribeUserInfo Queries the user list 20
DescribeScaleInfo Queries the number of rooms and users 20

Stream mixing and relay APIs

API Name Feature Frequency Limit (maximum requests per second)
UpdatePublishCdnStream Changes relaying parameters 20
StartPublishCdnStream Starts a relaying task 20
StopPublishCdnStream Stops a relaying task 20

On-cloud recording APIs

API Name Feature Frequency Limit (maximum requests per second)
DeleteCloudRecording Stops an on-cloud recording task 20
DescribeCloudRecording Queries the status of a recording task 20
CreateCloudRecording Starts an on-cloud recording task 20
ModifyCloudRecording Modifies a recording task 20

Usage Statistics APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeTrtcUsage Queries TRTC audio/video duration 5
DescribeRecordingUsage Queries TRTC recording usage 5
DescribeMixTranscodingUsage Queries TRTC On-Cloud MixTranscoding usage 5
DescribeRelayUsage Queries TRTC relay to CDN usage 5
DescribeTrtcRoomUsage Queries usage data grouped by room -

Data Monitoring APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeTRTCRealTimeScaleData Query TRTC Monitoring Dashboard - Real-Time Monitoring Scale 20
DescribeTRTCRealTimeQualityData Query TRTC Monitoring Dashboard - Real-Time Monitoring Quality 20
DescribeTRTCMarketScaleData Query TRTC Monitoring Dashboard - Data Dashboard Scale Metrics 20
DescribeTRTCMarketQualityData Query TRTC Monitoring Dashboard - Data Dashboard Quality Metrics 20

Web Record APIs

API Name Feature Frequency Limit (maximum requests per second)
StartWebRecord Starts an web-page recording task 20
DescribeWebRecord Queries the status of a web-page recording task 20
StopWebRecord Stop an web-page recording task 20

API Name Feature Frequency Limit (maximum requests per second)
StopStreamIngest Stop Pull stream Relay 20
DescribeStreamIngest Query Relay Task 20
StartStreamIngest Start Pull stream Relay 20
UpdateStreamIngest Update Relay Task 20

AI Service APIs

API Name Feature Frequency Limit (maximum requests per second)
StartAIConversation Start AI conversation task 20
DescribeAIConversation Describe AI conversation 20
StopAIConversation Stop AI conversation task 20
DescribeAITranscription Describe AI Transcription 20
StopAITranscription Stop AI Transcription task 20
ControlAIConversation Control AI dialogue 50
StartAITranscription Start AI transcription task 50
UpdateAIConversation Update AI conversation task 20

Cloud Slicing APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateCloudSliceTask Creates a cloud slicing task 20
DeleteCloudSliceTask Stops a cloud slicing task 20
DescribeCloudSliceTask Queries information about cloud slicing tasks 20
ModifyCloudSliceTask Modifies a cloud slicing task 20

Cloud Moderation APIs

API Name Feature Frequency Limit (maximum requests per second)
DeleteCloudModeration Stops cloud moderation 20
DescribeCloudModeration Queries cloud moderation information 20
ModifyCloudModeration Modifies cloud moderation tasks 20
CreateCloudModeration Creates cloud moderation tasks 20
Previous Topic: IntroductionNext Topic: RemoveUser

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback