Starter Deal! First 3 month from only  $9.9 /month!
Starter Deal! First 3 month from only  $9.9 /month!
Grab It Now 
Features & Server APIs
  • On-Cloud Recording
  • Relay to CDN
  • RTMP Streaming with TRTC
  • Event Callbacks
    • Event Callbacks
    • Relay to CDN Callback
    • Verify Signature Example
  • Sending and Receiving Messages
  • Access Management
    • Overview
    • Manageable Resources and Actions
    • Preset Policies
    • Custom Policies
  • Enabling Advanced Permission Control
  • How to push stream to TRTC room with OBS WHIP
  • Server APIs
    • API Category
    • History
    • Making API Request
      • Request Structure
      • Common Params
      • Signature v3
      • Signature
      • Responses
    • Room Management APIs
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • Call Quality Monitoring APIs
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • Pull Stream Relay Related Interface
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • On-cloud Recording APIs
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • Stream Mixing and Relay APIs
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • Usage Statistics APIs
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • Data Types
    • Error Codes
    • Appendix
      • Event ID Mapping Table
Features & Server APIs

API Category

Room Management APIs

API NameFeatureFrequency Limit (maximum requests per second)
RemoveUserRemoves a user20
SetUserBlockedDisables/Enables the audio and video of a user20
SetUserBlockedByStrRoomIdDisables/Enables the audio and video of a user (string-type room ID)20
DismissRoomDismisses a room20
RemoveUserByStrRoomIdRemoves a user from a room (by room ID in string type)20
DismissRoomByStrRoomIdCloses a room (by room ID in string type)20

Call Quality Monitoring APIs

API NameFeatureFrequency Limit (maximum requests per second)
DescribeRoomInfoQueries the room list20
DescribeUnusualEventQueries abnormal user experiences20
DescribeUserEventQueries the events during a call20
DescribeCallDetailInfoQueries the user list and call metrics20
DescribeUserInfoQueries the user list20
DescribeScaleInfoQueries the number of rooms and users20

Stream mixing and relay APIs

API NameFeatureFrequency Limit (maximum requests per second)
StartPublishCdnStreamStarts a relaying task20
UpdatePublishCdnStreamChanges relaying parameters20
StopPublishCdnStreamStops a relaying task20

On-cloud recording APIs

API NameFeatureFrequency Limit (maximum requests per second)
CreateCloudRecordingStarts an on-cloud recording task20
DeleteCloudRecordingStops an on-cloud recording task20
DescribeCloudRecordingQueries the status of a recording task20
ModifyCloudRecordingModifies a recording task20

Usage Statistics APIs

API NameFeatureFrequency Limit (maximum requests per second)
DescribeTrtcUsageQueries TRTC audio/video duration5
DescribeRecordingUsageQueries TRTC recording usage5
DescribeMixTranscodingUsageQueries TRTC On-Cloud MixTranscoding usage5
DescribeRelayUsageQueries TRTC relay to CDN usage5
DescribeTrtcRoomUsageQueries usage data grouped by room-

Data Monitoring APIs

API NameFeatureFrequency Limit (maximum requests per second)
DescribeTRTCRealTimeScaleDataQuery TRTC Monitoring Dashboard - Real-Time Monitoring Scale20
DescribeTRTCRealTimeQualityDataQuery TRTC Monitoring Dashboard - Real-Time Monitoring Quality20
DescribeTRTCMarketScaleDataQuery TRTC Monitoring Dashboard - Data Dashboard Scale Metrics20
DescribeTRTCMarketQualityDataQuery TRTC Monitoring Dashboard - Data Dashboard Quality Metrics20

API NameFeatureFrequency Limit (maximum requests per second)
StartStreamIngestStart Pull stream Relay20
StopStreamIngestStop Pull stream Relay20
DescribeStreamIngestQuery Relay Task20