检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。具体获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面,即可获取对应的账号ID信息。 图1 获取账号ID 父主题: 附录
使用前必须 华为云实时音视频服务(SparkRTC)凭借在视频业务领域长期技术积累,快速为行业提供高并发、低延迟、高清流畅、安全可靠的全场景、全互动、全实时的音视频服务,适用于在线教育、云会议、社交文娱等场景。 您可以使用本文档提供的API对华为云实时音视频服务进行相关操作,如应用管理
状态码 调用实时音视频API时,可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 204 No Content 请求完全成功,同时HTTP响应不包含响应体
自动录制配置 更新自动录制配置 查询自动录制配置
合流任务管理 启动合流任务 查询合流任务 修改合流任务 停止合流任务
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
地区名称缩写 表1 地区名称缩写 地区 英文缩写 其他 OT 北京 BJ 天津 TJ 重庆 CQ 上海 SH 广东 GD 海南 HI 广西 GX 云南 YN 山西 SX 河北 HE 内蒙古 NM 宁夏 NX 辽宁 LN 吉林 JL 黑龙江 HL 江苏 JS 浙江 ZJ 江西 JX
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在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
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2
录制规则管理 创建或更新录制规则 查询录制规则列表 查询录制规则 更新录制规则 删除录制规则
应用回调管理 配置RTC增值(录制)事件回调 查询增值(录制)事件回调配置
错误码 当您调用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}/mix-stream-jobs
删除录制规则 功能介绍 调用此接口删除录制规则,对于正在使用的录制规则,不允许删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{
查询用量 功能介绍 查询过去的某一时间段内各种业务的用量数据 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/rtc/history
更新单流任务 功能介绍 调用此接口修改单流任务。 仅部分场景支持修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/individual-stream-jobs
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制: 纯音频录制 encode_template填audio_only,音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填,填就忽略。
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs