文档首页/实时音视频 SparkRTC/API参考/API概览
更新时间：2025-11-04 GMT+08:00
查看PDF
分享

API概览

华为云实时音视频服务对应的接口列表如下所示，在调用媒体处理API前，您需要先获取用户Token，Token可以用于调用其他API时鉴权，具体如何调用媒体处理API请参考应用示例。

应用管理接口

表1 应用管理接口

接口

说明

POST /v2/apps

创建应用

GET /v2/apps

查询应用列表

GET /v2/apps/{app_id}

查询单个应用

DELETE /v2/apps/{app_id}

删除应用

POST /v2/apps/{app_id}/enable

启用应用

POST /v2/apps/{app_id}/disable

停用应用

录制规则管理接口

表2 录制规则管理接口

接口

说明

POST /v2/apps/{app_id}/record-rules

创建或更新录制规则

GET /v2/apps/{app_id}/record-rules

查询录制规则列表

GET /v2/apps/{app_id}/record-rules/{rule_id}

查询录制规则

PUT /v2/apps/{app_id}/record-rules/{rule_id}

更新录制规则

DELETE /v2/apps/{app_id}/record-rules/{rule_id}

删除录制规则

自动录制配置

表3 自动录制配置接口

接口

说明

PUT /v2/apps/{app_id}/auto-record-mode

更新自动录制配置

GET /v2/apps/{app_id}/auto-record-mode

查询自动录制配置

应用回调管理接口

表4 应用回调管理接口

接口

说明

PUT /v2/apps/{app_id}/record-callback

配置增值（录制）事件回调

GET /v2/apps/{app_id}/record-callback

查询增值（录制）事件回调配置

合流任务管理接口

表5 合流任务管理接口

接口

说明

POST /v2/apps/{app_id}/mix-stream-jobs

启动合流任务

GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}

查询合流任务

PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id}

修改合流任务

DELETE /v2/apps/{app_id}/mix-stream-jobs/{job_id}

停止合流任务

单流任务管理接口

表6 单流任务管理接口

接口

说明

POST /v2/apps/{app_id}/individual-stream-jobs

启动单流任务

GET /v2/apps/{app_id}/individual-stream-jobs/{job_id}

查询单流任务状态

DELETE /v2/apps/{app_id}/individual-stream-jobs/{job_id}

停止单流任务

PUT /v2/apps/{app_id}/individual-stream-jobs/{job_id}

更新单流任务

房间管理

表7 房间管理接口

接口

说明

POST /v2/apps/{app_id}/rooms/{room_id}/batch-remove-users

踢除在线用户

POST /v2/apps/{app_id}/rooms/{room_id}/dismiss

解散房间

OBS桶管理

表8 OBS桶管理接口

接口

说明

GET /v2/rtc-ops/buckets

查询OBS桶列表

GET /v2/rtc-ops/buckets/objects

查询OBS桶下对象列表

PUT /v2/rtc-ops/buckets/authentication

OBS桶授权及取消授权

数据统计分析接口

表9 数据统计分析接口

接口

说明

GET /v1/{project_id}/rtc/rooms

查询房间列表

GET /v1/{project_id}/rtc/users

查询用户列表

GET /v1/{project_id}/rtc/realtime/scale

查询实时规模

GET /v1/{project_id}/rtc/realtime/scale/dimension

查询实时规模分布

GET /v1/{project_id}/rtc/realtime/quality

查询实时质量数据

GET /v1/{project_id}/rtc/realtime/network

查询实时网络

GET /v1/{project_id}/rtc/history/usage

查询用量

GET /v1/{project_id}/rtc/history/scale

查询历史规模

GET /v1/{project_id}/rtc/history/quality

查询历史质量

GET /v1/{project_id}/rtc/client/qos/details

查询用户通话指标

GET /v1/rtc/data/abnormal-events

查询用户异常体验事件

GET /v1/rtc/data/abnormal-event/dimension

查询异常事件用户分布