检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
合流任务管理 启动合流任务 查询合流任务 修改合流任务 停止合流任务
终端节点(Endpoint) 所有 ALL rtc-api.myhuaweicloud.com 约束与限制 华为云实时音视频服务设置了API流控,避免出现因短时间内重复调用API,服务中断的情况。 表2 API流控说明 接口分类 接口名称 接口流控 应用管理 创建应用 查询应用列表 查询单个应用
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 RTC.00001001 OperationUnauthorized: get DomainID fail please check X-Auth-Token
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在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}/r
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
单流任务管理 启动单流任务 查询单流任务状态 停止单流任务 更新单流任务
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps
地区名称缩写 表1 地区名称缩写 地区 英文缩写 其他 OT 北京 BJ 天津 TJ 重庆 CQ 上海 SH 广东 GD 海南 HI 广西 GX 云南 YN 山西 SX 河北 HE 内蒙古 NM 宁夏 NX 辽宁 LN 吉林 JL 黑龙江 HL 江苏 JS 浙江 ZJ 江西 JX
获取项目ID 调用API获取项目ID 您还能通过调用查询指定条件下的项目信息API获取项目ID。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
录制规则管理 创建或更新录制规则 查询录制规则列表 查询录制规则 更新录制规则 删除录制规则
应用回调管理 配置RTC增值(录制)事件回调 查询增值(录制)事件回调配置
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。具体获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面,即可获取对应的账号ID信息。 图1 获取账号ID 父主题: 附录
支持播放wav、pcm和单声道mp3音频文件。可以播放本地或在线音乐文件。 接口调用流程 实现过程 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 播放音乐文件 调用startAudioFile接口可以播放一个音乐文件。同一时刻只能播放一个音乐文件。 [rtcEngine
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms/{ro
停止合流任务 功能介绍 调用此接口停止已下发的合流转码任务。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/mix
实时音视频”。 如果未注册,请单击此处注册华为账号并开通华为云,完成实名认证。 API方式 如果用户需要将华为云实时音视频服务集成到第三方系统,用于二次开发,请使用API方式访问华为云实时音视频服务,具体操作请参见《服务端API参考》。
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}