查询单流录制状态

编辑文档更新于 2024-11-11 06:14:32

接口请求地址

请求方式：POST/JSON
传输协议：HTTPS
调用频次限制：50 次/秒
请求 URL：

https://brtc-api.baijiayun.com/vcs/recording/stream/query_status_single

API鉴权

参见 Restful API 基本认证

请求参数

参数	类型	是否必选	描述
app_id	string	是	BRTC 给开发者分配的 appId，唯一标识一个应用
room_id	string	是	录制的房间 id

请求示例

{
    "app_id": "BZ2no1v919Die6mLc2nNOGvfqcQNSfKO",
    "room_id": "33669"
}

响应参数

参数	类型	描述
code	int	错误码
msg	string	错误描述
user_id	string	录制流的用户 id
room_id	string	录制的目标房间
stream_type	int	流类型 0:大流; 1:小流; 若对方未开启大小流，默认为大流
start_ts	string	录制状态开始的时间
status	int	录制状态 1: 录制任务未开始 2: 录制任务进行中 3: 录制任务已完成 4: 录制任务异常结束

查询结果以 start_ts 时间倒叙排列，最新的录制在最前面

响应示例

响应包体内容：

{
    "code":0,
    "msg": "succeed",
    "data":{
        "total":2 ,
        "list":[
            {
                "user_id": "123456",
                "room_id": "33669",
                "stream_type": 0,
                "start_ts": "2021-07-28 12:23:23",
                "status": 2
            },
            {
                "user_id": "34567",
                "room_id": "33669",
                "stream_type": 0,
                "start_ts": "2021-07-28 12:23:23",
                "status": 2
            }
        ]
     }
}