高级功能与服务端 API
  • 云端录制
  • 音视频流推至CDN
  • 通过 TRTC 实现与 RTMP 互通
  • 服务端事件回调
    • 房间与媒体回调
    • 旁路转推回调
    • 云端录制回调
    • 签名校验示例
  • 发送和接收消息
  • 访问管理
    • 产品概述
    • 可授权的资源及操作
    • 预设策略
    • 自定义策略
  • 启用高级权限控制
  • 如何通过 OBS WHIP 推流至 TRTC 房间
  • 服务端 API
    • 接口分类
    • 历史记录
    • 发出接口请求
      • 请求结构
      • 通用参数
      • 签名方法 v3
      • 签名
      • 回复
    • 房间管理接口
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • 通话质量监控接口
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • 输入在线媒体流相关接口
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • 云端录制接口
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • 混流转推相关接口
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • 用量统计相关接口
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • 数据类型
    • 错误码
    • 附录
      • 事件 ID 映射表
当前内容仅提供英语版本,中文版我们将尽快补充,感谢您的理解。

接口分类

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