应用示例 示例1:创建单流录制任务 示例2:创建合流录制任务
附录 状态码 错误码 获取项目ID 获取账号ID 地区名称缩写 接收增值(录制)事件回调通知内容
地区名称缩写 表1 地区名称缩写 地区 英文缩写 其他 OT 北京 BJ 天津 TJ 重庆 CQ 上海 SH 广东 GD 海南 HI 广西 GX 云南 YN 山西 SX 河北 HE 内蒙古 NM 宁夏 NX 辽宁 LN 吉林 JL 黑龙江 HL 江苏 JS 浙江 ZJ 江西 JX
数据统计分析 查询房间列表 查询用户列表 查询实时规模 查询实时规模分布 查询实时质量数据 查询实时网络 查询用量 查询历史规模 查询历史质量 查询用户通话指标 查询详情事件接口 查询指定项目用户异常体验事件 查询用户异常体验事件 查询异常事件用户分布
应用管理 创建应用 查询应用列表 查询单个应用 删除应用 启用应用 停用应用
录制规则管理 创建或更新录制规则 查询录制规则列表 查询录制规则 更新录制规则 删除录制规则
自动录制配置 更新自动录制配置 查询自动录制配置
应用回调管理 配置RTC增值(录制)事件回调 查询增值(录制)事件回调配置
合流任务管理 启动合流任务 查询合流任务 修改合流任务 停止合流任务
单流任务管理 启动单流任务 查询单流任务状态 停止单流任务 更新单流任务
房间管理 踢除在线用户 解散房间
向服务器传入“app_id”、“room_id”,“user_id”和“ctime”后,由服务器返回签名。
如果房间内的单个用户异常掉线,超过保活时间后服务端会将该用户清理出当前房间。如果房间内的所有用户都异常掉线,超过保活时间后服务端会自动解散当前房间。 当用户要加入的房间不存在时,后台会自动创建一个房间。 父主题: SDK使用
请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。
signature:必选,string[512]类型,鉴权签名字串,应用开发者需要向远端服务器获取鉴权签名。 远端服务器需要您自行部署,具体请参见接入鉴权。 ctime:必选,string类型,签名UTC时间戳,单位秒。
} 表2 离开房间原因 枚举值 描述 0 用户主动离开 1 服务器异常 2 sfu服务故障 3 服务不可达503 4 内部错误 5 被踢出房间 6 签名过期 7 重连超时 8 网络检测,UI不需要关注该错误码,不对外体现 9 用户移除 10 房间解散 stream-added 【事件说明
支持用户鉴权,华为云SparkRTC系统使用数字签名作为接入鉴权方式,需要在相应SDK的初始化或登录函数中提供“app_id”、“room_id”、“user_id”、“role”、“ctime”和“signature”等信息,才能接入华为SparkRTC服务。
{ "error_code" : "RTC.00002xxx", "error_msg" : "InternalError" } 状态码 状态码 描述 200 启用成功 404 app编号不存在 500 设置失败,服务器端错误 错误码 请参见错误码。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。
500 删除配置失败,服务器端错误 错误码 请参见错误码。