API 概览

最近更新时间:2024-11-05 02:22:18

我的收藏

房间管理相关接口

接口名称 接口功能 频率限制(次/秒)
RemoveUser 移出用户 20
DismissRoom 解散房间 20
RemoveUserByStrRoomId 移出用户(字符串房间号) 20
DismissRoomByStrRoomId 解散房间(字符串房间号) 20

通话质量监控相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeRoomInfo 查询历史房间列表 20
DescribeUnusualEvent 查询异常体验事件 20
DescribeUserEvent 查询详细事件 20
DescribeCallDetailInfo 查询历史用户列表与通话指标 20
DescribeUserInfo 查询历史用户列表 20
DescribeScaleInfo 查询历史房间和用户数 20

转推相关接口

接口名称 接口功能 频率限制(次/秒)
StartPublishCdnStream 启动转推任务 20
UpdatePublishCdnStream 更新转推任务 20
StopPublishCdnStream 停止转推任务 20

云端录制相关接口

接口名称 接口功能 频率限制(次/秒)
CreateCloudRecording 开始云端录制 20
DeleteCloudRecording 停止云端录制任务 20
DescribeCloudRecording 查询云端录制状态 20
ModifyCloudRecording 更新云端录制任务 20

用量统计相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeTrtcUsage 查询TRTC音视频用量 5
DescribeRecordingUsage 查询TRTC录制用量 5
DescribeMixTranscodingUsage 查询TRTC混流转码用量 5
DescribeRelayUsage 查询TRTC旁路转推用量 5
DescribeRecordStatistic 查询云端录制计费时长(旧) 20
DescribeTrtcRoomUsage 查询TRTC音视频房间维度用量 -

监控仪表盘查询相关接口

接口名称 接口功能 频率限制(次/秒)
DescribeTRTCRealTimeScaleData 查询TRTC实时监控规模数据 20
DescribeTRTCRealTimeQualityData 查询TRTC实时监控质量数据 20
DescribeTRTCMarketScaleData 查询TRTC数据大盘规模数据 20
DescribeTRTCMarketQualityData 查询TRTC数据大盘质量相关数据 20

其他接口

接口名称 接口功能 频率限制(次/秒)
DescribeTrtcMcuTranscodeTime 查询旁路转码计费时长(旧) 20
DescribeTRTCRealTimeScaleMetricData 查询TRTC实时监控规模指标 20
DescribeTRTCRealTimeQualityMetricData 查询TRTC实时监控质量指标 20
DescribeTRTCMarketScaleMetricData 查询TRTC数据大盘规模指标 20
DescribeTRTCMarketQualityMetricData 查询TRTC数据大盘质量指标 20

输入在线媒体流相关接口

接口名称 接口功能 频率限制(次/秒)
StartStreamIngest 开启输入在线媒体流 20
StopStreamIngest 停止输入在线媒体流 20
DescribeStreamIngest 查询输入在线媒体流 20
UpdateStreamIngest 更新输入在线媒体流 20

页面录制相关接口

接口名称 接口功能 频率限制(次/秒)
StartWebRecord 开始页面录制 20
DescribeWebRecord 查询页面录制 20
StopWebRecord 停止页面录制 20

AI服务相关接口

接口名称 接口功能 频率限制(次/秒)
StartAIConversation 开始AI对话任务 20
DescribeAIConversation 查询AI对话状态 20
StopAIConversation 停止AI对话 20
StartAITranscription 开始AI转录任务 20
DescribeAITranscription 查询AI转录任务状态 20
StopAITranscription 停止AI转录任务 20
ControlAIConversation 控制AI对话 20
UpdateAIConversation 更新AI对话 20

旧版相关接口

接口名称 接口功能 频率限制(次/秒)
StartMCUMixTranscode 启动云端混流(旧) 20
StopMCUMixTranscode 结束云端混流(旧) 20
StartMCUMixTranscodeByStrRoomId 启动云端混流(字符串房间号)(旧) 20
StopMCUMixTranscodeByStrRoomId 结束云端混流(字符串房间号) 20
CreatePicture 上传图片 20
ModifyPicture 修改图片 20
DescribePicture 查询图片 20
DeletePicture 删除图片 20
注意:

以上给出的接口频率限制维度为API + 接入地域 + 子账号,有关限频更多说明参考:API 频率限制说明