检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 华为云实时音视频服务对应的接口列表如下所示,在调用媒体处理API前,您需要先获取用户Token,Token可以用于调用其他API时鉴权,具体如何调用媒体处理API请参考应用示例。 应用管理接口 表1 应用管理接口 接口 说明 POST /v2/apps 创建应用 GET
如何调用API 构造请求 认证鉴权 返回结果
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
应用回调管理 配置RTC增值(录制)事件回调 查询增值(录制)事件回调配置
合流任务管理 启动合流任务 查询合流任务 修改合流任务 停止合流任务
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 Token认证:通过Token认证调用请求
录制规则管理 创建或更新录制规则 查询录制规则列表 查询录制规则 更新录制规则 删除录制规则
应用示例 示例1:创建单流录制任务 示例2:创建合流录制任务
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
状态码 调用实时音视频API时,可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 204 No Content 请求完全成功,同时HTTP响应不包含响应体
修订记录 表1 修订记录 修改时间 修改说明 2023-08-28 第二十次正式发布 本次变更如下: 新增OBS桶管理接口组。 新增查询详情事件接口和查询指定项目用户异常体验事件接口。 2023-07-06 第十九次正式发布 本次变更如下: 删除启动单流任务、更新单流任务和启动合流任务接口中的
OBS桶管理 查询OBS桶列表 查询OBS桶下对象列表 OBS桶授权及取消授权
自动录制配置 更新自动录制配置 查询自动录制配置
地区名称缩写 表1 地区名称缩写 地区 英文缩写 其他 OT 北京 BJ 天津 TJ 重庆 CQ 上海 SH 广东 GD 海南 HI 广西 GX 云南 YN 山西 SX 河北 HE 内蒙古 NM 宁夏 NX 辽宁 LN 吉林 JL 黑龙江 HL 江苏 JS 浙江 ZJ 江西 JX
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2
附录 状态码 错误码 获取项目ID 获取账号ID 地区名称缩写 接收增值(录制)事件回调通知内容
播放音乐 功能描述 混音是将音乐文件和麦克风音频混合,一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音乐文件。可以在本地播放,也可以同时播放给其他与会者听。 支持播放wav、pcm和单声道mp3音频文件。可以播放本地或在线音乐文件。 接口调用流程 实现过程 加入房间
使用前必须 华为云实时音视频服务(SparkRTC)凭借在视频业务领域长期技术积累,快速为行业提供高并发、低延迟、高清流畅、安全可靠的全场景、全互动、全实时的音视频服务,适用于在线教育、云会议、社交文娱等场景。 您可以使用本文档提供的API对华为云实时音视频服务进行相关操作,如应用管理