请求接口#
视频检测接口，可识别： 截帧画面中，涉政、色情、广告，暴恐等监管风险；同时可结合您的业务场景，识别人脸、LOGO、动植物等业务内容。 音频片段中，涉政、色情、广告等监管风险；同时可结合您的业务场景，识别性别，音色，未成年等业务内容。
接口说明#
接口用于提交视频相关信息，支持自定义截帧频率等。识别结果可异步回调到指定地址，或自行定期调用主动查询接口获取。一般情况处理耗时为视频文件时长的三分之一左右。
接口要求#
通信协议：http或https协议 请求方法：POST方法 字符编码：utf-8 参数格式：所有请求参数和返回参数都是采用json格式
视频要求#
支持格式： AVI、FLV、MP4、MPG、WMV、MOV、WMA、RMVB、m3u8。 大小限制：小于等于300MB。 时长限制：小于等于2小时。
超时时间#
建议超时时间：7s 内部处理的超时时间为3s，且会重试一次。正常请求耗时为5ms左右。
回调机制#
当用户收到推送结果，并返回HTTP状态码为200时，表示推送成功；否则系统将进行重试推送（直至达到重试次数上限）重试逻辑为间隔[5,10,20,30,40,50,60,70,80,90,100,110,120,120,120,120,120,120,120]秒后重试，20次之后依然失败则不在重试。
历史版本#
历史版本请求#
请求地址#
请求参数#
| 参数名称 | 类型 | 是否必传 | 最大长度 | 参数说明 |
|---|---|---|---|---|
| accessKey | string | 是 | 20 | 公司密钥。用于权限认证，开通服务时由数美提供 |
| eventId | string | 是 | 64 | 事件标识。需要与数美约定好取值。 |
| appId | string | 是 | 64 | 应用标识。此字段强校验，需要提前与数美约定好取值。 |
| imgType | string | 否 | 64 | 视频中的画面需要识别的监管类型，和imgBusinessType至少传一个。 可选值： POLITY：涉政识别 EROTIC：色情&性感违规识别 VIOLENT：暴恐&违禁识别 QRCODE：二维码识别 ADVERT：广告识别 IMGTEXTRISK：图片文字违规识别 如果需要识别多个功能，通过下划线连接，如POLITY_QRCODE_ADVERT用于涉政、二维码和广告组合识别 |
| audioType | string | 否 | 64 | 视频中的音频需要识别的监管类型，和audioBusinessType至少传一个。 可选值： POLITY：涉政识别 EROTIC：色情识别 ADVERT：广告识别 DIRTY: 辱骂识别 ADLAW:广告法 MOAN：娇喘识别 AUDIOPOLITICAL：声音涉政 ANTHEN：国歌识别 NONE：不检测音频 如需做组合识别，通过下划线连接即可，例如POLITY_EROTIC用于涉政和色情识别 |
| imgBusinessType | string | 否 | 128 | 视频中的画面需要识别的业务类型， 和imgType至少传一个，可选值见业务标签类型 |
| audioBusinessType | string | 否 | 128 | 视频中的音频业务识别类型，和audioType至少传一个。 可选值： SING：唱歌识别 LANGUAGE：语种识别（中文、英文、粤语、藏语、维吾尔语、朝鲜语、蒙语、其他） MINOR：未成年人识别 GENDER：性别识别 TIMBRE：音色识别，需要同时传入GENDER才能生效 如果需要识别多个功能，通过下划线连接 |
| callback | string | 否 | 500 | 指定回调url地址。当该字段非空时，服务将根据该字段回调通知用户审核结果（支持`http`/`https`） |
| data | object | 是 | - | 请求的数据内容，大小不超过1M |
| btId | string | 是 | 64 | 客户侧请求唯一标识 |
| tokenId | string | 是 | 64 | 用户账号标识。建议传入用户ID，可用于灌水、广告等行为维度的风险识别。 |
| url | string | 是 | 600 | 要检测的视频url地址 |
| audioDetectStep | int32 | 否 | - | 视频文件中的音频审核步长。单位为个，取值范围为1-36整数，取1表示跳过一个10S的音频片段审核，取2表示跳过二个，以此类推。不使用该功能时音频内容全部过审 |
| checkFrameCount | int32 | 否 | - | 固定截帧张数，默认包含首帧和尾帧，剩余截帧位置使用视频时长/截帧张数计算（四舍五入保留3位小数后大于0采用），该参数优先级高于detectFrequency和advancedFrequency，优先级：checkFrameCount>advancedFrequency>detectFrequency。由于该参数需要获取视频时长，如果获取视频时长失败，降级到按data.detectFrequency参数进行截帧 |
| dataId | string | 否 | 128 | 客户自定义数据Id。可以用于数美saas后台检索 |
| detectFrequency | int32 | 否 | - | 视频中的截帧频率间隔，取值范围为1~60s；如不传递默认5s截帧一次 |
| deviceId | string | 否 | 128 | 数美设备指纹标识。由数美SDK生成，用于用户行为分析。 |
| gender | string | 否 | - | 用户性别，建议值： male：男性 female：女性 ambiguity：性别不明 |
| ip | string | 否 | 64 | 客户端公网IP地址。该参数用于IP维度的用户行为分析。 |
| lang | string | 否 | - | 语言类型。可指定对截帧及音频片段内容检测的语种类型（默认为中文），可选值： zh：中文 en：英文 ar：阿拉伯语 |
| level | int32 | 否 | - | 用户等级，针对不同等级的用户可配置不同拦截策略。可选值：0：最低级用户，典型如新注册、完全不活跃或等级为0的用户等; 1：较低级用户，典型如低活跃或低等级用户等； 2：中等级用户，典型如具备一定活跃或等级中等的用户等； 3：较高级用户，典型如高活跃或高等级用户等； 4：最高级用户，典型如付费用户、VIP用户等 |
| receiveTokenId | string | 否 | 64 | 消息接收者的tokenId由数字、字母、下划线、短杠组成的长度小于等于64位的字符串 |
| returnAllAudio | int32 | 否 | - | 选择返回视频音频片段的等级，默认为0： 0：返回风险等级为非pass的音频片段 1：返回所有风险等级的音频片段 |
| returnAllImg | int32 | 否 | - | 选择返回视频截帧的等级，默认为0： 0：返回风险等级为非pass的视频截帧。 1：返回所有风险等级的视频截帧 |
| videoTitle | string | 否 | 128 | 视频名称。用于后台界面展示 |
| advancedFrequency | object | 否 | - | 高级截帧间隔，单位为秒，此项填写，默认截帧策略失效 参数配置如下 {"durationPoints":[300,600],"frequencies":[1,5,10]} 含义为： 视频文件时长≤300s ——选用1s一截帧 300s<视频文件时长≤600s ——选用5s一截帧 视频文件时长>600s ——选用10s一截帧 |
| durationPoints | int_array | 否 | - | 视频时长区间分割 用于规定视频文件支持动态截帧频率的时长区间，数组最多为5个 |
| frequencies | int_array | 否 | - | 视频时长区间对应的截帧频率 可设置范围为1~60秒，数组最多6个 说明：frequencies数组设置的个数需要比durationPoints数组个数多1个，传错或传空报错返回1902 |
| extra | object | 否 | - | |
| passThrough | object | 否 | 1024 | 客户传入透传字段。数美内部不会对该字段进行识别处理，随结果返回给用户。 |
| acceptLang | string | 否 | - | 选择返回标签的语种类型 可选值： zh：中文 en：英文 不传入默认为返回中文标签 |
响应#
返回参数#
以下参数，除code、message、requestId以外，其他必返参数均为在code返回1100时为必返。
回调参数#
以下参数，除code、message、requestId以外，其他必返参数均为在code返回1100时为必返。
