查询云端录制任务
所有文档
menu

实时音视频 RTC

查询云端录制任务

产品详情立即开通

接口描述

录制任务有效期内,可以通过调用查询录制任务接口来查询录制状态,和生成的录制文件列表。

请求(Request)

请求URI

GET /v1/cloudrecording/{appId}/{taskId}/query HTTP/1.1
参数名 类型 是否必需 描述
appId String 应用ID
taskId String 录制任务ID

请求头域

除公共头域外,无其它特殊头域。

请求体

响应(Response)

响应头域

除公共头域外,无其它特殊头域。

响应体

字段名 类型 描述
appId String 应用ID
taskId String 录制任务ID
status String 任务状态。
STARTED:录制已开启,但是可能用户没有推流所以未进行;
IN_PROGRESS:录制任务进行中;
STOPPED:录制已停止。
createdTime Long 任务创建时间,为毫秒级别 Unix 时间戳
stopTime Long 任务停止时间,为毫秒级别 Unix 时间戳
expiredTime Long 任务过期时间,为毫秒级别 Unix 时间戳
fileList List 录制任务生成的文件列表。
需要注意的是,此接口查询录制文件列表并不是实时的,可能有1分钟左右的延时
此外,此接口最多查询 1000 个文件,需要注意文件切割时间和录制任务持续时间,避免生成录制文件数目超过1000。
+startTs Long 录制文件开始时间,为毫秒级别 Unix 时间戳
+endTs Long 录制文件结束时间,为毫秒级别 Unix 时间戳
+fileUrl String 文件下载 url。
需要注意的是,文件下载 url,目前仅适配百度智能云对象存储 BOS,并且不包含 url 鉴权等信息

示例

请求示例

GET /v1/cloudrecording/testapp/testTaskId/query HTTP/1.1
host: rtc.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}
x-bce-request-id: {bce-request-id}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
date: Mon, 05 Sep 2022 03:25:43 GMT
transfer-encoding: chunked
content-type: application/json;charset=UTF-8
cache-control: no-cache
{
    "appId": "testapp",
    "taskId": "testTaskId",
    "status": "STOPPED",
    "createdTime": 1717401011497,
    "stopTime": 1717401169080,
    "expiredTime": 1717404611497,
    "fileList": [
        {
            "startTs": 1717401015000,
            "endTs": 1717401077000,
            "fileUrl": "https://***/***/***"
        },
        {
            "startTs": 1717401076000,
            "endTs": 1717401134000,
            "fileUrl": "https://***/***/***"
        }
    ]
}
上一篇
启动云端录制
下一篇
停止云端录制任务