检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
API概览 华为云实时音视频服务对应的接口列表如下所示,在调用媒体处理API前,您需要先获取用户Token,Token可以用于调用其他API时鉴权,具体如何调用媒体处理API请参考应用示例。 应用管理接口 表1 应用管理接口 接口 说明 POST /v2/apps 创建应用 GET
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
单流任务管理 启动单流任务 查询单流任务状态 停止单流任务 更新单流任务
获取项目ID 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 图1 管理控制台
应用管理 创建应用 查询应用列表 查询单个应用 删除应用 启用应用 停用应用
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 Token认证:通过Token认证调用请求
OBS桶管理 查询OBS桶列表 查询OBS桶下对象列表 OBS桶授权及取消授权
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
应用示例 示例1:创建单流录制任务 示例2:创建合流录制任务
房间管理 踢除在线用户 解散房间
修订记录 表1 修订记录 修改时间 修改说明 2023-08-28 第二十次正式发布 本次变更如下: 新增OBS桶管理接口组。 新增查询详情事件接口和查询指定项目用户异常体验事件接口。 2023-07-06 第十九次正式发布 本次变更如下: 删除启动单流任务、更新单流任务和启动合流任务接口中的
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。具体获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面,即可获取对应的账号ID信息。 图1 获取账号ID 父主题: 附录
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
附录 状态码 错误码 获取项目ID 获取账号ID 地区名称缩写 接收增值(录制)事件回调通知内容
解散房间 功能介绍 调用此接口解散房间,将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
播放音乐 功能描述 混音是将音乐文件和麦克风音频混合,一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音乐文件。可以在本地播放,也可以同时播放给其他与会者听。 支持播放wav、pcm和单声道mp3音频文件。可以播放本地或在线音乐文件。 接口调用流程 实现过程 加入房间