本文介绍了调用视频质量异步检测接口(/green/video/asyncsca)进行视频质量检测的方法,帮助您编写程序构建HTTP调用请求。

接口说明(视频异步检测)

业务接口:/green/video/asyncscan

异步检测视频文件中是否有模糊、拼接、低亮度、黑屏、静帧等质量问题。 关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK概览

  • 计费信息

    该接口为收费接口。关于计费方式,请参见内容安全产品定价

  • 检测场景

    视频质量检测场景目前只支持独立检测,不支持和其他场景一起检测,也不支持在检测视频内容的同时检测视频中的语音内容。

  • 返回结果

    异步检测任务不会实时返回检测结果,您需要通过callback或者轮询的方式获取检测结果。检测结果最长保留一小时。

    • callback获取检测结果:提交异步检测任务时,在请求参数中传入callback参数,用来自动接收检测结果,请参见请求参数
    • 轮询获取检测结果:提交异步检测任务时,无需传入callback参数;提交异步检测任务后,调用结果查询接口获取检测结果,请参见接口说明(视频异步检测结果查询)
  • 视频要求
    待检测视频需要满足以下要求:
    • 视频文件链接支持以下协议:HTTP和HTTPS。
    • 视频文件支持以下格式:AVIFLVMP4MPGASFWMVMOVWMARMVBRMFLASHTS
    • 视频大小限制:单个视频大小不超过200 MB。如果您有大视频的检测需求(最大支持2 GB),可以提交工单进行调整。
    • 视频检测的时间依赖于视频的下载时间。请保证被检测的视频文件所在的存储服务稳定可靠,建议您使用阿里云OSS存储服务存储视频文件。

请求参数

名称 类型 是否必选 示例值 描述
bizType String default 该字段用于标识您的业务场景。您可以通过内容安全控制台创建业务场景(具体操作,请参见自定义机审标准),或者提交工单联系我们帮助您创建业务场景。
scenes StringArray ["quality"] 指定视频检测的应用场景,唯一取值:quality,表示视频质量检测。
callback String http://xxx.xx.xx/xx.json 检测结果回调通知您的URL,支持使用HTTP和HTTPS协议的地址。该字段为空时,您必须定时轮询检测结果。
callback接口必须支持POST方法、UTF-8编码的传输数据,以及表单参数checksumcontent。内容安全按照以下规则和格式设置checksumcontent,调用您的callback接口返回检测结果。
  • checksum:字符串格式,由用户uid + seed + content拼成字符串,通过SHA256算法生成。用户UID即阿里云账号ID,可以在阿里云控制台查询。为防篡改,您可以在获取到推送结果时,按上述算法生成字符串,与checksum做一次校验。
    说明 用户UID必须是阿里云账号的UID,而不是RAM用户的UID。
  • content:JSON字符串格式,请自行解析反转成JSON对象。关于content结果的示例,请参见查询检测结果的返回示例。
说明 您的服务端callback接口收到内容安全推送的结果后,如果返回的HTTP状态码为200,则表示接收成功,其他的HTTP状态码均视为接收失败。接收失败时,内容安全将最多重复推送16次检测结果,直到接收成功。重复推送16次后仍未接收成功,则不再推送,建议您检查callback接口的状态。
seed String aabbcc123 该值用于回调通知请求中的签名。当使用callback时,该字段必须提供。
cryptType String SHA256 使用回调通知时(callback),设置对回调通知内容进行加密的算法。内容安全会将返回结果(由用户uid + seed + content拼接的字符串)按照您设置的加密算法加密后,再发送到您的回调通知地址。取值:
  • SHA256(默认):使用SHA256加密算法。
  • SM3:使用国密HMAC-SM3加密算法,返回十六进制的字符串,且字符串由小写字母和数字组成。

    例如,abc经国密SM3加密后返回66c7f0f462eeedd9d1f2d46bdc10e4e24167c4875cf2f7a2297da02b8f4ba8e0

