-
API概览 - 实时音视频 SparkRTC
API概览 华为云实时音视频服务对应的接口列表如下所示，在调用媒体处理API前，您需要先获取用户Token，Token可以用于调用其他API时鉴权，具体如何调用媒体处理API请参考应用示例。 应用管理接口 表1 应用管理接口 接口 说明 POST /v2/apps 创建应用 GET
-
如何调用API - 实时音视频 SparkRTC
如何调用API 构造请求 认证鉴权 返回结果
-
认证鉴权 - 实时音视频 SparkRTC
拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。
-
构造请求 - 实时音视频 SparkRTC
构造请求 本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token来说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987。
-
返回结果 - 实时音视频 SparkRTC
用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。
-
启动合流任务 - 实时音视频 SparkRTC
音频合流会动态选择最大三方的声音。 API触发合流录制流名规则：{jobtype}_{jobid}_{roomid}，其中jobtype取值为'm'代表合流录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
-
停用应用 - 实时音视频 SparkRTC
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后，新房间无法新增和加入，已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
-
获取项目ID - 实时音视频 SparkRTC
获取项目ID 调用API获取项目ID 您还能通过调用查询指定条件下的项目信息API获取项目ID。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
-
删除应用 - 实时音视频 SparkRTC
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
-
启用应用 - 实时音视频 SparkRTC
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
-
解散房间 - 实时音视频 SparkRTC
解散房间 功能介绍 调用此接口解散房间，将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/r
-
创建应用 - 实时音视频 SparkRTC
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps
-
应用示例 - 实时音视频 SparkRTC
应用示例 示例1：创建单流录制任务 示例2：创建合流录制任务
-
附录 - 实时音视频 SparkRTC
附录 状态码 错误码 获取项目ID 获取帐号ID 地区名称缩写 接收增值（录制）事件回调通知内容
-
查询实时规模分布 - 实时音视频 SparkRTC
功能介绍 对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{pro
-
查询单个应用 - 实时音视频 SparkRTC
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
-
停止合流任务 - 实时音视频 SparkRTC
停止合流任务 功能介绍 调用此接口停止已下发的合流转码任务。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/mix
-
踢除在线用户 - 实时音视频 SparkRTC
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms/{ro
-
查询自动录制配置 - 实时音视频 SparkRTC
查询自动录制配置 功能介绍 调用此接口查询自动录制配置 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/auto-record-mode
-
查询合流任务 - 实时音视频 SparkRTC
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
