文档中心 云点播 AI清除广告任务发起接口

AI清除广告任务发起接口

更新时间:2021-08-25 14:49:04

AI清除广告-任务发起接口

描述

AI清除广告-任务发起接口,可传入视频ID,指定清除广告的的配置,用来生成去除广告后的新视频,生成的新视频格式与原视频格式一致。若需要使用该接口,请需要联系客服开通“AI清除广告”增值服务。

请求说明

请求方式 Post
接口地址 https://api.cloudv.haplat.net/vod/ai/createClearAdTask
Content-Type 仅支持application/json
鉴权方式 鉴权方式V3

请求参数

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

    返回参数

    通用返回结果详见返回结果
    成功时返回的data参数的数据结构

    参数名 类型 描述
    taskId string AI清除广告任务ID

    示例

    输入示例

    
    curl -X POST 'http://api.cloudv.haplat.net/vod/ai/createClearAdTask' \
    -H 'host: api.cloudv.haplat.net' \
    -H 'Content-Type: application/json' \
    -H 'X-WS-AccessKey: bf6b3ba4bd6811e99eb390e2ba00c682' \
    -H 'AUTHORIZATION: WS3-HMAC-SHA256 Credential=bf6b3ba4bd6811e99eb390e2ba00c682, SignedHeaders=content-type;host, Signature=711a662c08cfc826d14bb27f956e6d8a1c024eae0266ce0b0448def647cfc056' \
    -H 'X-WS-Timestamp: 1595246063' \
    -d '{"clearTextAd":false,"clearVideoAd":true,"clearWatermarkAd":false,"notifyUrl":"http://test.com/callback","videoId":"5541bde40173100038de081b00000000"}'
    
    

    注意:示例中的“公共参数”参见公共参数说明文档

    输出示例

    {
    	"code": 200,
    	"data": {
    		"taskId": "522b34f0-ca74-11ea-9fd3-9ce3742e46f4"
    	},
    	"message": "操作成功"
    }
    

    错误码

    以下仅列出了接口业务逻辑相关的错误码,通用错误码详见 返回结果

    错误码 描述
    401 无AI清除广告的增值服务权限
    1000 参数错误
    1000 至少选择一种要删除的广告
    1000 videoId参数错误
    1000 videoId不存在或没权限
    1000 不支持删除源文件的videoId
    1000 videoAdTypes参数错误
    1000 videoAdTypes参数重复
    1000 videoAdLevel参数错误
    1000 watermarkAdType参数错误
    1000 textAdType参数错误
    1000 notifyUrl参数错误
    本篇文档内容对您是否有帮助?
    有帮助
    没帮助
    提交成功!非常感谢您的反馈,我们会继续努力做到更好!