信息提交接口规范

更新时间:

一、 参数规范

  • 请求 URL:

从“控制台-服务配置”中获取

  • 接口描述:

提交视频信息接口，信息提交后，会对视频进行截图检测，检测结果需自行调用视频结果获取接口获取。

  • 支持格式:

检测接口支持的视频封装格式：flv、mkv 、mp4 、rmvb 、avi 、wmv、3gp、ts、mov等。

  • 大小限制:

视频大小限制：<1GB。

  • HTTP 请求Header:
Header 值 描述
Content-Type application/json;charset=UTF-8 请求体类型
Accept application/json;charset=UTF-8 接受的返回类型
X-AppId 项目的唯一标识，此值是 <控制台-服务配置>中的项目编号
X-TimeStamp 请求的UTC时间戳。需要把时间戳按W3C标准格式化，例如: 2010-01-31T23:59:59Z. (http://www.w3.org/TR/xmlschema-2/#dateTime)。
Authorization 签名认证说明

  • 请求方法:POST

  • 请求体JSON对象：

参数 必需 类型 描述
type 必需 Number 1：视频URL 2: 视频BASE64值
video 必需 String 视频内容，如type=1，则该值为视频URL，如type=2，则该值为视频BASE64值。type为2时，视频必须小于10MB
strategyId 可选 String 策略编号，通过控制台配置。缺省时使用项目默认策略:DEFAULT
lang 可选 String 视频中音频语种，不指定默认auto。支持的语种列表请查看音频审核文档
videoName 可选 String 视频文件名字，当type=2，视频为BASE64值时，此参数为必需，且能表示视频格式
frequency 可选 Number 截帧频率设置，默认值：10s以下视频默认2s截图检测一次，10s以上视频默认3秒截图检测一次。可设置范围为1~60秒
referImage 可选 String 用来做人脸对比的参照图URL，支持的格式：jpg, png；支持图片大小：<10M
userId 可选 String 唯一的终端用户ID。 用户ID应当不超过32个字符。
userIP 可选 String 用户IP地址
did 可选 String 用户设备ID
dtype 可选 String 用户设备类型：1：iPhone 2：android 3: ipad 4：wphone 5: pc 6：web 7：wap
callbackRegion 可选 String 回调区域：默认cn，可选cn，us，ap。不给或不在取值范围内默认使用cn区域发起回调
callbackUrl 可选 String 回调url：http协议
callbackSecretKey 可选 String 回调密钥，可自行定义，需要在回调验签方式使用密钥一致，否则无法验证回调数据是否被篡改
extra 可选 json 扩展字段，可以传多个key和value，透传。比如传游戏服务器和游戏版本两个参数，传入方式："extra":{"server": "123","version":"456"}

  • 请求体示例:

    {
    "type":2,
    "videoName":test
    "video":"http://xxx.xxx.com/xxxx",
    "userId": "testUser",
    "did": "868034031518269",
    "dtype": "1"
}

  • 请求签名：

签名认证说明