DescribeTasks

POST

https://cloudrecord-api.zego.im/

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

说明

调用频率限制：10 次/秒

Request

Query Parameters

Action string必填

可选值: [DescribeTasks]

接口原型参数

https://cloudrecord-api.zego.im?Action=DescribeTasks

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

Status integer必填

可选值: [2, 3]

录制任务状态。

2：表示正在录制的任务。
3：表示已结束录制的任务。

RoomId string

用于指定要查询录制任务的房间号。不填写时查询 AppId 下所有房间的录制任务。

PageOffset integer

可选值: >= 1

默认值: 1

分页查询时的页码，从 1 开始。不填写或者填写为 0 时，默认为 1。

PageSize integer

可选值: >= 1 and <= 50

默认值: 50

分页查询时每页的记录条数，该值需小于等于 50，并且大于 0。不填写时默认为 50。

StartTime int64必填

查询的开始时间，为Unix 时间戳，单位：ms。开始时间不能早于当前时间的 3 天之前。

EndTime int64必填

查询的结束时间，为Unix 时间戳，单位：ms。EndTime 必须大于 StartTime，且查询时间跨度不超过 3 天。接口仅返回录制开始时间在查询时间范围内的记录。

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code int64

错误码。

Message string

错误描述。

RequestId string

请求 ID。

Data object

响应对象。

PageOffset integer

分页查询时的页码。

PageSize integer

分页查询时每页的记录条数。

TotalCount integer

查询结果总数。

TaskidList object[]

录制任务列表。

Array[

RecordBeginTimestamp int64

开始录制的时间戳，单位：ms。

TaskId string

录制任务 ID。

RoomId string

录制的目标房间 ID。

Status integer

可选值: [1, 2, 3, 4, 5]

录制状态。

1：录制任务初始化
2：录制任务进行中
3：录制任务已结束
4：录制任务异常结束
5：录制任务暂停中

]

{
  "Code": 0,
  "Message": "succeed",
  "RequestId": "abcd123",
  "Data": {
    "PageOffset": 1,
    "PageSize": 50,
    "TotalCount": 3,
    "TaskidList": [
      {
        "RecordBeginTimestamp": 1628565227899,
        "TaskId": "YRHu6-E4IyvEAAAD",
        "RoomId": "1000",
        "Status": 2
      },
      {
        "RecordBeginTimestamp": 1628565226303,
        "TaskId": "YRHu6uE4IyvEAAAC",
        "RoomId": "1000",
        "Status": 2
      },
      {
        "RecordBeginTimestamp": 1628565222498,
        "TaskId": "YRHu5uE4IyvEAAAB",
        "RoomId": "1000",
        "Status": 2
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "succeed",
  "RequestId": "abcd123",
  "Data": {
    "PageOffset": 1,
    "PageSize": 50,
    "TotalCount": 3,
    "TaskidList": [
      {
        "RecordBeginTimestamp": 1628565227899,
        "TaskId": "YRHu6-E4IyvEAAAD",
        "RoomId": "1000",
        "Status": 2
      },
      {
        "RecordBeginTimestamp": 1628565226303,
        "TaskId": "YRHu6uE4IyvEAAAC",
        "RoomId": "1000",
        "Status": 2
      },
      {
        "RecordBeginTimestamp": 1628565222498,
        "TaskId": "YRHu5uE4IyvEAAAB",
        "RoomId": "1000",
        "Status": 2
      }
    ]
  }
}