- Release Notes and Announcements
- Release Notes
- 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
- Purchase Guide
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Run Demo（TUICallKit）
- Integration (TUICallKit)
- Calls integration to Chat (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- AI Noise Reduction (TUICallKit)
- Virtual Background (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Solution (TUICallKit)
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode(TUICallKit)
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Overview（TUIRoomKit）
- Activate the Service (TUIRoomKit)
- Run Demo（TUIRoomKit）
- Integration（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 Streaming (Including UI)
- Overview (TUILiveKit)
- Activating the Service (TUILiveKit)
- Run Demo（TUILiveKit）
- Integration (TUILiveKit)
- Customizable Interface (TUILiveKit)
- Start Broadcasting and Watch (TUILiveKit)
- Room List (TUILiveKit)
- Follow Anchors (TUILiveKit)
- Anchor connection (TUILiveKit)
- Host Competition (TUILiveKit)
- Mic Connect (TUILiveKit)
- Interactive Bullet Comments (TUILiveKit)
- Interactive Gifts (TUILiveKit)
- Gift Effects (TUILiveKit)
- Beauty Effects (TUILiveKit)
- Floating Window (TUILiveKit)
- Client APIs (TUICallKit)
- Server APIs (TUILiveKit)
- Error Codes (TUILiveKit)
- Release Notes（TUILiveKit）
- FAQs（TUILiveKit）
- Voice Chat Room (with UI)
- Overview (TUILiveKit)
- Activating the Service (TUILiveKit)
- Run Demo（TUILiveKit）
- Integration (TUILiveKit)
- Customizable Interface (TUILiveKit)
- Start Broadcasting and Watch (TUILiveKi
- Microphone Position Management (TUILiveKit)
- Room List (TUILiveKit)
- Follow Anchors (TUILiveKit)
- Interactive Bullet Comments (TUILiveKit)
- Interactive Gifts (TUILiveKit)
- Gift Effects (TUILiveKit)
- Client APIs (TUICallKit)
- Server APIs (TUILiveKit)
- Error Codes (TUILiveKit)
- Release Notes（TUILiveKit）
- FAQs（TUILiveKit）
- Integration (No UI)
- SDK Download
- API Examples
- API Usage Guidelines
- API Reference Manual
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- Push Media Stream into TRTC
- Speech-to-Text
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- Enable Watermark
- How to push stream to TRTC room with OBS WHIP
- Video Screenshot Upload
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Protocols and Policies
- TRTC Policy
- Glossary
- Release Notes and Announcements
- Release Notes
- 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
- Purchase Guide
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Run Demo（TUICallKit）
- Integration (TUICallKit)
- Calls integration to Chat (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- AI Noise Reduction (TUICallKit)
- Virtual Background (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Solution (TUICallKit)
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode(TUICallKit)
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Overview（TUIRoomKit）
- Activate the Service (TUIRoomKit)
- Run Demo（TUIRoomKit）
- Integration（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 Streaming (Including UI)
- Overview (TUILiveKit)
- Activating the Service (TUILiveKit)
- Run Demo（TUILiveKit）
- Integration (TUILiveKit)
- Customizable Interface (TUILiveKit)
- Start Broadcasting and Watch (TUILiveKit)
- Room List (TUILiveKit)
- Follow Anchors (TUILiveKit)
- Anchor connection (TUILiveKit)
- Host Competition (TUILiveKit)
- Mic Connect (TUILiveKit)
- Interactive Bullet Comments (TUILiveKit)
- Interactive Gifts (TUILiveKit)
- Gift Effects (TUILiveKit)
- Beauty Effects (TUILiveKit)
- Floating Window (TUILiveKit)
- Client APIs (TUICallKit)
- Server APIs (TUILiveKit)
- Error Codes (TUILiveKit)
- Release Notes（TUILiveKit）
- FAQs（TUILiveKit）
- Voice Chat Room (with UI)
- Overview (TUILiveKit)
- Activating the Service (TUILiveKit)
- Run Demo（TUILiveKit）
- Integration (TUILiveKit)
- Customizable Interface (TUILiveKit)
- Start Broadcasting and Watch (TUILiveKi
- Microphone Position Management (TUILiveKit)
- Room List (TUILiveKit)
- Follow Anchors (TUILiveKit)
- Interactive Bullet Comments (TUILiveKit)
- Interactive Gifts (TUILiveKit)
- Gift Effects (TUILiveKit)
- Client APIs (TUICallKit)
- Server APIs (TUILiveKit)
- Error Codes (TUILiveKit)
- Release Notes（TUILiveKit）
- FAQs（TUILiveKit）
- Integration (No UI)
- SDK Download
- API Examples
- API Usage Guidelines
- API Reference Manual
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- Push Media Stream into TRTC
- Speech-to-Text
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- Enable Watermark
- How to push stream to TRTC room with OBS WHIP
- Video Screenshot Upload
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Protocols and Policies
- TRTC Policy
- Glossary
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) |
|---|---|---|
| StartPublishCdnStream | Starts a relaying task | 20 |
| UpdatePublishCdnStream | Changes relaying parameters | 20 |
| StopPublishCdnStream | Stops a relaying task | 20 |
On-cloud recording APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateCloudRecording | Starts an on-cloud recording task | 20 |
| DeleteCloudRecording | Stops an on-cloud recording task | 20 |
| DescribeCloudRecording | Queries the status of a 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 |
Pull stream Relay Related interface
| 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 Transcription 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 |
| StartAITranscription | Start AI transcription task | 20 |
| DescribeAITranscription | Describe AI Transcription | 20 |
| StopAITranscription | Stop AI Transcription task | 20 |
| ControlAIConversation | Control AI Conversation task | 20 |
| UpdateAIConversation | Update AI conversation task | 20 |
Yes
No
Was this page helpful?