GetTask - 获取质检任务详情--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetTask - 获取质检任务详情

最近更新时间：2025.10.23 22:32:58首次发布时间：2025.10.21 12:12:54

调用 GetTask 接口，获取指定项目下的质检任务详情，包含任务状态、任务 ID、直播拉流地址等任务。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetTask`	接口名称。当前 API 的名称为 `GetTask`。
Version	String	是	`2024-08-01`	接口版本。当前 API 的版本为 `2024-08-01`。
ProjectName	String	是	`18270****8608457`	项目名称。您可通过调用 ListProjects 接口获取 ProjectName。
TaskId	Long	是	`397**671`	质检任务 ID。您可以通过 ListTasks 接口获取 TaskId。

返回参数

参数	类型	示例值	描述
TaskId	Long	`397**671`	任务 ID。您可通过该任务 ID，调用 GetReport接口，获取质检报告，包含违规占比、话术分析占比、图像分析占比等。
TaskName	String	`任务 A`	任务名称。
ProjectName	String	`182701****608457`	项目名称。
TaskType	Integer	`2`	任务类型。取值如下： `1`：视频审核（暂不支持） `2`：直播审核
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`	回调地址，支持 HTTP 和 HTTPS 协议头。在任务开始到结束的整个生命周期中，当发生以下事件时，直播质检会将任务状态消息、机审违规消息，以及人审处置意见消息以 POST 方式提交至该地址：质检任务状态变化，包括任务开始、任务结束和任务执行失败触发机审违规消息提交人审处置意见
Extra	String	`extra`	CreateTask 接口传入的业务相关信息。
LivePullURL	String	`http://www.example.com`	直播拉流地址。
ActivityId	Long	`17781****4933`	质检任务关联的企业直播直播间 ID。仅在满足以下任一条件时，该参数为直播间 ID，否则取值为 `0`。创建质检任务时关联了直播间 ID 联系直播质检技术支持绑定企业直播账号后，主播通过企业直播开播，直播质检平台自动创建质检任务
Tags	Array of Tags	`-`	质检任务绑定的标签。
ActivityName	String	`直播间 A`	质检任务关联的企业直播直播间名称。仅在满足以下任一条件时，该参数为直播间名称，否则取值为空字符串。创建质检任务时关联了直播间 ID 联系直播质检技术支持绑定企业直播账号后，主播通过企业直播开播，直播质检平台自动创建质检任务

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

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetTask&Version=2024-08-01&ProjectName=182701****608457&TaskId=397**671

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetTask",
        "Version": "2024-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": 397**671,
        "TaskName": "任务 A",
        "ProjectName": "182****328608457",
        "TaskType": 2,
        "TaskTypeDesc": "审核任务 1",
        "Status": 4,
        "ScenarioId": 1,
        "CreatedTime": 1744012851,
        "UpdatedTime": 1744012851,
        "CallbackURL": "https://www.example.com",
        "Extra": "extra",
        "LivePullURL": "http://www.example.com",
        "ActivityId": 1778****94933,
        "Tags": [
            {
                "TagName": "标签 B",
                "ParentTagId": 26,
                "ParentTagName": "标签 A",
                "TagId": 121
            }
        ],
        "ActivityName": "直播间 A"
    }
}

错误码

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