AI清除广告任务发起接口-文档中心

POST

https://api.cdnetworks.com/vod/ai/createClearAdTask

调用createClearAdTask为指定视频创建AI去广告任务，系统会自动针对该视频进行AI去广告操作（增值服务功能，如若需要请联系客服开通“AI清除广告”增值服务）。

单用户调用频率：300/5min
适用产品：云点播

请求参数

Body 参数

参数名称	描述
*videoIdString	视频ID
clearVideoAdBoolean	是否清除视频广告。至少选择一种要清除的广告。如果不填，默认为false。
clearWatermarkAdBoolean	是否清除水印广告。至少选择一种要清除的广告。如果不填，默认为false。
clearTextAdBoolean	是否清除文字广告。至少选择一种要清除的广告。如果不填，默认为false。
videoAdTypesString	处理的视频广告类型,取值范围: “0”(清除片头广告) “0,1,2”(清除全部广告，包含片头+片中+片尾) 目前只支持“0”和“0,1,2”两种模式，不填则默认为“0,1,2”清楚全部广告
videoAdLevelInteger	视频广告清除等级,取值范围: 0(默认清除等级，可能造成漏删) 1(强力清除等级，可能造成误删) 不填则默认为0。
watermarkAdTypeInteger	处理水印广告类型,取值范围: 0(拉伸模糊) 1(高斯模糊) 不填默认为0。版本api-1.240.5（含）之后，watermarkAdType和textAdType两个参数内容必须一致，若不一致系统自动使用默认0
textAdTypeInteger	处理清楚跑马灯文字广告,取值范围: 0(拉伸模糊) 1(高斯模糊) 不填默认为0。
*notifyUrlString	通知地址，必须以 http://或https:// 开头。长度不能超过255个字符。通知内容详见 [AI清除广告-任务完成通知](https://www.wangsu.com/document/cate/70/17168)

返回参数

Body 参数

参数名称	描述
codeInteger	状态码
messageString	操作信息
- dataObject	返回数据
taskIdString	AI清除广告任务ID

错误码

错误代码（code）	描述（message）	HTTP状态码	语义
401	AI does not have the right to clear ads from value-added services	200	无AI清除广告的增值服务权限
1000	Parameter error	200	参数错误
1000	Choose at least one type of AD to remove	200	至少选择一种要删除的广告
1000	The videoId parameter is incorrect	200	videoId参数错误
1000	The videoId does not exist or has no permission	200	videoId不存在或没权限
1000	The videoId of a source file cannot be deleted	200	不支持删除源文件的videoId
1000	The videoAdTypes parameter is incorrect	200	videoAdTypes参数错误
1000	The videoAdTypes parameter is repeated	200	videoAdTypes参数重复
1000	The videoAdLevel parameter is incorrect	200	videoAdLevel参数错误
1000	The watermarkAdType parameter is incorrect	200	watermarkAdType参数错误
1000	The textAdType parameter is incorrect	200	textAdType参数错误
1000	The notifyUrl parameter is incorrect	200	notifyUrl参数错误

示例

JSON

请求示例 复制代码 复制成功#!/bin/bash username='example_username' apiKey='example_apiKey' date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://api.cdnetworks.com/vod/ai/createClearAdTask" \ -X "POST" \ -u "$username:$password" \ -H "Date: $date" \ -H "x-cnc-auth-method: BASIC" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "videoId": "idxxxxxx", "clearVideoAd":false, "clearWatermarkAd":false, "clearTextAd":false }'

#!/bin/bash
username='example_username'
apiKey='example_apiKey'
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://api.cdnetworks.com/vod/ai/createClearAdTask" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "x-cnc-auth-method: BASIC" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
    "videoId": "idxxxxxx",
    "clearVideoAd":false,
    "clearWatermarkAd":false,
    "clearTextAd":false
}'

返回示例 复制代码 复制成功{ "code": 200, "data": { "taskId": "522b34f0-ca74-11ea-9fd3-9ce3742e46f4" }, "message": "Operation succeeded" }

{
	"code": 200,
	"data": {
		"taskId": "522b34f0-ca74-11ea-9fd3-9ce3742e46f4"
	},
	"message": "Operation succeeded"
}

本篇文档内容对您是否有帮助？

有帮助

我要反馈

AI清除广告任务发起接口

请求参数

Body 参数

返回参数

Body 参数

错误码

示例

目录