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

文档中心

立即注册

导航

企业直播

ListTasks - 获取质检任务列表

最近更新时间：2025.04.15 20:51:42首次发布时间：2025.04.15 20:51:42

调用 ListTasks 接口，获取指定项目下所有已创建的质检任务列表，包含任务状态、任务 ID、直播拉流地址等任务详情。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListTasks`	接口名称。当前 API 的名称为 `ListTasks`。
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。您可通过调用 ListScenarios 接口获取 ID。
SortBy	String	否	`CreatedTime`	排序规则。默认值为 `CreatedTime`。取值如下： `CreatedTime`：按照任务创建时间排序 `UpdatedTime`：按照任务更新时间排序（任务更新指任务状态变化等情况）
SortOrder	String	否	`DESC`	排序规则的顺序。默认值为 `DESC`。取值如下： `DESC`：降序 `ASC`：升序
TaskType	Integer	否	`2`	任务类型。默认查询全部类型。取值如下： `1`：视频审核（暂不支持） `2`：直播审核
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`：人审不通过
ActivityId	Long	否	`1778****94933`	自动创建质检任务的企业直播直播间 ID。您可以通过 ListActivityAPI 接口查询 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，调用 GetReport 接口，获取质检报告，包含违规占比、话术分析占比、图像分析占比等。
TaskName	String	`任务 A`	任务名称。
TaskType	Integer	`2`	任务类型。取值如下： `1`：视频审核（暂不支持） `2`：直播审核
TaskTypeDesc	String	`审核任务 1`	任务类型描述。
Status	Integer	`4`	任务状态。取值如下： `1`：待机审 `2`：机审中 `3`：待人审 `4`：已完成（人审已完成） `5`：任务执行失败
ScenarioId	Long	`1`	审核场景 ID。
LivePullURL	String	`https://www.example.com`	直播拉流地址。
CreatedTime	Long	`1744012851`	任务创建时间。Unix 时间戳，单位为秒。
UpdatedTime	Long	`1744012851`	任务更新时间（任务更新指任务状态变化等情况）。Unix 时间戳，单位为秒。
CallbackURL	String	`https://www.example.com`	回调地址，支持 HTTP 和 HTTPS 协议头。在任务开始到结束的整个生命周期中，当发生以下事件时，直播质检会将任务状态消息、机审违规消息，以及人审处置意见消息以 POST 方式提交至该地址：质检任务状态变化，包括任务开始、任务结束和任务执行失败触发机审违规消息提交人审处置意见
Extra	String	`{"ActivityId":123}`	CreateTask 接口传入的业务相关信息。
ActivityId	Long	`1778****94933`	自动创建质检任务的企业直播直播间 ID。说明仅在您联系直播质检技术支持绑定了您的企业直播账号，且主播通过企业直播开播时，该参数取值为直播间 ID，否则取值为 `0`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=ListTasks&Version=2024-08-01
{
    "PageNumber": 1,
    "PageSize": 10,
    "ProjectName": "182701****608457",
    "TaskName": "A",
    "ScenarioId": 1,
    "SortBy": "CreatedTime",
    "SortOrder": "DESC",
    "TaskType": 2,
    "StartTime": 1744016864,
    "EndTime": 1744016900,
    "TaskStatus": [
        3,
        4
    ],
    "MachineStatus": [
        1,
        2
    ],
    "ManualStatus": [
        1,
        2
    ],
    "ActivityId": 1778****94933
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListTasks",
        "Version": "2024-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "TaskDetails": [
            {
                "TaskId": 397**671,
                "TaskName": "任务 A",
                "ProjectName": "182701****608457",
                "TaskType": 2,
                "TaskTypeDesc": "审核任务 1",
                "Status": 4,
                "ScenarioId": 1,
                "CreatedTime": 1744012851,
                "UpdatedTime": 1744012851,
                "CallbackURL": "https://www.example.com",
                "Extra": "{\"ActivityId\":123}",
                "LivePullURL": "https://www.example.com",
                "ActivityId": 1778****94933
            }
        ]
    }
}

错误码

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