允许用户想智能媒体服务提交一个媒体文件的审核任务,该接口支持对视频、音频或图像内容进行自动化的审核,以检测其中可能包含的违规、敏感或不适宜的内容。
接口说明
该接口为异步接口,提交任务后返回任务 ID(此时任务尚未完成,任务将进入后台排队异步执行),最终结果将通过回调通知,也可通过查询媒体审核作业接口主动查询任务状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:SubmitMediaCensorJob |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TemplateId |
string |
否 |
统一模板 ID,为空使用默认模板进行审核。 |
S00000001-100060 |
| CoverImages |
string |
否 |
封面图片的 OSS 文件,最多支持 5 个封面图片,JSON 数组。 说明
如果设置,会优先使用这个字段中的封面代替 Media 中的封面。 |
[{"Bucket":"example-bucket-****","Location":"oss-cn-shanghai","Object":"example-****.jpeg","RoleArn":"acs:ram::1997018457688683:role/AliyunICEDefaultRole"}] |
| Title |
string |
否 |
视频标题,最大长度 64 个字节。 说明
如果设置,会优先使用这个字段中的标题代替 Media 中的标题。 |
Hello World |
| Description |
string |
否 |
视频介绍,最大长度 128 个字节。 说明
如果设置,会优先使用这个字段中的描述代替 Media 中的描述。 |
example description |
| Barrages |
string |
否 |
视频弹幕。 说明
如果设置,会优先使用这个字段中的描述代替 Media 中的描述。 |
hello world |
| Output |
string |
否 |
截图输出。审核任务会在文件输入文件对应的 path 下面生成审核截图和结果 JSON 文件。
|
oss://sashimi-cn-shanghai/censor/snapshot-{Count}.jpg |
| UserData |
string |
否 |
用户自定义数据,最大长度 128 个字节。 |
UserDatatestid-001-**** |
| NotifyUrl |
string |
否 |
Callback 路径,支持 MNS 和 HTTP 回调。 |
mns://125340688170****.oss-cn-shanghai.aliyuncs.com/queues/example-pipeline |
| Input |
object |
否 |
输入待审核文件信息。 |
|
| Type |
string |
否 |
输入文件类型: OSS:OSS 路径 Media:媒资 ID |
Media |
| Media |
string |
否 |
输入文件信息,支持 OSS 地址和媒资 ID 两种。 OSS 地址规则为 1、oss://bucket/object 2、http(s)://bucket.oss-[regionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 oss bucket 名称,object 为文件路径。 |
1b1b9cd148034739af413150fded**** |
| ScheduleConfig |
object |
否 |
调度配置。 |
|
| PipelineId |
string |
否 |
管道 ID。 |
5246b8d12a62433ab77845074039**** |
| Priority |
integer |
否 |
任务优先级。数值越大优先级越高,取值范围:1~10。 |
6 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| RequestId |
string |
请求 ID。 |
25818875-5F78-4A13-BEF6-D7393642CA58 |
| JobId |
string |
视频审核作业 ID。建议您保存此 ID 便于后续调用其他接口时使用。 |
88c6ca184c0e47098a5b665e2**** |
示例
正常返回示例
JSON格式
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"JobId": "88c6ca184c0e47098a5b665e2****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。