任务提交接口
更新时间:
异步提交点播视频进行图片和音频审核。提交成功后,通过查询或回调获取结果。
POSThttps://vsafe.ilivedata.com/api/v1/video/check/submit
请求格式
请求体使用 UTF-8 编码的 JSON。
请求头
必需
说明
Content-Type
是
application/json; charset=UTF-8
Accept
建议
application/json
鉴权相关请求头及签名规则见帮助中心请求签名。查询和停止任务时,请使用提交任务时的项目。
视频要求
- 视频支持类型:URL, BASE64
- 视频支持格式:mp4, m4v, mov, mkv, webm, flv, avi, asf, wmv, rm, rmvb, 3gp, 3g2, mpg, mpeg, vob, ts, mts, m2ts, ogv, mxf, dv
- 视频大小:URL 下载不超过
1GB;BASE64 编码后不超过15 MiB,不带 Data URL 前缀
- 视频说明:文件须完整、未加密且包含可解码的视频轨道;需要音频审核时,音频轨道也须可解码。支持格式指文件封装格式,实际可处理性取决于内部编码,不能仅根据扩展名判断
- URL 要求:直接指向可访问的视频文件,不支持网页或播放列表地址
请求体
参数
类型
必需
说明
type
Integer
是
1:URL;2:Base64。
video
String
是
type=1 为可访问的视频 URL;type=2 为纯 Base64,不带 Data URL 前缀,编码后最多 15×1024×1024 个字符。不需要 videoName。
frequency
Integer
否
截帧间隔,单位秒,范围 1~60。未传时使用项目截帧配置;无匹配配置时,视频不足 10 秒默认 2 秒,达到 10 秒默认 3 秒。启用闪帧检测时优先按闪帧策略处理。
referImage
String
否
人脸对比参照图 URL,建议 JPG/PNG、小于 10 MB;是否执行由审核策略及下游能力决定。
strategyId
String
否
审核策略,默认 DEFAULT。
lang
String
否
音频语种;未传或空字符串为 auto。语言支持
alternativeTags
Integer[]
否
额外审核分类,只接受 100,110,120,130,140,150,160,170,180,190,900,999;不等于结果分类的完整列表。
userId
String
否
业务终端用户 ID,建议不超过 32 字符;不是 RTC 推流对象筛选条件。
userIP
String
否
业务用户 IP。
did
String
否
设备 ID。
dtype
String
否
设备类型:1 iPhone、2 Android、3 iPad、4 Windows Phone、5 PC、6 Web、7 WAP。
callbackRegion
String
否
回调区域:cn/us/eu/ap;优先使用任务所属区域,本字段仅在无法获取任务区域时参与选择。
callbackUrl
String
否
HTTP/HTTPS 接收地址;与 callbackSecretKey 均非空时覆盖项目回调配置。
callbackSecretKey
String
否
与接收端一致的回调验签密钥;只传地址或只传密钥时回退到项目配置。
extra
Object
否
透传 JSON 对象,最多 20 个键值对;有结果时可返回,状态响应可能省略。
请求示例
{
"type": 1,
"video": "https://media.example.com/video.mp4",
"strategyId": "DEFAULT",
"lang": "auto",
"extra": {
"bizId": "vod-10001"
}
}
域名为占位示例;请替换为服务可以访问的实际视频。Base64 请求需将 type 改为 2,并将 video 替换为视频文件的 Base64 内容。
响应格式
响应体为 JSON,响应头 Content-Type: application/json。
字段
类型
说明
errorCode
Integer
0 表示提交成功,不代表审核已完成。
errorMessage
String
错误信息,成功时通常省略。
result.taskId
String
后续查询和回调关联使用的任务 ID。
{
"errorCode": 0,
"result": {
"taskId": "cn_00000000-0000-0000-0000-000000000001_1791763200000"
}
}
请保存响应体中的 result.taskId。示例 ID 不可直接用于后续请求。
错误处理
参见错误码与处理建议。HTTP 状态、errorCode、任务状态 code 和审核结论 result 必须分别处理。
异步提交点播视频进行图片和音频审核。提交成功后,通过查询或回调获取结果。
POST
https://vsafe.ilivedata.com/api/v1/video/check/submit请求格式
请求体使用 UTF-8 编码的 JSON。
| 请求头 | 必需 | 说明 |
|---|---|---|
Content-Type |
是 | application/json; charset=UTF-8 |
Accept |
建议 | application/json |
鉴权相关请求头及签名规则见帮助中心请求签名。查询和停止任务时,请使用提交任务时的项目。
视频要求
- 视频支持类型:URL, BASE64
- 视频支持格式:mp4, m4v, mov, mkv, webm, flv, avi, asf, wmv, rm, rmvb, 3gp, 3g2, mpg, mpeg, vob, ts, mts, m2ts, ogv, mxf, dv
- 视频大小:URL 下载不超过
1GB;BASE64 编码后不超过15 MiB,不带 Data URL 前缀 - 视频说明:文件须完整、未加密且包含可解码的视频轨道;需要音频审核时,音频轨道也须可解码。支持格式指文件封装格式,实际可处理性取决于内部编码,不能仅根据扩展名判断
- URL 要求:直接指向可访问的视频文件,不支持网页或播放列表地址
请求体
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
type |
Integer | 是 | 1:URL;2:Base64。 |
video |
String | 是 | type=1 为可访问的视频 URL;type=2 为纯 Base64,不带 Data URL 前缀,编码后最多 15×1024×1024 个字符。不需要 videoName。 |
frequency |
Integer | 否 | 截帧间隔,单位秒,范围 1~60。未传时使用项目截帧配置;无匹配配置时,视频不足 10 秒默认 2 秒,达到 10 秒默认 3 秒。启用闪帧检测时优先按闪帧策略处理。 |
referImage |
String | 否 | 人脸对比参照图 URL,建议 JPG/PNG、小于 10 MB;是否执行由审核策略及下游能力决定。 |
strategyId |
String | 否 | 审核策略,默认 DEFAULT。 |
lang |
String | 否 | 音频语种;未传或空字符串为 auto。语言支持 |
alternativeTags |
Integer[] | 否 | 额外审核分类,只接受 100,110,120,130,140,150,160,170,180,190,900,999;不等于结果分类的完整列表。 |
userId |
String | 否 | 业务终端用户 ID,建议不超过 32 字符;不是 RTC 推流对象筛选条件。 |
userIP |
String | 否 | 业务用户 IP。 |
did |
String | 否 | 设备 ID。 |
dtype |
String | 否 | 设备类型:1 iPhone、2 Android、3 iPad、4 Windows Phone、5 PC、6 Web、7 WAP。 |
callbackRegion |
String | 否 | 回调区域:cn/us/eu/ap;优先使用任务所属区域,本字段仅在无法获取任务区域时参与选择。 |
callbackUrl |
String | 否 | HTTP/HTTPS 接收地址;与 callbackSecretKey 均非空时覆盖项目回调配置。 |
callbackSecretKey |
String | 否 | 与接收端一致的回调验签密钥;只传地址或只传密钥时回退到项目配置。 |
extra |
Object | 否 | 透传 JSON 对象,最多 20 个键值对;有结果时可返回,状态响应可能省略。 |
请求示例
{
"type": 1,
"video": "https://media.example.com/video.mp4",
"strategyId": "DEFAULT",
"lang": "auto",
"extra": {
"bizId": "vod-10001"
}
}
域名为占位示例;请替换为服务可以访问的实际视频。Base64 请求需将 type 改为 2,并将 video 替换为视频文件的 Base64 内容。
响应格式
响应体为 JSON,响应头 Content-Type: application/json。
| 字段 | 类型 | 说明 |
|---|---|---|
errorCode |
Integer | 0 表示提交成功,不代表审核已完成。 |
errorMessage |
String | 错误信息,成功时通常省略。 |
result.taskId |
String | 后续查询和回调关联使用的任务 ID。 |
{
"errorCode": 0,
"result": {
"taskId": "cn_00000000-0000-0000-0000-000000000001_1791763200000"
}
}
请保存响应体中的 result.taskId。示例 ID 不可直接用于后续请求。
错误处理
参见错误码与处理建议。HTTP 状态、errorCode、任务状态 code 和审核结论 result 必须分别处理。