文档中心

企业直播

直播质检 API

CreateTask - 创建直播质检任务

调用 CreateTask 接口，创建直播质检任务。任务成功创建后，返回任务 ID。您可通过该任务 ID，调用 GetReport 接口，获取直播质检报告，包含违规占比、话术分析占比、图像分析占比等。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProjectName	String	是	`182701****608457`	项目名称。您可通过调用 ListProjects 接口，获取项目名称。
TaskName	String	是	`任务 A`	任务名称，长度为 1 到 200 个字符。支持以下字符：中文数字大写字母 A - Z 小写字母 a - z
TaskType	Integer	是	`2`	任务类型。固定取值为 `2`，表示对直播进行质检。
ScenarioId	Long	是	`1`	审核场景 ID。您可通过调用 ListScenarios 接口获取 ID。
LivePullURL	String	否	`https://www.example.com`	直播拉流地址。目前支持以下直播拉流协议：RTMP、HLS 和 FLV。说明本参数和 `ActivityId` 参数至少需要传一个。若两者同时传入，则本参数的优先级更高，即使用该直播拉流地址创建质检任务。任务启动后，如果持续 1 分钟未正常拉取到直播流，则停止拉流，任务自动终止。任务启动时间以 `TaskStartTime` 的值为准。如果直播时长超过 24 小时，任务自动终止。
CallbackURL	String	否	`https://www.example.com`	当前直播质检任务的回调地址，支持 HTTP 和 HTTPS 协议头。请使用可公网访问的域名地址，不支持配置 IPv4 地址（例如 `http://1.2.3.4/callback`）。说明如需通过质检消息回调获取任务状态消息、机审违规消息，以及人审处置意见消息，该参数必选。直播质检服务会将质检结果以 `POST` 方法提交至该地址。详见质检消息回调。如果您已联系技术支持配置了全局或项目级回调地址，则通过本接口传入的回调地址将优先于已配置的回调地址生效，且仅对当前任务生效。
Extra	String	否	`extra`	需要透传的业务相关信息。长度为 1 到 1000 个字符。仅用于信息透传，不做其他处理。
ActivityId	Long	否	`1836863952377033`	质检任务关联的企业直播直播间 ID。当前接口会使用该直播间的拉流地址创建质检任务。说明本参数和 `LivePullURL` 参数至少需要传一个。若两者同时传入，则 `LivePullURL` 的优先级更高，即使用 `LivePullURL` 参数取值的直播拉流地址创建质检任务。如果直播时长超过 24 小时，任务自动终止。请确保企业直播直播间在任务启动后的 30 天内开播。任务启动时间以 `TaskStartTime` 的值为准。
TaskStartTime	Long	否	`1751887200`	任务的启动时间。Unix 时间戳，单位为秒。不传或取值为 `0` 表示立即启动任务。任务启动后，系统将立即开始拉取直播流或监听直播间的开播状态。根据是否设置了任务启动时间，开播的时机有所不同：若 `TaskStartTime` 不传或取值为 `0`，任务会在创建后立即启动。请确保直播间在任务创建后开播。若设置了 `TaskStartTime`，任务会在指定时间启动。请确保直播间在任务启动之后开播。若任务启动时直播间已在直播中，系统会立即进行质检，但违规消音不生效。
TagIds	Array of Long	否	`[121]`	标签 ID，用于绑定质检任务。每个质检任务最多支持绑定 10 个标签。说明父标签 ID 不生效。
SpecifiableRuleArgs	Array of SpecifiableRuleArgs	否	`-`	在创建审核任务时，若您指定的审核场景中，需要指定预设文字、字幕或脚本，则需要传入该字段。说明仅基于 OCR 文字模型、OCR 滚动字幕模型和 ASR 脚本对比模型创建的规则，支持在创建任务时指定预设的文字、字幕或脚本。
MuteEnabled	Boolean	否	`true`	是否开启违规消音功能。默认为 `false`。取值如下： `true`：开启 `false`：关闭说明违规消音支持对直播过程中命中敏感词的声音进行消音。详见违规消音。

SpecifiableRuleArgs

参数	类型	是否必选	示例值	描述
RuleId	Long	是	`4005`	预设文字、字幕或脚本的审核规则 ID。可通过 GetScenario 接口获取。
OcrTextRecognitionArgs	Object of OcrTextRecognitionArgs	否	`-`	若当前规则为基于 OCR 文字识别模型创建的规则，则需要传入自定义规则参数，即为当前任务预设的文字。说明当 `RuleId` 有值时，在 `OcrTextRecognitionArgs`、`OcrScrollingSubtitlesArgs` 和 `PresetScriptArgs` 这三个参数中，您必须且只能传入一个。
OcrScrollingSubtitlesArgs	Object of OcrScrollingSubtitlesArgs	否	`-`	若当前规则为基于 OCR 滚动字幕模型创建的规则，则需要传入自定义规则参数，即为当前任务预设的字幕。说明当 `RuleId` 有值时，在 `OcrTextRecognitionArgs`、`OcrScrollingSubtitlesArgs` 和 `PresetScriptArgs` 这三个参数中，您必须且只能传入一个。
PresetScriptArgs	Object of PresetScriptArgs	否	`-`	若当前规则为预设脚本对比规则，则需要传入预设脚本。说明当 `RuleId` 有值时，在 `OcrTextRecognitionArgs`、`OcrScrollingSubtitlesArgs` 和 `PresetScriptArgs` 这三个参数中，您必须且只能传入一个。

OcrTextRecognitionArgs

参数	类型	是否必选	示例值	描述
PresetText	String	否	`品牌名称`	预设的文字，最多支持 200 个字符。说明若当前规则无需传入预设文字，则传入的值将被忽略。

OcrScrollingSubtitlesArgs

参数	类型	是否必选	示例值	描述
PresetSubtitles	String	否	`最`	预设的字幕，最多支持 200 个字符。说明若当前规则无需传入预设字幕，则传入的值将被忽略。

PresetScriptArgs

参数	类型	是否必选	示例值	描述
PresetScript	String	否	`预设脚本内容。`	预设脚本，最多支持 20,000 个字符。说明若当前规则无需传入预设脚本，则传入的值将被忽略。

返回参数

参数	类型	示例值	描述
TaskId	Long	`397**671`	质检任务 ID。您可通过该任务 ID，调用 GetReport 接口，获取质检报告，包含违规占比、话术分析占比、图像分析占比等。

请求示例

POST https://livesaas.volcengineapi.com/?Action=CreateTask&Version=2024-08-01
{
    "ProjectName": "182701****608457",
    "TaskName": "任务 A",
    "TaskType": 2,
    "ScenarioId": 1,
    "CallbackURL": "https://www.example.com",
    "Extra": "extra",
    "LivePullURL": "https://www.example.com",
    "ActivityId": 1836863952377033,
    "TagIds": [
        121
    ],
    "TaskStartTime": 1751887200,
    "SpecifiableRuleArgs": [
        {
            "RuleId": 4005,
            "OcrTextRecognitionArgs": {
                "PresetText": "品牌名称"
            }
        }
    ],
    "MuteEnabled": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateTask",
        "Version": "2024-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": 397**671
    }
}

错误码

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

最近更新时间：2026.10.12 15:53:49

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

请求参数 #

Query #

Body #

SpecifiableRuleArgs #

OcrTextRecognitionArgs #

OcrScrollingSubtitlesArgs #

PresetScriptArgs #

返回参数 #

请求示例 #

返回示例 #

错误码 #