API标准及多语言预置SDK
本产品（rtc/2018-01-11）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
应用管理
|
API |
标题 |
API概述 |
| ModifyApp | 修改指定应用名称 | 调用ModifyApp修改指定应用的名称。 |
| DescribeApps | 查询应用列表 | 调用DescribeApps查询应用列表。 |
| DescribeAppKey | 查询指定应用AppKey | 调用DescribeAppKey查询指定应用的AppKey。 |
布局
|
API |
标题 |
API概述 |
| CreateAppLayout | 新增自定义布局 | 新增app自定义布局 |
| ModifyAppLayout | 修改自定义布局 | 修改app自定义布局 |
| DeleteAppLayout | 删除自定义布局 | 删除app自定义布局 |
| DescribeAppLayouts | 查询自定义布局列表 | 查询app自定义布局 |
| DescribeSystemLayoutList | 查询系统内置布局列表 | 系统内置布局 |
回调管理
|
API |
标题 |
API概述 |
| DescribeAppCallStatus | 查询应用回调状态 | 查看app回调开关 |
| ModifyAppCallbackStatus | 修改应用回调状态 | 更新app回调事件开关 |
| DescribeAllCallback | 系统回调支持的所有事件 | 列出系统支持的事件回调 |
| DescribeCallbacks | 查询应用回调列表 | app事件回调列表 |
| DescribeAppCallbackSecretKey | 查询回调密钥 | 获取app回调密钥 |
| ModifyCallbackMeta | 修改应用回调 | 更新app回调 |
| StartCategoryCallback | 开启某个事件回调 | 开启某个事件回调 |
| StopCategoryCallback | 关闭某个事件回调 | 关闭某个事件回调 |
频道管理
|
API |
标题 |
API概述 |
| DescribeChannels | 查询在线频道列表 | 本接口用于查询单AppId下的全部进行中的频道列表。 |
| StopChannel | 关闭频道 | 本接口用于服务端主动关闭频道。 |
| DescribeChannelAllUsers | 查询频道内在线用户 | 本接口用于查询频道内的用户列表。 |
| DescribeChannelUser | 查询用户在频道内的信息 | 本接口用于查询用户在频道内的信息。 |
| DescribeChannel | 查询在线频道信息 | 本接口用于查询在线频道信息。 |
| RemoveUsers | 踢出用户 | 本接口用于踢出频道内的用户。 |
云端录制
|
API |
标题 |
API概述 |
| 录制模板管理 | 录制模板管理 | |
| DescribeAppRecordStatus | 查询录制功能状态 | 查询应用录制开关 |
| ModifyAppRecordStatus | 修改录制功能状态 | 修改应用录制开关 |
| CreateAppRecordTemplate | 新增录制模板 | 增加应用录制模板 |
| ModifyAppRecordTemplate | 修改录制模板 | 修改应用录制模板 |
| DeleteAppRecordTemplate | 删除录制模板 | 删除应用录制模板 |
| DescribeAppRecordTemplates | 查询录制模板列表 | 应用录制模板列表 |
| 云端录制接口 | 云端录制接口 | |
| DescribeCloudRecordStatus | 查询录制状态 | 查询录制任务状态 |
| DescribeAppRecordingFiles | 录制文件列表 | 查询录制列表 |
| StartCloudRecord | 开始云端录制任务 | 本接口用于开始云端录制任务。 |
| UpdateCloudRecord | 更新云端录制任务 | 更新云端录制任务 |
| StopCloudRecord | 停止云端录制任务 | 本接口用于停止云端录制任务。 |
旁路推流
|
API |
标题 |
API概述 |
| 推流模板管理 | 推流模板管理 | |
| DescribeAppLiveStreamStatus | 查询旁路推流功能状态 | 查看应用旁路开关 |
| ModifyAppLiveStreamStatus | 修改旁路推流功能状态 | 修改应用旁路开关 |
| CreateAppStreamingOutTemplate | 创建推流模板 | 创建 RTC 3.0 应用推流模板。 |
| ModifyAppStreamingOutTemplate | 修改推流模板 | 修改 RTC 3.0 应用推流模板。 |
| DeleteAppStreamingOutTemplate | 删除推流模板 | 删除 RTC 3.0 应用推流模板。 |
| DescribeAppStreamingOutTemplates | 查询推流模板列表 | 查询 RTC 3.0 应用下的推流模板列表。 |
| 旁路推流接口 | 旁路推流接口 | |
| DescribeStreamingOutStatus | 查询旁路推流状态 | 查询旁路推流状态 |
| StartStreamingOut | 开始旁路推流任务 | 本接口用于开始旁路推流任务。 |
| UpdateStreamingOut | 更新旁路推流任务 | 更新旁路推流任务 |
| StopStreamingOut | 停止旁路推流任务 | 本接口用于停止旁路推流任务。 |
纪要
|
API |
标题 |
API概述 |
| 热词表 | 热词表 | |
| CreateCloudNotePhrases | 创建热词表 | 增加纪要热词表 |
| ModifyCloudNotePhrases | 修改热词表 | 更新纪要热词表 |
| DescribeCloudNotePhrases | 热词表列表 | 纪要热词列表 |
| DeleteCloudNotePhrases | 删除热词表 | 删除纪要热词表 |
| StartCloudNote | 开始纪要任务 | 开启智能纪要 |
| StopCloudNote | 停止纪要任务 | 停止智能纪要 |
| DescribeCloudNotes | 纪要文件列表 | 纪要列表 |
智能体
|
API |
标题 |
API概述 |
| 智能体模版管理 | 智能体模版管理 | |
| DescribeAppAgentFunctionStatus | 查询智能体功能开关 | 查询应用智能体开关 |
| ModifyAppAgentFunctionStatus | 修改智能体功能开关 | 修改应用智能体开关 |
| ModifyAppAgentTemplate | 修改智能体模板 | 更新应用智能体模版 |
| DescribeAppAgentTemplates | 查询智能体模版列表 | 应用智能体模版列表 |
| DeleteAppAgentTemplate | 删除智能体模版 | 删除应用智能体模版 |
| CreateAppAgentTemplate | 创建智能体模版 | 创建应用智能体模版 |
| 智能体接口 | 智能体接口 | |
| StartAgent | 启动智能体 | 启动AI Agent |
| GetAgent | 查询智能体状态 | GetAgent。 |
| UpdateAgent | 更新智能体 | 更新AI Agent |
| NotifyAgent | 自定义消息播报 | NotifyAgent |
| StopAgent | 关闭智能体 | 停止AI Agent |
SIP
|
API |
标题 |
API概述 |
| 合流模版管理 | 合流模版管理 | |
| DescribeAppViewStatus | 查询合流功能状态 | 查看合流开关 |
| ModifyAppViewStatus | 修改合流功能状态 | 修改合流开关 |
| CreateAppViewTemplate | 创建合流模版 | 创建应用合流模版 |
| ModifyAppViewTemplate | 修改合流模板 | 更新应用合流模版 |
| DescribeAppViewTemplates | 合流模板列表 | 应用合流模版列表 |
| DeleteAppViewTemplate | 删除合流模板 | 删除应用合流模版 |
| 任务接口 | 任务接口 | |
| RtcSipInviteMember | Sip邀请入会 | 邀请SIP加入频道 |
| RtcCancelSipInvite | Sip取消外呼 | 取消Sip邀请 |
| StartView | 开启合流 | 开始合流 |
| StopView | 停止合流 | 停止合流 |
| RtcSipMute | Sip端开关麦克风控制 | Mute操作 |
| ModifyViewLayout | 编辑合流布局 | 设置合流布局 |
| ModifyStreamingProperty | 修改Sip流配置 | 设置流属性 |
数据服务
|
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获取异常诊断的用户详情。 |
RTC（旧版）
|
API |
标题 |
API概述 |
| 频道管理（旧版） | 频道管理（旧版） | |
| DeleteChannel | 删除频道 | 调用DeleteChannel删除频道。 |
| DescribeChannelParticipants | 查询频道在线用户列表 | 查询频道在线用户列表，不包含详细信息。 |
| DescribeChannelUsers | 查询实时在线用户列表 | 查询 Channel（频道）实时在线用户列表。 |
| RemoveTerminals | 将指定终端用户从频道踢出 | 调用RemoveTerminals将指定终端用户从频道踢出。 |
| 旁路转推（旧版） | 旁路转推（旧版） | |
| GetMPUTaskStatus | 获取任务状态 | 调用GetMPUTaskStatus获取旁路转推任务状态。 |
该文章对您有帮助吗？