阿里云OpenAPI开发者门户

音视频通信 - OpenAPI 概览2018-01-11
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
应用管理
OpenAPI 名称描述操作
DescribeAppshot查询应用列表查看文档去调试
DescribeAppKey查询指定应用的AppKey查看文档去调试
ModifyApphot修改指定应用的名称查看文档去调试
布局
OpenAPI 名称描述操作
CreateAppLayout新增app自定义布局查看文档去调试
DescribeAppLayouts查询app自定义布局查看文档去调试
DescribeSystemLayoutList系统内置布局查看文档去调试
ModifyAppLayout修改app自定义布局查看文档去调试
DeleteAppLayout删除app自定义布局查看文档去调试
回调管理
OpenAPI 名称描述操作
DescribeAppCallStatus查看app回调开关查看文档去调试
DescribeAllCallback列出系统支持的事件回调查看文档去调试
DescribeCallbacksapp事件回调列表查看文档去调试
DescribeAppCallbackSecretKey获取app回调密钥查看文档去调试
ModifyAppCallbackStatus更新app回调事件开关查看文档去调试
ModifyCallbackMeta更新app回调查看文档去调试
StartCategoryCallback开启某个事件回调查看文档去调试
StopCategoryCallback关闭某个事件回调查看文档去调试
频道管理
OpenAPI 名称描述操作
DescribeChannels本接口用于查询单AppId下的全部进行中的频道列表查看文档去调试
DescribeChannelAllUsers本接口用于查询频道内的用户列表查看文档去调试
DescribeChannelUser本接口用于查询用户在频道内的信息查看文档去调试
DescribeChannel本接口用于查询在线频道信息查看文档去调试
StopChannel本接口用于服务端主动关闭频道查看文档去调试
RemoveUsers本接口用于踢出频道内的用户查看文档去调试
云端录制
OpenAPI 名称描述操作
录制模板管理
CreateAppRecordTemplate增加应用录制模板查看文档去调试
DescribeAppRecordStatus查询应用录制开关查看文档去调试
DescribeAppRecordTemplates应用录制模板列表查看文档去调试
ModifyAppRecordStatus修改应用录制开关查看文档去调试
ModifyAppRecordTemplate修改应用录制模板查看文档去调试
DeleteAppRecordTemplate删除应用录制模板查看文档去调试
云端录制接口
DescribeAppRecordingFiles查询录制列表查看文档去调试
StartCloudRecordhot本接口用于开始云端录制任务查看文档去调试
UpdateCloudRecord更新云端录制任务查看文档去调试
StopCloudRecord本接口用于停止云端录制任务查看文档去调试
旁路推流
OpenAPI 名称描述操作
推流模板管理
CreateAppStreamingOutTemplate创建 RTC 3.0 应用推流模板查看文档去调试
DescribeAppLiveStreamStatus查看应用旁路开关查看文档去调试
DescribeAppStreamingOutTemplates查询 RTC 3.0 应用下的推流模板列表查看文档去调试
ModifyAppLiveStreamStatus修改应用旁路开关查看文档去调试
ModifyAppStreamingOutTemplate修改 RTC 3.0 应用推流模板查看文档去调试
DeleteAppStreamingOutTemplate删除 RTC 3.0 应用推流模板查看文档去调试
旁路推流接口
DescribeStreamingOutStatus查询旁路推流状态查看文档去调试
StartStreamingOut本接口用于开始旁路推流任务查看文档去调试
UpdateStreamingOut更新旁路推流任务查看文档去调试
StopStreamingOut本接口用于停止旁路推流任务查看文档去调试
纪要
OpenAPI 名称描述操作
DescribeCloudNotes纪要列表查看文档去调试
StartCloudNote开启智能纪要查看文档去调试
StopCloudNote停止智能纪要查看文档去调试
数据服务
OpenAPI 名称描述操作
通信监测
DescribeCallList分页查询时间范围内创建的通信信息查看文档去调试
DescribeCall本接口用于查询单次通信详情。例如:您可以查询通讯状态、用户详情等信息查看文档去调试
DescribePubUserListBySubUser本接口用于根据订阅端获取通信中发布端用户列表查看文档去调试
DescribeEndPointEventList本接口用于获取端对端用户事件列表查看文档去调试
DescribeEndPointMetricData本接口用于获取端对端指标数据查看文档去调试
DescribeQoeMetricData本接口用于获取单次通信中用户的下行体验质量指标查看文档去调试
频道数据
DescribeChannelOverallData本接口用于查询频道概览数据查看文档去调试
DescribeChannelDistributionStatData本接口用于获取频道分布统计数据查看文档去调试
DescribeChannelAreaDistributionStatData本接口用于获取频道地区分布统计数据查看文档去调试
DescribeChannelTopPubUserList本接口用于获取频道内发布端的用户列表(按用户在线时长降序)查看文档去调试
DescribeChannelUserMetrics本接口用于查询频道概览中的用户数据查看文档去调试
用量统计
DescribeUsageOverallData本接口用于获取用量统计的概览数据查看文档去调试
DescribeUsageDistributionStatData本接口用于获取用量统计的分布数据查看文档去调试
DescribeUsageAreaDistributionStatData本接口用于获取用量统计的地域分布数据查看文档去调试
DescribeUsageOsSdkVersionDistributionStatData本接口用于获取用量统计中各操作系统及SDK版本的分布数据查看文档去调试
质量统计
DescribeQualityOverallData本接口用于获取质量统计的概览数据查看文档去调试
DescribeQualityDistributionStatData本接口用于获取质量统计的分布数据查看文档去调试
DescribeQualityAreaDistributionStatData本接口用于获取质量统计的地域分布数据查看文档去调试
DescribeQualityOsSdkVersionDistributionStatData本接口用于获取质量统计中各操作系统及SDK版本的分布数据查看文档去调试
异常诊断
DescribeFaultDiagnosisOverallData获取异常诊断的概览数据查看文档去调试
DescribeFaultDiagnosisFactorDistributionStat获取异常诊断的影响因素分布查看文档去调试
DescribeFaultDiagnosisUserList获取异常诊断的用户明细列表查看文档去调试
DescribeFaultDiagnosisUserDetail获取异常诊断的用户详情查看文档去调试
RTC(旧版)
OpenAPI 名称描述操作
事件回调(旧版)
CreateEventSubscribehot创建订阅房间消息的回调查看文档去调试
DeleteEventSubscribe删除订阅房间消息的回调查看文档去调试
自动旁路单路转推规则(旧版)
CreateAutoLiveStreamRulehot创建自动旁路单路转推规则查看文档去调试
DescribeAutoLiveStreamRule查询自动旁路单路转推规则查看文档去调试
DisableAutoLiveStreamRule停用自动旁路单路转推规则查看文档去调试
EnableAutoLiveStreamRule开启自动旁路单路转推规则查看文档去调试
UpdateAutoLiveStreamRule修改自动旁路单路转推规则查看文档去调试
DeleteAutoLiveStreamRule删除自动旁路单路转推规则查看文档去调试
频道管理(旧版)
DescribeChannelParticipantshot查询频道在线用户列表,不包含详细信息查看文档去调试
DescribeUserInfoInChannel查询用户在频道中实时信息查看文档去调试
DescribeChannelUsers查询 Channel(频道)实时在线用户列表查看文档去调试
DeleteChannel删除频道查看文档去调试
RemoveTerminals将指定终端用户从频道踢出查看文档去调试
云端录制(旧版)
AddRecordTemplatehot添加录制配置模板查看文档去调试
DescribeRecordTemplates查询录制模板配置列表查看文档去调试
DescribeRecordFiles查询录制生成的文件列表查看文档去调试
UpdateRecordTemplate更新录制配置模板查看文档去调试
StartRecordTaskhot录制视频任务查看文档去调试
StopRecordTaskhot停止视频录制任务查看文档去调试
UpdateRecordTask更新录制视频任务查看文档去调试
DeleteRecordTemplate删除录制配置模板查看文档去调试
旁路转推(旧版)
GetMPUTaskStatus获取旁路转推任务状态查看文档去调试
StartMPUTaskhot开始旁路转推任务查看文档去调试
StopMPUTask停止旁路转推任务查看文档去调试
UpdateMPUTask更新旁路转推任务查看文档去调试
布局管理(旧版)
CreateMPULayout创建旁路直播布局查看文档去调试
DescribeMPULayoutInfoList获取旁路直播任务布局参数查看文档去调试
ModifyMPULayout修改旁路直播布局查看文档去调试
DeleteMPULayout删除旁路直播布局查看文档去调试
数据服务(旧版)
DescribeRtcDurationData获取应用在一段时间内按照音视频规格进行统计的累计通信时长查看文档去调试
DescribeRtcUserCntData查询应用在一段时间内的活跃用户数,即发生通信的用户终端数查看文档去调试
DescribeRtcPeakChannelCntData查询应用在指定时间内的并发频道峰值数量查看文档去调试
DescribeRtcChannelList获取频道通信记录列表查看文档去调试
DescribeRtcChannelMetric获取频道通信记录详情,支持查询近180天内的数据查看文档去调试