API Category
Last updated: 2025-11-19 14:42:28
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) |
|---|---|---|
| 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 |
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 |
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 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 |
| StartAITranscription | Start AI transcription task | 50 |
| ControlAIConversation | Control AI Conversation task | 20 |
| 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 |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback