跳到主要内容

视频文件异步接口

1. 接口介绍​

客户通过视频文件异步识别接口提交识别任务，图普拉取视频文件进行截图及切片，对视频截图及语音片段进行识别检测，并将结果通过回调通知客户。 调用该接口时会返回本次审核任务的任务 ID，并在回调请求中携带任务 ID。业务流程如下：

提示

  1. 图普采用 任务并发数 对异步接口进行并发控制，即任一时刻最多允许 N 个任务同时处理。在测试期间， 任务并发数为 30（允许同时处理 30 个任务），正式使用或需要增加时请联系客户经理调整。当超出任务并发数后继续提交任务时，根据接口类型略有不同：

    • 异步文件接口：可以正常提交任务，提交的任务排队等待处理；
    • 异步流接口：提交任务时返回超出并发状态码（由于流的实时性要求，无法排队等待处理，因此无法继续提交）。

  2. 异步文件接口中，视频/语音文件建议小于 10GB，而文档文件须小于 500MB；异步流接口对流的时长没有限制，建议客户在流关闭时主动调用任务关闭接口。

截图分辨率​

如果视频的短边分辨率超过 1024 像素，则截取的图片以 1024/短边 等比例截取。例如：视频分辨率为 1920x1080， 截图的分辨率为 1820x1024。

2. 请求​

2.1 请求地址​

区域请求地址
国内https://api.video.tuputech.com/v3.1/recognition/video/async/<secretId>
国外https://api-oversea.video.tuputech.com/v3.1/recognition/video/async/<secretId>
提示

<secretId> 需替换为您的应用 SID，请联系客户经理为您开通及配置。关于 SID 详见 常见问题（FAQ）。

2.2 请求方法​

POST

2.3 请求头​

Content-Type: application/json

2.4 超时时间及异常处理​

建议配置超时时间 1 秒，在 HTTP 响应状态码非 200 或业务状态码不为 0 时进行重试。

2.5 请求参数说明 🔥​

参数名称类型是否必填说明
videoVideo是视频文件信息，详见 Video 参数说明
tasksArray<String>否指定的任务 ID。通常单个应用（接口）下会配置多个识别任务，可根据业务需要指定其中的部分任务进行识别
customInfoObject<String, Any>否自定义信息，为识别任务添加业务信息（如房间 ID、文件 ID 等）或其他扩展参数
nonceNumber是随机数
timestampNumber是当前服务器的 Unix 时间戳
signatureString是

RSA-SHA256 算法签名。签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例

Video 参数说明​

参数名称类型是否必填说明
urlString是视频文件链接。

1. 出于安全考虑，视频链接端口除 80, 443 端口外，应在 1025-65535 范围内
callbackString否识别结果回调接口地址，用于接收 POST 回调；未指定时忽略回调
intervalNumber否视频截图间隔，单位秒。取值范围 [0.5, 10]，默认 1 秒
audioBoolean否是否开启语音识别，默认 false

2.6 请求示例​

{
  "video": {
    "url": "<url>",
    "callback": "<callback>",
    "audio": true,
    "interval": 1
  },
  "tasks": [
    "<taskId>"
  ],
  "customInfo": {
    "roomId": "<roomId>"
  },
  "timestamp": 1685000000,
  "nonce": 1685000000,
  "signature": "<signature>"
}

3. 同步响应​

3.1 响应参数说明 🔥🔥​

参数名称类型说明
signatureString

同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过 图普公钥 进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：

  1. 取 json 字段内容为 SignString；
  2. 将 signature 字段内容进行 Base64 解码，得到 RawSignature；
  3. 使用图普公钥以 SHA256 算法验证 RawSignature 及 SignString
jsonString

同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。

  • 字段内容示例：{\"code\":0, \"message\":\"success\"}；
  • 字段详见下述 JSON 参数说明；
  • 为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

JSON 参数说明​

参数名称类型说明
codeInt状态码，详见 业务状态码
messageString状态信息
resultResult任务提交结果，详见 Result 参数说明
nonceNumber随机数
timestampNumber当前服务器的 Unix 时间戳

Result 参数说明​

参数名称类型说明
requestIdString任务 ID，长度为 20~64 的字符串（可能随着服务迭代发生变化）
urlString视频文件链接
callbackString识别结果回调接口地址

3.2 响应示例​

{
  "code": 0,
  "message": "success",
  "result": {
    "requestId": "<requestId>",
    "url": "<url>",
    "callback": "<callback>"
  },
  "nonce": 1685000000,
  "timestamp": 1685000000
}

4. 回调请求​

4.1 请求地址​

callbackUrl 参数指定的地址。

4.2 请求方法​

POST

4.3 请求头​

Content-Type: application/json

4.4 超时时间及异常处理​

回调超时时间 5 秒，在 HTTP 响应状态码非 200 时进行重试，最多重试 3 次。

建议客户在处理回调时进行异步处理，响应回调时可以返回字符串或 JSON，示例如下：

// JSON
{
  "message": "ok"
}

// 字符串
success

4.5 请求参数说明 🔥🔥🔥​

参数名称类型说明
signatureString

同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过 图普公钥 进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：

  1. 取 json 字段内容为 SignString；
  2. 将 signature 字段内容进行 Base64 解码，得到 RawSignature；
  3. 使用图普公钥以 SHA256 算法验证 RawSignature 及 SignString
jsonString

同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。

  • 字段内容示例：{\"code\":0, \"message\":\"success\"}；
  • 字段详见下述 JSON 参数说明；
  • 为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

JSON 参数说明​

参数名称类型是否必有说明
codeInt是状态码，详见 业务状态码
messageString是状态信息
requestIdString是视频任务 ID
suggestionNumber否汇总结果，整体的通过/拒绝情况，参考 审核场景汇总结果说明
riskTypeNumber否汇总结果，整体的风险类型，参考 审核场景汇总结果说明
<任务 ID>Object<String, Any>是识别任务的结果，每个识别任务会有 全局固定不变 的 taskId 和对应数据结构，详见下述链接：

1. 图片类任务结果
2. 文本类任务结果
3. 语音类任务结果
videoInfoVideoInfo是视频信息，详见 VideoInfo 数据结构
customInfoObject<String, Any>否提交的自定义信息，请求参数中的 customInfo
nonceNumber是随机数
timestampNumber是当前服务器的 Unix 时间戳

VideoInfo 数据结构​

参数名称类型说明
captureStartString视频截图开始时间，UTC 时区，格式为 2023-01-01T00:00:00Z
capturedImagesInt视频截图数量
durationNumber视频时长，单位秒

4.6 请求示例​

{
  "code": 0,
  "requestId": "<requestId>",
  "riskType": 1,
  "suggestion": 1,
  "videoInfo": {
    "captureStart": "2023-01-01T00:00:00Z",
    "capturedImages": 9,
    "duration": 8.5
  },
  "customInfo": {
    "roomId": "<roomId>"
  },
  "<任务 ID>": {},
  "nonce": 1685000000,
  "timestamp": 1685000000
}