API概览_音视频通信(RTC)-阿里云帮助中心

本产品（音视频通信/2018-01-11）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

应用管理

API	标题	API概述
ModifyApp	修改指定应用名称	调用ModifyApp修改指定应用的名称。
DescribeApps	查询应用列表	调用DescribeApps查询应用列表。
DescribeAppKey	查询指定应用AppKey	调用DescribeAppKey查询指定应用的AppKey。

频道管理

API	标题	API概述
StopChannel	关闭频道	本接口用于服务端主动关闭频道。
DescribeChannelAllUsers	查询频道内在线用户	本接口用于查询频道内的用户列表。
DescribeChannelUser	查询用户在频道内的信息	本接口用于查询用户在频道内的信息。
DescribeChannel	查询在线频道信息	本接口用于查询在线频道信息。
RemoveUsers	踢出用户	本接口用于踢出频道内的用户。

云端录制

API	标题	API概述
StartCloudRecord	开始云端录制任务	本接口用于开始云端录制任务。
StopCloudRecord	停止云端录制任务	本接口用于停止云端录制任务。

旁路转推

API	标题	API概述
推流模板管理	推流模板管理
ModifyAppStreamingOutTemplate	修改推流模板	修改 RTC 3.0 应用推流模板。
DeleteAppStreamingOutTemplate	删除推流模板	删除 RTC 3.0 应用推流模板。
CreateAppStreamingOutTemplate	创建推流模板	创建 RTC 3.0 应用推流模板。
DescribeAppStreamingOutTemplates	查询推流模板列表	查询 RTC 3.0 应用下的推流模板列表。
StartStreamingOut	开始旁路推流任务	本接口用于开始旁路推流任务。
StopStreamingOut	停止旁路推流任务	本接口用于停止旁路推流任务。

数据服务

API	标题	API概述
通信监测	通信监测
DescribeCallList	分页查询时间范围内通信信息	调用DescribeCallList分页查询时间范围内创建的通信信息。
DescribeCall	查询单次通信详情	本接口用于查询单次通信详情。例如：您可以查询通讯状态、用户详情等信息。
DescribePubUserListBySubUser	订阅端获取通信中发布端用户列表	本接口用于根据订阅端获取通信中发布端用户列表。
DescribeEndPointEventList	获取端对端用户事件列表	本接口用于获取端对端用户事件列表。
DescribeEndPointMetricData	获取端对端指标数据	本接口用于获取端对端指标数据。
DescribeQoeMetricData	单次通信中下行体验质量指标	本接口用于获取单次通信中用户的下行体验质量指标。
频道数据	频道数据
DescribeChannelOverallData	查询频道概览数据	本接口用于查询频道概览数据。
DescribeChannelDistributionStatData	获取频道分布统计数据	本接口用于获取频道分布统计数据。
DescribeChannelAreaDistributionStatData	获取频道地区分布统计数据	本接口用于获取频道地区分布统计数据。
DescribeChannelTopPubUserList	获取频道内发布端的用户列表	本接口用于获取频道内发布端的用户列表（按用户在线时长降序）。
DescribeChannelUserMetrics	查询频道概览中的用户数据	本接口用于查询频道概览中的用户数据。
用量统计	用量统计
DescribeUsageOverallData	获取用量统计的概览数据	本接口用于获取用量统计的概览数据。
DescribeUsageDistributionStatData	获取用量统计的分布数据	本接口用于获取用量统计的分布数据。
DescribeUsageAreaDistributionStatData	获取用量统计的地域分布数据	本接口用于获取用量统计的地域分布数据。
DescribeUsageOsSdkVersionDistributionStatData	用量操作系统及SDK版本分布	本接口用于获取用量统计中各操作系统及SDK版本的分布数据。
质量统计	质量统计
DescribeQualityOverallData	获取质量统计的概览数据	本接口用于获取质量统计的概览数据。
DescribeQualityDistributionStatData	获取质量统计的分布数据	本接口用于获取质量统计的分布数据。
DescribeQualityAreaDistributionStatData	获取质量统计的地域分布数据	本接口用于获取质量统计的地域分布数据。
DescribeQualityOsSdkVersionDistributionStatData	质量各操作系统及SDK版本分布	本接口用于获取质量统计中各操作系统及SDK版本的分布数据。
异常诊断	异常诊断
DescribeFaultDiagnosisOverallData	获取异常诊断的概览数据	调用DescribeFaultDiagnosisOverallData获取异常诊断的概览数据。
DescribeFaultDiagnosisFactorDistributionStat	获取异常诊断的影响因素分布	调用DescribeFaultDiagnosisFactorDistributionStat获取异常诊断的影响因素分布。
DescribeFaultDiagnosisUserList	获取异常诊断的用户明细列表	调用DescribeFaultDiagnosisUserList获取异常诊断的用户明细列表。
DescribeFaultDiagnosisUserDetail	获取异常诊断的用户详情	调用DescribeFaultDiagnosisUserDetail获取异常诊断的用户详情。