检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
播放背景音乐是否支持在线音乐？ 暂不支持。 父主题： SDK使用
如何调用API 构造请求 认证鉴权 返回结果
API概览 华为云实时音视频服务对应的接口列表如下所示，在调用媒体处理API前，您需要先获取用户Token，Token可以用于调用其他API时鉴权，具体如何调用媒体处理API请参考应用示例。 应用管理接口 表1 应用管理接口 接口 说明 POST /v2/apps 创建应用 GET
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms/{ro
支持播放wav、pcm和单声道mp3音频文件。可以播放本地或在线音乐文件。 接口调用流程 实现过程 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 播放音乐文件 调用startAudioFile接口可以播放一个音乐文件。同一时刻只能播放一个音乐文件。 [rtcEngine
他与会者听，用于烘托气氛。 支持本地或在线文件路径，文件格式支持播放wav、pcm和单声道mp3音频格式。 接口调用流程 实现流程 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 播放音效文件 调用playAudioClip接口可以播放一个音效文件。可以同时播放多个音
他与会者听，用于烘托气氛。 支持本地或在线文件路径，文件格式支持播放wav、pcm和单声道mp3音频格式。 接口调用流程 实现过程 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 播放音效文件 调用playAudioClip接口可以播放一个音效文件。可以同时播放多个音
终端节点（Endpoint） 所有 ALL rtc-api.myhuaweicloud.com 约束与限制 华为云实时音视频服务设置了API流控，避免出现因短时间内重复调用API，服务中断的情况。 表2 API流控说明 接口分类 接口名称 接口流控 应用管理 创建应用 查询应用列表 查询单个应用
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数
拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。
查询用户列表 功能介绍 指定时间范围查询这段期间加入房间的用户列表。 最大查询跨度90天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/rtc/users
查询实时规模 功能介绍 获取规模相关的指标在某一时间段内每分钟的统计数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{pro
房间管理 踢除在线用户 解散房间
查询实时规模分布 功能介绍 对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET
查询指标过去每天的规模数量，可查询最近31天的数据。当天未结束，无法查到当天的房间数与用户数。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{pro
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于管理员创建IAM用户接口，返回如图1所示的消息头，其中“X-Subject-To
应用管理 创建应用 查询应用列表 查询单个应用 删除应用 启用应用 停用应用
应用场景 在线教育 高清、低时延、高并发直播，易集成，适用于在线学习、师生互动，支持快速部署到在线教育视频平台。 互动文娱 适用于网红直播、企业直播、娱乐直播、游戏直播等场景，提供功能强大的实时媒体处理能力，实现各种直播场景玩法，为客户和合作伙伴打造端到端一站式“音视频互动”解决方案。
附录 状态码 错误码 获取项目ID 获取账号ID 地区名称缩写 接收增值（录制）事件回调通知内容
新增房间管理接口组。 单流任务管理接口组新增更新单流任务接口。 2022-08-29 第十五次正式发布 本次变更如下： 修改启动合流任务接口和查询合流任务接口的参考示例。 2022-07-05 第十四次正式发布 本次变更如下： 修改查询用户通话指标接口的参考示例。 所有接口中的响应H
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
