文档中心
云端录制旧版文档
API 文档
查询录制任务列表

查询录制任务列表

更新时间：2021-11-29 17:49

1 描述

开始录制后，开发者可以通过调用本接口，查询正在录制或已结束录制的任务列表。

2 接口原型

请求方式：POST/JSON

请求地址：

服务环境	调用频率限制	请求地址
国内正式环境	10 次/秒	https://cloudrecord-sh.zego.im/query_task_list
国内测试环境	10 次/秒	https://cloudrecord-test.zego.im/query_task_list
海外正式环境	10 次/秒	https://cloudrecord-hk.zegocloud.com/query_task_list
海外测试环境	10 次/秒	https://cloudrecord-test.zegocloud.com/query_task_list

传输协议：HTTPS

3 请求参数

参数	类型	是否必选	描述
app_id	Int64	是	ZEGO 给开发者分配的 AppID，唯一标识一个应用。
access_token	String	是	接口鉴权凭证，通过获取 AccessToken 接口获取。
status	Int	是	2：表示正在录制的任务。 3：表示已结束录制的任务。
room_id	String	否	用于指定要查询录制任务的房间号。不填写时查询 AppID 下所有房间的录制任务。
page_offset	Int	否	分页查询时的页码，从 1 开始。不填写或者填写为 0 时，默认为 1。
page_size	Int	否	分页查询时每页的记录条数，该值需小于等于 50，并且大于 0。不填写时默认为 50。
start_time	UInt64	是	查询的开始时间，为Unix 时间戳，单位：ms。开始时间不能早于当前时间的 3 天之前。
end_time	UInt64	是	查询的结束时间，为Unix 时间戳，单位：ms。end_time 必须大于 start_time，且查询时间跨度不超过 3 天。接口仅返回录制开始时间在查询时间范围内的记录。

4 请求示例

以下是 query_task_list 接口的请求示例

{
    "app_id":0000,
    "access_token":"xxxxxxxxx",
    "status":2,
    "room_id":"1230",
    "start_time": 1628474401000,
    "end_time": 1628475402000,
    "page_offset": 1,
    "page_size": 50
}

5 响应参数

参数	类型	描述
code	Int	错误码。
message	String	错误描述。
page_offset	Int	分页查询时的页码。
page_size	Int	分页查询时每页的记录条数。
total_count	Int	查询结果总数。
task_list	JSON Array	详见 task_list 成员列表。

task_list 成员如下：

参数名	类型	说明
record_begin_timestamp	UInt64	开始录制的时间戳。
task_id	String	录制任务 ID。
room_id	String	录制的目标房间 ID。
status	Int	录制状态。 1：录制任务初始化 2：录制任务进行中 3：录制任务已结束 4：录制任务异常结束 5：录制任务暂停中

6 响应示例

以下是 query_task_list 接口的响应示例。

{
    "code": 0,
    "message": "succeed",
    "page_offset": 1,
    "page_size": 50,
    "total_count": 3,
    "taskid_list": [
        {
            "record_begin_timestamp": 1628565227899,
            "task_id": "YRHu6-E4IyvEAAAD",
            "room_id": "1000",
            "status": 2
        },
        {
            "record_begin_timestamp": 1628565226303,
            "task_id": "YRHu6uE4IyvEAAAC",
            "room_id": "1000",
            "status": 2
        },
        {
            "record_begin_timestamp": 1628565222498,
            "task_id": "YRHu5uE4IyvEAAAB",
            "room_id": "1000",
            "status": 2
        }
    ]
}