tasks JSONArray 指定检测对象,JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素,即每次提交100条内容进行检测,支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素的具体结构描述,关于具体结构描述,请参见task
表 1. task
名称 类型 是否必选 示例值 描述
clientInfo JSONObject {"userId":"120234234","userNick":"Mike","userType":"others"} 客户端信息,请参见公共参数中的公共查询参数。
服务器会把全局的clientInfo和此处独立的clientInfo合并。
说明 独立的clientInfo优先级更高。
dataId String videoId xxx 数据ID。需要保证在一次请求中所有的ID不重复。
url String http://www.foo.bak/a.mp4 可访问的视频公网地址。
interval Integer 1 视频截帧间隔,单位为秒,取值范围为1~600。默认值为1秒。
maxFrames Integer 200 系统对本次检测的视频进行截帧的张数上限,取值范围为5~3600,默认为200张。如需调整到更大,请提交工单联系我们。
说明 当使用OSS地址(以oss://开头)作为视频源地址,并且授权内容安全服务访问阿里云MTS服务后,最大可截取20,000张,该方式不会产生额外费用。关于授权内容安全访问阿里云MTS服务的方法,请参见授权访问MTS服务
content结果示例
{
    "code": 200,
    "msg": "OK",
    "dataId": "videoId xxx",
    "taskId": "taskId xxx",
    "results": [
        {
            "label": "normal",
            "rate": 99.2,
            "scene": "quality",
            "suggestion": "pass"
        }
    ]
}

返回数据

名称 类型 示例值 描述
taskId String taskId xxx 本次检测任务的ID。
dataId String videoId xxx 检测对象对应的数据ID。
说明 如果在检测请求参数中传入了dataId,则此处返回对应的dataId

示例

请求示例
{
     "scenes": [
        "quality"
    ],
     "tasks": [
          {
               "dataId": "videoId xxx",
               "url": "http://www.foo.bak/a.mp4",
               "interval": 1,
               "maxFrames": 200
        }
    ]
}
返回示例
{
    "code": 200,
    "msg": "OK",
    "requestId": "requestID xxx",
    "data": [
        {
            "dataId": "videoId xxx",
            "taskId": "taskId xxx"
        }
    ]
}

接口说明(视频异步检测结果查询)

业务接口:/green/video/results

查询异步检测的结果。建议您将查询间隔设置为30秒,最长不能超过4个小时,否则结果将会消失。

说明 该接口为免费接口。

请求参数

名称 类型 是否必选 示例值 描述
body JSONArray ["taskId xxx","taskId bbb"] 要查询的taskId列表。最大长度不超过100。

返回数据

名称 类型 示例值 描述
code Integer 200 错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

msg String OK 请求信息的响应信息。
dataId String videoId xxx 检测对象对应的数据ID。
说明 如果在检测请求参数中传入了dataId,则此处返回对应的dataId
taskId String taskId xxx 本次检测任务的ID。
results JSONArray 返回结果,调用成功时(code=200),返回结果中包含一个或多个元素,每个元素是个结构体。关于具体结构描述,请参见result
说明 拉流检测场景中,code返回280表示在检测中,返回200表示检测完成。在检测中状态时,检测结果中包含从开始检测到当前时间检测到的问题。
表 2. result
名称 类型 示例值 描述
scene String quality 视频检测场景,和调用请求中的场景对应。
label String static 检测结果的分类,与具体的scene对应。取值:
  • normal:正常视频。
  • blur:视频模糊。
  • black_screen:视频中有黑屏内容。
  • low_luminance:视频亮度过低。
  • split:视频中有拼接画面。
  • static:视频中有静帧内容。
suggestion String block 建议您执行的操作。取值:
  • pass:视频正常,无需进行其余操作,或者未识别出目标对象。
  • review:检测结果不确定,需要进行人工审核,或识别出目标对象。
  • block:视频违规,建议执行进一步操作(直接删除或做限制处理)。
rate Float 99.2 结果为该分类的概率,取值范围为0~100。值越高,表示越有可能属于该分类。
frames JSONArray 判断为该分类的一些截帧检测结果(FrameScanResult)。每个元素是个结构体。关于具体结构描述,请参见frame
表 3. frame
名称 类型 示例值 描述
url String http://test.com 截帧地址。如果视频中出现了有质量问题的内容,会返回截帧的URL。
offset Integer 2 该截帧距离片头的时间戳,单位为秒。
label String static 该视频截帧的风险分类。取值:
  • blur:视频模糊。
  • black_screen:视频中有黑屏内容。
  • low_luminance:视频亮度过低。
  • split:视频中有拼接画面。
  • static:视频中有静帧内容。
rate Float 99.2 该视频截帧结果为label所述分类的概率,取值范围为0~100。值越高,表示越有可能属于该分类。

示例

请求示例
[
    "taskId xxx",
    "taskId bbb"
]
返回示例
{
    "code": 200,
    "msg": "OK",
    "requestId": "requestID xxx",
    "data": [
        {
            "code": 200,
            "msg": "OK",
            "dataId": "videoId xxx",
            "taskId": "taskId xxx",
            "results": [
                {
                    "label": "static",
                    "rate": 99.2,
                    "scene": "quality",
                    "suggestion": "block"
                }
            ]
        }
    ]
}