文档

SubmitMediaCensorJob - 提交媒体审核作业

更新时间:

调用SubmitMediaCensorJob提交媒体审核作业。

接口说明

本接口提交的作业是异步执行方式,作业添加到管道中调度排队和执行。可以调用查询媒体审核作业接口查询作业执行结果,也可以使用异步的消息通知机制。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
TemplateIdstring

统一模板 ID,为空使用默认模板进行审核。

S00000001-100060
CoverImagesstring

封面图片的 OSS 文件,最多支持 5 个封面图片,JSON 数组。

说明 如果设置,会优先使用这个字段中的封面代替 Media 中的封面。
[{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg","RoleArn":"acs:ram::1997018457688683:role/AliyunICEDefaultRole"}]
Titlestring

视频标题,最大长度 64 个字节。

说明 如果设置,会优先使用这个字段中的标题代替 Media 中的标题。
Hello World
Descriptionstring

视频介绍,最大长度 128 个字节。

说明 如果设置,会优先使用这个字段中的描述代替 Media 中的描述。
example description
Barragesstring

视频弹幕。

说明 如果设置,会优先使用这个字段中的描述代替 Media 中的描述。
hello world
Outputstring

截图输出。审核任务会在文件输入文件对应的 path 下面生成审核截图和结果 JSON 文件。

  • 输出格式参考:oss://bucket/snapshot-{Count}.jpg,其中,bucket 为和当前项目处于同一区域的 oss bucket 名称,{Count}为截帧图片序号替换符。

  • 审核结果详细信息保存在 Output 相同 OSS 文件夹下,命名为{jobId}.output,output 文件具体字段格式,请参见媒体审核结果文件字段

oss://sashimi-cn-shanghai/censor/snapshot-{Count}.jpg
UserDatastring

用户自定义数据,最大长度 128 个字节。

UserDatatestid-001-****
NotifyUrlstring

Callback 路径,支持 MNS 和 HTTP 回调。

mns://125340688170****.oss-cn-shanghai.aliyuncs.com/queues/example-pipeline
Inputobject

输入待审核文件信息。

Typestring

输入文件类型:

OSS:OSS 路径

Media:媒资 ID

Media
Mediastring

输入文件信息,支持 OSS 地址和媒资 ID 两种。 OSS 地址规则为

1、oss://bucket/object

2、http(s)://bucket.oss-[regionId].aliyuncs.com/object

其中 bucket 为和当前项目处于同一区域的 oss bucket 名称,object 为文件路径。

1b1b9cd148034739af413150fded****
ScheduleConfigobject

调度配置。

PipelineIdstring

管道 ID。

5246b8d12a62433ab77845074039****
Priorityinteger

任务优先级。数值越大优先级越高,取值范围:1~10。

6

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

25818875-5F78-4A13-BEF6-D7393642CA58
JobIdstring

视频审核作业 ID。建议您保存此 ID 便于后续调用其他接口时使用。

88c6ca184c0e47098a5b665e2****

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  "JobId": "88c6ca184c0e47098a5b665e2****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-07-19新增 OpenAPI看变更集
  • 本页导读 (1)
文档反馈