检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后，新房间无法新增和加入，已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能
状态码 调用实时音视频API时，可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
解散房间 功能介绍 调用此接口解散房间，将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2
错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 RTC.00001001 OperationUnauthorized: get DomainID fail please check X-Auth-Token
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
获取账号ID 在调用接口的时候，部分URL中需要填入账号ID，所以需要先在管理控制台上获取到账号ID。具体获取步骤如下： 登录管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中“我的凭证”。 在“API凭证”页面，即可获取对应的账号ID信息。 图1 获取账号ID 父主题： 附录
获取项目ID 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中“我的凭证”。 图1 管理控制台
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs
true表示使用白名单放通支持的移动端浏览器（白名单由华为侧统一配置管理），false表示不使用白名单，该参数为2.0.2版本新增。 direction：可选DirectionEnum类型，默认值“sendrecv”,2.0.9.543版本新增。
华为SDK系统有默认的编码设置（720P+360P），一般可以不设置发流编码参数。如果您确实需要自定义发流编码参数，请参考华为SDK系统推荐码表：表56和表57，否则可能设置失败。
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms/{room_id
停止合流任务 功能介绍 调用此接口停止已下发的合流转码任务。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/mix-stream-jobs
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
查询自动录制配置 功能介绍 调用此接口查询自动录制配置 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/auto-record-mode
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则：{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer
示例2：创建合流录制任务 场景描述 示例1：创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件，您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
