检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 华为云实时音视频服务对应的接口列表如下所示,在调用媒体处理API前,您需要先获取用户Token,Token可以用于调用其他API时鉴权,具体如何调用媒体处理API请参考应用示例。 应用管理接口 表1 应用管理接口 接口 说明 POST /v2/apps 创建应用 GET
如何调用API 构造请求 认证鉴权 返回结果
拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头,其中“X-Subject-To
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数
终端节点(Endpoint) 所有 ALL rtc-api.myhuaweicloud.com 约束与限制 华为云实时音视频服务设置了API流控,避免出现因短时间内重复调用API,服务中断的情况。 表2 API流控说明 接口分类 接口名称 接口流控 应用管理 创建应用 查询应用列表 查询单个应用
附录 状态码 错误码 获取项目ID 获取账号ID 地区名称缩写 接收增值(录制)事件回调通知内容
应用管理 创建应用 查询应用列表 查询单个应用 删除应用 启用应用 停用应用
房间管理 踢除在线用户 解散房间
应用示例 示例1:创建单流录制任务 示例2:创建合流录制任务
状态码 调用实时音视频API时,可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 204 No Content 请求完全成功,同时HTTP响应不包含响应体。
新增房间管理接口组。 单流任务管理接口组新增更新单流任务接口。 2022-08-29 第十五次正式发布 本次变更如下: 修改启动合流任务接口和查询合流任务接口的参考示例。 2022-07-05 第十四次正式发布 本次变更如下: 修改查询用户通话指标接口的参考示例。 所有接口中的响应H
OBS桶管理 查询OBS桶列表 查询OBS桶下对象列表 OBS桶授权及取消授权
错误码 当您调用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代码示例调试功能。