检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
示例2:创建合流录制任务 场景描述 示例1:创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件,您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点
录制规则管理 创建或更新录制规则 查询录制规则列表 查询录制规则 更新录制规则 删除录制规则
应用回调管理 配置RTC增值(录制)事件回调 查询增值(录制)事件回调配置
合流任务管理 启动合流任务 查询合流任务 修改合流任务 停止合流任务
解散房间 功能介绍 调用此接口解散房间,将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
查询实时规模 功能介绍 获取规模相关的指标在某一时间段内每分钟的统计数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id
示例1:创建单流录制任务 场景描述 若您需要对某一个房间的实时音视频进行录制,可以在加入房间后,调用录制接口创建单流录制任务。 前提条件 已获取需要使用的SparkRTC服务的终端节点:rtc-api.myhuaweicloud.com。 已创建用于存储录制文件的OBS桶,并完成OBS
接收增值(录制)事件回调通知内容 SparkRTC服务回调用户提供的接口时,会附带以下信息。 表1 请求Body参数 参数 是否必选 参数类型 描述 job_id 否 String 任务编号,可以用于修改、查看和停止录制任务 stream_name 否 String 流名 app_id
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在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}/enable 表1 路径参数
单流任务管理 启动单流任务 查询单流任务状态 停止单流任务 更新单流任务
创建或更新录制规则 功能介绍 调用此接口创建或更新录制规则。 若当前app在请求的location中无录制规则,则会创建新的录制规则 若当前app在请求的location中已有录制规则,则会更新原来的录制规则 接口约束 一个app在一个location最多创建一个录制规则。 调试
查询历史规模 功能介绍 查询指标过去每天的规模数量,可查询最近31天的数据。当天未结束,无法查到当天的房间数与用户数。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
数据统计分析 查询房间列表 查询用户列表 查询实时规模 查询实时规模分布 查询实时质量数据 查询实时网络 查询用量 查询历史规模 查询历史质量 查询用户通话指标 查询详情事件接口 查询指定项目用户异常体验事件 查询用户异常体验事件 查询异常事件用户分布
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况,暂不支持查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps
踢除在线用户 功能介绍 调用此接口强制用户离开房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms/{room_id
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数