ListVideoTasks - 获取视频质检任务列表--企业直播-火山引擎

文档中心

企业直播

视频质检 API

ListVideoTasks - 获取视频质检任务列表

调用 ListVideoTasks 接口，获取指定视频质检项目下所有或指定的已创建的质检任务列表，包含任务状态、任务 ID 等详情。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保当前账号已开通质检服务。若当前账号为子账号，请同时确保主账号已在直播质检平台为该子账号授权，详见为子账号授权。否则账号将提示“暂无使用权限,请联系客服人员申请开通”。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=ListVideoTasks&Version=2024-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListVideoTasks`	接口名称。当前 API 的名称为 `ListVideoTasks`。
Version	String	是	`2024-08-01`	接口版本。当前 API 的版本为 `2024-08-01`。

Body

参数	类型	是否必选	示例值	描述
PageNumber	Integer	否	`1`	分页查询页码。取值范围为 [1,1000]，默认值为 `1`。
PageSize	Integer	否	`10`	分页查询数量。取值范围为 [1,10000]，默认值为 `10`。
ProjectName	String	是	`182701****608457`	视频质检的项目名称。您可通过调用 ListProjects 接口，获取项目名称。
TaskName	String	否	`A`	视频质检任务名称，长度为 1 到 200 个字符。支持模糊搜索，英文不区分大小写。支持以下字符：中文数字大写字母 A - Z 小写字母 a - z
ScenarioId	Long	否	`1`	视频质检项目中的审核场景 ID。您可通过调用 ListVideoScenarios 接口获取 ID。
SortBy	String	否	`CreatedTime`	排序规则。默认值为 `CreatedTime`。取值如下： `CreatedTime`：按照任务创建时间排序 `UpdatedTime`：按照任务更新时间排序（任务更新指任务状态变化等情况）
SortOrder	String	否	`DESC`	排序规则的顺序。默认值为 `DESC`。取值如下： `DESC`：降序 `ASC`：升序
StartTime	Long	否	`1744016864`	任务开始时间。Unix 时间戳，单位为秒。精确到天，即只包含日期部分，不包含具体的时分秒，例如该参数取值为 `1744016864`，表示任务开始时间为 2025-04-07。
EndTime	Long	否	`1744016900`	任务结束时间。Unix 时间戳，单位为秒。精确到天，即只包含日期部分，不包含具体的时分秒，例如该参数取值为 `1744016900`，表示任务结束时间为 2025-04-07。
TaskStatus	Array of Integer	否	`[3,4]`	任务状态。默认查询全部状态。取值如下： `1`：待机审 `2`：机审中 `3`：待人审 `4`：已完成（人审已完成） `5`：任务执行失败
MachineStatus	Array of Integer	否	`[1,2]`	机审结果。默认查询全部结果。取值如下： `1`：机审通过 `2`：机审不通过
ManualStatus	Array of Integer	否	`[1,2]`	人审结果。默认查询全部结果。取值如下： `1`：人审通过 `2`：人审不通过
TagIds	Array of Long	否	`[121, 131]`	标签 ID，用于筛选绑定指定标签 ID 的质检任务。单次接口调用最多支持传入 10 个 ID。说明父标签 ID 不生效。
TaskIds	Array of Long	否	`[397671,397672]`	视频质检任务 ID 列表。默认查询当前视频质检项目下所有的任务。单次接口调用最多支持传入 100 个任务 ID。您可以通过本接口或 CreateVideoTask 接口获取任务 ID。

返回参数

参数	类型	示例值	描述
PageNumber	Integer	`1`	分页查询页码。
PageSize	Integer	`10`	分页查询数量。
TotalCount	Integer	`1`	查询结果总数。
TaskDetails	Array of TaskDetails	`-`	任务详情列表。

TaskDetails

参数	类型	示例值	描述
ProjectName	String	`182701****608457`	项目名称。
TaskId	Long	`397**671`	视频质检任务 ID。您可通过该任务 ID，调用 GetVideoReport 接口，获取质检报告。
TaskName	String	`任务 A`	任务名称。
TaskType	Integer	`1`	任务类型。固定取值为 `1`，表示对视频进行质检。
TaskTypeDesc	String	`审核任务 1`	任务类型描述。
Status	Integer	`4`	任务状态。取值如下： `1`：待机审 `2`：机审中 `3`：待人审 `4`：已完成（人审已完成） `5`：任务执行失败
ScenarioId	Long	`1`	审核场景 ID。
CreatedTime	Long	`1744012851`	任务创建时间。Unix 时间戳，单位为秒。
UpdatedTime	Long	`1744012851`	任务更新时间（任务更新指任务状态变化等情况）。Unix 时间戳，单位为秒。
CallbackURL	String	`https://www.example.com`	CreateVideoTask 接口传入的视频质检消息的回调地址。详见视频质检消息回调。
Extra	String	`extra`	CreateVideoTask 接口传入的业务相关信息。
Tags	Array of Tags	`-`	视频质检任务绑定的标签。
VideoInfo	Object of VideoInfo	`-`	视频质检任务关联的视频信息。

参数	类型	示例值	描述
TagId	Long	`121`	标签 ID。
TagName	String	`标签 B`	标签名称。
ParentTagId	Long	`26`	父标签 ID。
ParentTagName	String	`标签 A`	父标签名称。

VideoInfo

参数	类型	示例值	描述
Vid	String	`v02eag10000****ctk`	视频的唯一标识。说明仅当 `SourceType` 取值为 `1` 时，返回该参数。
VideoURL	String	`https://example.com/video.mp4`	视频的地址。说明仅当 `SourceType` 取值为 `4` 时，返回该参数。
VideoName	String	`video.mp4`	视频的名称。
SourceType	Integer	`3`	视频数据源类型。取值如下： `1`：当前项目的视频管理库 `3`：质检回放视频，即当前账号可见的直播质检任务中的直播回放视频 `4`：通过视频 URL 地址提供的视频
SourceTaskId	Long	`39737671`	当视频来源于质检回放时，该回放视频关联的直播质检任务 ID。说明仅当 `SourceType` 取值为 `3` 时，返回该参数。

请求示例

POST https://livesaas.volcengineapi.com/?Action=ListVideoTasks&Version=2024-08-01
{
    "ProjectName": "182701****608457"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListVideoTasks",
        "Version": "2024-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "TaskDetails": [
            {
                "TaskId": 397,
                "TaskName": "任务 A",
                "ProjectName": "182701****608457",
                "TaskType": 1,
                "TaskTypeDesc": "审核任务 1",
                "Status": 4,
                "ScenarioId": 1,
                "CreatedTime": 1744012851,
                "UpdatedTime": 1744012851,
                "CallbackURL": "https://www.example.com",
                "Extra": "extra",
                "Tags": [
                    {
                        "TagName": "标签 B",
                        "ParentTagId": 26,
                        "ParentTagName": "标签 A",
                        "TagId": 121
                    }
                ],
                "VideoInfo": {
                    "SourceType": 3,
                    "SourceTaskId": 39737671
                }
            }
        ]
    }
}

错误码

访问公共错误码和错误码获取详细信息。

最近更新时间：2026.06.11 11:04:30

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

TaskDetails #

Tags #

VideoInfo #

请求示例 #

返回示例 #

错误码 #