视频流异步接口

1. 接口介绍

客户通过视频流异步识别接口提交识别任务，图普拉取视频流进行截图及切片，对视频截图及语音片段进行识别检测，每隔一段时间通过回调通知客户识别结果。业务流程如下：

提示

图普采用 任务并发数 对异步接口进行并发控制，即任一时刻最多允许 N 个任务同时处理。在测试期间，任务并发数为 30（允许同时处理 30 个任务），正式使用或需要增加时请联系客户经理调整。当超出任务并发数后继续提交任务时，根据接口类型略有不同：
- 异步文件接口：可以正常提交任务，提交的任务排队等待处理；
- 异步流接口：提交任务时返回超出并发状态码（由于流的实时性要求，无法排队等待处理，因此无法继续提交）。
异步文件接口中，视频/语音文件建议小于 10GB，而文档文件须小于 500MB；异步流接口对流的时长没有限制，建议客户在流关闭时主动调用任务关闭接口。

截图分辨率

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

2. 请求

2.1 请求地址

v3.1（推荐）
v3

区域	请求地址
国内	`https://api.video.tuputech.com/v3.1/recognition/video/stream/<secretId>`

区域	请求地址
国内	`https://api.video.tuputech.com/v3/recognition/video/stream/<secretId>`

提示

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

2.2 请求方法

POST

2.3 请求头

Content-Type: application/json

2.4 超时时间及异常处理

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

2.5 请求参数说明 🔥

v3.1（推荐）
v3

参数名称	类型	是否必填	说明
`video`	Video	是	视频流信息，详见 Video 参数说明
`tasks`	Array<String>	否	指定的任务 ID。通常单个应用（接口）下会配置多个识别任务，可根据业务需要指定其中的部分任务进行识别
`customInfo`	Object<String, Any>	否	自定义信息，为识别任务添加业务信息（如房间 ID、文件 ID 等）或其他扩展参数
`nonce`	Float	是	随机数
`timestamp`	Int	是	当前服务器的 Unix 时间戳
`signature`	String	是	`RSA-SHA256` 算法签名。签名步骤：将参与签名的参数（`secretId`，`timestamp`，`nonce`）用英文半角逗号 `,` 拼接，得到 `SignString`；使用您的私钥以 `RSA-SHA256` 算法对 `SignString` 签名，然后进行 `Base64` 编码，得到 `signature` 字符串。点击数字证书下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥点击签名及验证示例查看签名示例

Video 参数说明

参数名称	类型	是否必填	说明
`url`	String	是	视频流地址。 1. 支持的协议：`RTMP`、`HLS`、`HTTP-FLV`、`RTSP`； 2. 支持的编码格式：`H.264/AVC`、`H.263`、`H.263+`、`MPEG-1`、`MPEG-2`、`MPEG-4`、`MJPEG`、`VP8`、`VP9`；3. 支持的容器格式：`flv`, `mkv`, `mp4`, `rmvb`, `avi`, `wmv`, `3gp`, `ts`, `mov`
`callback`	String	否	识别结果回调接口地址，用于接收 POST 回调；未指定时忽略回调
`audio`	Boolean	否	是否开启语音识别，默认 `false`
`interval`	Float	否	视频截图间隔，单位秒。取值范围 `[0.5, 10]`，默认 1 秒
`fragmentTime`	Int	否	视频语音切片时长及回调间隔，范围 `[10, 60]` 秒，默认 60 秒
`language`	String	否	语言种类代码（预览），在进行多语种语音转译或审核时填写。支持的语言种类及代码列表详见：语言代码列表。 1. 如需使用多语种语音转译或审核，请联系客户经理进行配置使用； 2. 该字段为空时，默认截取语音的一小段进行自动识别，可能存在语种判断错误的问题

参数名称	类型	是否必填	说明
`video`	String	是	视频流地址。 1. 支持的协议：`RTMP`、`HLS`、`HTTP-FLV`、`RTSP`； 2. 支持的编码格式：`H.264/AVC`、`H.263`、`H.263+`、`MPEG-1`、`MPEG-2`、`MPEG-4`、`MJPEG`、`VP8`、`VP9`；3. 支持的容器格式：`flv`, `mkv`, `mp4`, `rmvb`, `avi`, `wmv`, `3gp`, `ts`, `mov`
`timestamp`	Int	是	当前服务器的 Unix 时间戳
`nonce`	Float	是	随机数
`signature`	String	是	`RSA-SHA256` 算法签名。签名步骤：将参与签名的参数（`secretId`，`timestamp`，`nonce`）用英文半角逗号 `,` 拼接，得到 `SignString`；使用您的私钥以 `RSA-SHA256` 算法对 `SignString` 签名，然后进行 `Base64` 编码，得到 `signature` 字符串。点击数字证书下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥点击签名及验证示例查看签名示例
`callbackUrl`	String	是	识别结果回调接口地址，用于接收 POST 回调
`interval`	Float	否	视频截图间隔，单位秒。取值范围 `[0.5, 10]`，默认 1 秒
`fragmentTime`	Int	否	视频语音切片时长及回调间隔，范围 `[10, 60]` 秒，默认 60 秒
`audio`	Boolean	否	是否开启语音识别，默认 `false`
`callbackRules`	CallbackRules	否	回调规则，默认回调违规标签的数据。详见 CallbackRules 数据结构
`customInfo`	Object<String, Any>	否	自定义信息，为识别任务添加业务信息（如房间 ID、文件 ID 等）或其他扩展参数
`task`	Array<String>	否	指定的任务 ID。通常单个应用（接口）下会配置多个识别任务，可根据业务需要指定其中的部分任务进行识别
`language`	String	否	语言种类代码（预览），在进行多语种语音转译或审核时填写。支持语种及语言代码列表详见：语言代码列表。 1. 如需使用多语种语音转译或审核，请联系客户经理进行配置使用； 2. 该字段为空时，默认截取语音的一小段进行自动识别，可能存在语种判断错误的问题

CallbackRules 数据结构

参数名称	类型	是否必填	说明
`<任务 ID>`	Array<CallbackRule>	否	识别任务的回调规则，详见 CallbackRule 数据结构

备注

CallbackRules 是一个键值对/Object，key 为 taskId, value 为 CallbackRule 数组。

CallbackRule 数据结构

参数名称	类型	是否必填	说明
`label`	Int	是	仅回调指定标签的结果
`review`	Boolean	否	不为空时，仅回调指定标签的复审类型的结果

2.6 请求示例

v3.1（推荐）
v3

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

{
  "video": "<url>",
  "interval": 1,
  "fragmentTime": 10,
  "callbackUrl": "<callback>",
  "audio": false,
  "customInfo": {
    "roomId": "<roomId>"
  },
  "language": "zh",
  "callbackRules": {
    "54bcfc6c329af61034f7c2fc": [
      {
        "label": 0,
        "review": false
      },
      {
        "label": 1,
        "review": false
      }
    ]
  },
  "task": [
    "<taskId>"
  ],
  "timestamp": 1685000000,
  "nonce": 1685000000,
  "signature": "<signature>"
}

3. 同步响应

3.1 响应参数说明 🔥🔥

参数名称类型说明

参数名称	类型	说明
`signature`	String	同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过图普公钥进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：取 `json` 字段内容为 `SignString`；将 `signature` 字段内容进行 `Base64` 解码，得到 `RawSignature`；使用图普公钥以 `SHA256` 算法验证 `RawSignature` 及 `SignString`
`json`	String	同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。字段内容示例：`{\"code\":0, \"message\":\"success\"}`；字段详见下述 JSON 参数说明；为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

signature

String

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

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

json

String

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

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

JSON 参数说明

v3.1（推荐）
v3

参数名称	类型	是否必有	说明
`code`	Int	是	状态码，详见业务状态码
`message`	String	是	状态信息
`result`	Result	是	任务提交结果，详见 Result 参数说明
`nonce`	Float	是	随机数
`timestamp`	Int	是	当前服务器的 Unix 时间戳

Result 参数说明

参数名称	类型	是否必有	说明
`requestId`	String	是	任务 ID，长度为 20~64 的字符串（可能随着服务迭代发生变化）
`url`	String	是	视频流地址
`callback`	String	否	识别结果回调接口地址

参数名称	类型	说明
`code`	Int	状态码，详见业务状态码
`message`	String	状态信息
`nonce`	Float	随机数
`timestamp`	Int	当前服务器的 Unix 时间戳
`videoId`	String	任务 ID，长度为 20~64 的字符串（可能随着服务迭代发生变化）

3.2 响应示例

v3.1（推荐）
v3

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

{
  "code": 0,
  "message": "success",
  "videoId": "<videoId>",
  "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 请求参数说明 🔥🔥🔥

参数名称类型说明

参数名称	类型	说明
`signature`	String	同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过图普公钥进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：取 `json` 字段内容为 `SignString`；将 `signature` 字段内容进行 `Base64` 解码，得到 `RawSignature`；使用图普公钥以 `SHA256` 算法验证 `RawSignature` 及 `SignString`
`json`	String	同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。字段内容示例：`{\"code\":0, \"message\":\"success\"}`；字段详见下述 JSON 参数说明；为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

signature

String

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

json

String

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

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

JSON 参数说明

v3.1（推荐）
v3

参数名称	类型	是否必有	说明
`code`	Int	是	状态码，详见业务状态码
`message`	String	是	状态信息
`nonce`	Float	是	随机数
`timestamp`	Int	是	当前服务器的 Unix 时间戳
`requestId`	String	是	任务 ID，长度为 20~64 的字符串（可能随着服务迭代发生变化）
`videoInfo`	VideoInfo	是	视频信息，详见 VideoInfo 数据结构
`fragmentInfo`	Object	是	视频片段信息。详见 FragmentInfo 数据结构
`<任务 ID>`	Object	是	识别任务的结果，每个识别任务会有全局固定不变的 `taskId` 和对应数据结构，详见下述链接： 1. 图片类任务结果 2. 文本类任务结果 3. 语音类任务结果
`isAudio`	Boolean	否	该回调是否语音片段识别结果，视频截图识别结果该字段可能省略。由于视频截图与语音切片的处理时机不同，因此分开回调，客户需通过该字段进行区分
`suggestion`	Int	否	汇总结果，整体的通过/拒绝情况，参考审核场景汇总结果说明
`riskType`	Int	否	汇总结果，整体的风险类型，参考审核场景汇总结果说明
`customInfo`	Object	否	提交的自定义信息，请求参数中的 `customInfo`

VideoInfo 数据结构

参数名称	类型	是否必有	说明
`id`	String	否	任务 ID（待废弃，请使用上述 `requestId`）
`captureStart`	String	否	视频截图开始时间，UTC 时间，格式为 `2023-01-01T00:00:00.000Z`。若流状态异常，该字段可能为空
`status`	String	否	任务状态（待废弃）
`message`	String	否	状态信息（待废弃）

FragmentInfo 数据结构

参数名称	类型	是否必有	说明
`id`	String	是	视频片段唯一标识
`capturedImages`	Int	否	该片段截图数量
`offsetStart`	Float	否	该片段截图开始时间（相对时间，待废弃），单位秒
`offsetEnd`	Float	否	该片段截图开始时间（相对时间，待废弃），单位秒
`capturedFragments`	Int	否	该片段语音切片数量
`sliceStart`	Int	否	该片段语音切片开始时间（绝对时间，Unix 时间戳，待废弃）
`sliceEnd`	Int	否	该片段语音切片开始时间（绝对时间，Unix 时间戳，待废弃）

参数名称	类型	是否必有	说明
`code`	Int	是	状态码，详见业务状态码
`message`	String	是	状态信息
`nonce`	Float	是	随机数
`timestamp`	Int	是	当前服务器的 Unix 时间戳
`videoInfo`	VideoInfo	是	视频信息，详见 VideoInfo 数据结构
`fragmentInfo`	Object	是	视频片段信息。详见 FragmentInfo 数据结构
`<任务 ID>`	Object	是	识别任务的结果，每个识别任务会有全局固定不变的 `taskId` 和对应数据结构，详见下述链接： 1. 图片类任务结果 2. 文本类任务结果 3. 语音类任务结果
`isAudio`	Boolean	否	该回调是否语音片段识别结果，视频截图识别结果该字段可能省略。由于视频截图与语音切片的处理时机不同，因此分开回调，客户需通过该字段进行区分
`suggestion`	Int	否	汇总结果，整体的通过/拒绝情况，参考审核场景汇总结果说明
`riskType`	Int	否	汇总结果，整体的风险类型，参考审核场景汇总结果说明
`customInfo`	Object	否	提交的自定义信息，请求参数中的 `customInfo`

VideoInfo 数据结构

参数名称	类型	是否必有	说明
`id`	String	是	任务 ID
`captureStart`	String	否	视频截图开始时间，UTC 时间，格式为 `2023-01-01T00:00:00.000Z`。若流状态异常，该字段可能为空
`status`	String	否	任务状态（待废弃）
`message`	String	否	状态信息（待废弃）

FragmentInfo 数据结构

参数名称	类型	是否必有	说明
`id`	String	是	视频片段唯一标识
`capturedImages`	Int	否	该片段截图数量
`offsetStart`	Float	否	该片段截图开始时间（相对时间，待废弃），单位秒
`offsetEnd`	Float	否	该片段截图开始时间（相对时间，待废弃），单位秒
`capturedFragments`	Int	否	该片段语音切片数量
`sliceStart`	Int	否	该片段语音切片开始时间（绝对时间，Unix 时间戳，待废弃）
`sliceEnd`	Int	否	该片段语音切片开始时间（绝对时间，Unix 时间戳，待废弃）

4.6 请求示例

v3.1
v3

4.6.1 视频截图回调

{
  "code": 0,
  "message": "success",
  "requestId": "<requestId>",
  "isAudio": false,
  "riskType": 1,
  "suggestion": 1,
  "videoInfo": {
    "captureStart": "2023-01-01T00:00:00.000Z",
    "id": "<待废弃>",
    "message": "<待废弃>",
    "status": "<待废弃>"
  },
  "fragmentInfo": {
    "id": "<requestId>-1",
    "capturedImages": 8,
    "offsetEnd": 71,
    "offsetStart": 50
  },
  "customInfo": {
    "roomId": "<roomId>"
  },
  "<任务 ID>": {},
  "nonce": 1685000000,
  "timestamp": 1685000000
}

4.6.2 视频语音片段回调

{
  "code": 0,
  "message": "success",
  "requestId": "<requestId>",
  "isAudio": true,
  "riskType": 1,
  "suggestion": 1,
  "videoInfo": {
    "captureStart": "2023-01-01T00:00:00.000Z",
    "id": "<待废弃>",
    "message": "<待废弃>",
    "status": "<待废弃>"
  },
  "fragmentInfo": {
    "id": "<requestId>-1",
    "capturedFragments": 1,
    "sliceEnd": 1722913460,
    "sliceStart": 1722913450
  },
  "customInfo": {
    "roomId": "<roomId>"
  },
  "<任务 ID>": {},
  "nonce": 1685000000,
  "timestamp": 1685000000
}

4.6.1 视频截图回调

{
  "code": 0,
  "message": "success",
  "nonce": 1685000000,
  "timestamp": 1685000000,
  "videoInfo": {
    "id": "<videoId>",
    "captureStart": "2023-01-01T00:00:00.000Z",
    "message": "<待废弃>",
    "status": "<待废弃>"
  },
  "fragmentInfo": {
    "id": "<videoId>-1",
    "offsetStart": 0,
    "offsetEnd": 10,
    "capturedImages": 10
  },
  "customInfo": {
    "roomId": "<roomId>"
  },
  "suggestion": 1,
  "riskType": 1,
  "<任务 ID（图片分类任务）>": {
    "label": 0,
    "review": false,
    "fileList": [
      {
        "url": "<截图链接>",
        "rate": 0.9,
        "label": 0,
        "review": false,
        "second": 0
      }
    ],
    "avgScores": [
      {
        "score": 0.9,
        "label": 0
      }
    ],
    "maximums": [
      {
        "max": 0.9,
        "label": 0
      }
    ],
    "statistics": [
      {
        "count": 0,
        "label": 1
      }
    ]
  },
  "<任务 ID（人物搜索类任务）>": {
    "label": 2,
    "review": false,
    "fileList": [
      {
        "url": "<截图链接>",
        "similarity": 0.9,
        "label": 2,
        "review": false,
        "typeName": "<人物类型>",
        "faceId": "<人物名称>",
        "personId": "<personId>",
        "second": 0,
        "facePosition": [
          [
            0.191406,
            0.25
          ],
          [
            0.3125,
            0.25
          ],
          [
            0.3125,
            0.4652
          ],
          [
            0.191406,
            0.4652
          ]
        ]
      }
    ],
    "statistics": [
      {
        "count": 1,
        "label": 2
      }
    ],
    "matchList": [
      {
        "typeName": "<人物类型>",
        "faceId": "<人物名称>",
        "personId": "<personId>",
        "count": 1
      }
    ]
  },
  "<任务 ID（自定义图库）>": {
    "label": 2,
    "fileList": [
      {
        "url": "<截图链接>",
        "label": 2,
        "similarity": 0.9,
        "relatives": [
          {
            "path": "<自定义图片链接>",
            "score": 0.9
          }
        ],
        "second": 10
      }
    ],
    "maximums": [
      {
        "max": 0.9,
        "label": 2
      }
    ],
    "statistics": [
      {
        "count": 1,
        "label": 2
      }
    ]
  },
  "<任务 ID（OCR 文本审核）>": {
    "label": 3,
    "review": false,
    "fileList": [
      {
        "url": "<截图链接>",
        "text": "毛泽东",
        "scores": 0.9,
        "degree": 0,
        "location": [
          [
            0.4256518406293357,
            0.5753968315895163
          ],
          [
            0.5806905895660593,
            0.5753968315895163
          ],
          [
            0.5806905895660593,
            0.65079364460096
          ],
          [
            0.4256518406293357,
            0.65079364460096
          ]
        ],
        "textAnalysis": {
          "label": 3,
          "review": false,
          "rate": 0.9,
          "details": [
            {
              "keyword": "毛泽东",
              "hint": "毛泽东",
              "mainLabel": 3
            }
          ]
        },
        "second": 10
      }
    ],
    "avgScores": [
      {
        "score": 0.9,
        "label": 3
      }
    ],
    "maximums": [
      {
        "max": 0.9,
        "label": 3
      }
    ],
    "statistics": [
      {
        "count": 1,
        "label": 3
      }
    ]
  },
  "<任务 ID（检测类任务）>": {
    "fileList": [
      {
        "url": "<截图链接>",
        "category": 0,
        "scores": 0.9,
        "second": 1,
        "location": [
          [
            0.03537565228836477,
            0.03303825855255127
          ],
          [
            0.2027942005938315,
            0.03303825855255127
          ],
          [
            0.2027942005938315,
            0.271730899810791
          ],
          [
            0.03537565228836477,
            0.271730899810791
          ]
        ]
      }
    ],
    "avgScores": [
      {
        "score": 0.9,
        "category": 0
      }
    ],
    "maximums": [
      {
        "max": 0.9,
        "category": 0
      }
    ],
    "statistics": [
      {
        "count": 2,
        "category": 0
      }
    ]
  }
}

4.6.2 视频语音片段回调

{
  "code": 0,
  "message": "success",
  "isAudio": true,
  "videoInfo": {
    "id": "<videoId>",
    "captureStart": "2023-01-01T00:00:00.000Z",
    "message": "<待废弃>",
    "status": "<待废弃>"
  },
  "fragmentInfo": {
    "id": "<videoId>-1",
    "capturedFragments": 1,
    "sliceEnd": 1723192730,
    "sliceStart": 1723192720
  },
  "customInfo": {
    "roomId": "<roomId>"
  },
  "<任务 ID（语音转译审核）>": {
    "text": "毛泽东你好",
    "violations": [
      {
        "startTime": 12,
        "endTime": 15,
        "content": "毛泽东",
        "action": "block",
        "label": "Politics",
        "review": false,
        "rate": 0.896484,
        "details": [
          {
            "keyword": "毛泽东",
            "hint": "毛泽东",
            "mainLabel": "Politics",
            "subLabel": "National_Leader"
          }
        ]
      }
    ]
  },
  "nonce": 1685000000,
  "timestamp": 1685000000
}

5. 视频流结束回调

当客户关闭任务、流结束或异常时，图普会向客户发送视频流结束回调，可以通过标志 status=end 判断该回调是否表示视频流结束。若业务状态码 code 不为 0，说明视频流异常结束，可以根据业务状态码判断异常类型。可能的异常包括：

流结束：推流端停止推流，或一段时间内无法获取新的流数据
流状态异常：流地址错误、协议错误、流数据异常或流服务器错误；流中无视频或语音数据流；拉流过程中，流提前结束
拉流异常：连接超时，或拉流超时；无法拉流，流服务器拒绝连接

5.1 请求参数说明🔥🔥🔥

参数名称类型是否必有说明

参数名称	类型	是否必有	说明
`signature`	String	是	同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过图普公钥进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：取 `json` 字段内容为 `SignString`；将 `signature` 字段内容进行 `Base64` 解码，得到 `RawSignature`；使用图普公钥以 `SHA256` 算法验证 `RawSignature` 及 `SignString`
`json`	String	是	同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。字段内容示例：`{\"code\":0, \"message\":\"success\"}`；字段详见下述 JSON 参数说明；为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

signature

String

是

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

json

String

是

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

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

JSON 参数说明

v3.1（推荐）
v3

参数名称	类型	是否必有	说明
`code`	Int	是	状态码，详见业务状态码。可能的返回值包括： `0`：任务正常处理完成 `51000`：流结束 `51001~51003`：流状态异常 `51004~51006`：拉流异常
`nonce`	Float	是	随机数
`timestamp`	Int	是	当前服务器的 Unix 时间戳
`requestId`	String	是	任务 ID，长度为 20~64 的字符串（可能随着服务迭代发生变化）
`status`	String	是	流结束标志，目前始终取 `end`
`videoInfo`	VideoInfo	是	视频信息，详见 VideoInfo 数据结构
`customInfo`	Object<String, Any>	否	自定义信息，为识别任务添加业务信息（如房间 ID、文件 ID 等）或其他扩展参数

参数名称	类型	是否必有	说明
`code`	Int	是	状态码，详见业务状态码。可能的返回值包括： `0`：任务正常处理完成 `51000`：流结束 `51001~51003`：流状态异常 `51004~51006`：拉流异常
`nonce`	Float	是	随机数
`timestamp`	Int	是	当前服务器的 Unix 时间戳
`status`	String	是	流结束标志，目前始终取 `end`
`videoInfo`	VideoInfo	是	视频信息，详见 VideoInfo 数据结构
`customInfo`	Object<String, Any>	否	自定义信息，为识别任务添加业务信息（如房间 ID、文件 ID 等）或其他扩展参数

5.2 视频流结束状态回调示例

v3.1
v3

5.2.1 正常结束

{
  "code": 0,
  "message": "success",
  "requestId": "<requestId>",
  "status": "end",
  "videoInfo": {
    "id": "<待废弃>",
    "captureStart": "2023-01-01T00:00:00.000Z",
    "status": "<待废弃>",
    "message": "<待废弃>"
  },
  "customInfo": {
    "roomId": "<roomId>"
  },
  "nonce": 1685000000,
  "timestamp": 1685000000
}

5.2.2 异常结束

{
  "code": 51005,
  "message": "拉流异常：无法拉流，流服务器拒绝连接 (URL_EXPIRED_OR_FORBIDDEN)",
  "requestId": "<requestId>",
  "status": "end",
  "videoInfo": {
    "id": "<待废弃>",
    "message": "<待废弃>",
    "status": "<待废弃>"
  },
  "customInfo": {
    "roomId": "<roomId>"
  },
  "nonce": 1685000000,
  "timestamp": 1685000000
}

5.2.1 正常结束

{
  "code": 0,
  "message": "success",
  "status": "end",
  "videoInfo": {
    "id": "<videoId>",
    "captureStart": "2023-01-01T00:00:00.000Z",
    "status": "<待废弃>",
    "message": "<待废弃>"
  },
  "customInfo": {
    "roomId": "<roomId>"
  },
  "nonce": 1685000000,
  "timestamp": 1685000000
}

5.2.2 异常结束

{
  "code": 51005,
  "message": "拉流异常：无法拉流，流服务器拒绝连接 (URL_EXPIRED_OR_FORBIDDEN)",
  "status": "end",
  "videoInfo": {
    "id": "<videoId>",
    "status": "<待废弃>",
    "message": "<待废弃>"
  },
  "nonce": 1685000000,
  "timestamp": 1685000000
}

6. 更新日志

日期	说明
2024-11-28	新增 `language` 参数，用于在进行多语种识别时，指定语言种类
2024-08-09	调整并优化流结束回调说明，标记 `videoInfo.status` & `videoInfo.message` 为待废弃

视频流异步接口

1. 接口介绍​

截图分辨率​

2. 请求​

2.1 请求地址​

2.2 请求方法​

2.3 请求头​

2.4 超时时间及异常处理​

2.5 请求参数说明 🔥​

Video 参数说明​

CallbackRules 数据结构​

CallbackRule 数据结构​

2.6 请求示例​

3. 同步响应​

3.1 响应参数说明 🔥🔥​

JSON 参数说明​

Result 参数说明​

3.2 响应示例​

4. 回调请求​

4.1 请求地址​

4.2 请求方法​

4.3 请求头​

4.4 超时时间及异常处理​

4.5 请求参数说明 🔥🔥🔥​

JSON 参数说明​

VideoInfo 数据结构​

FragmentInfo 数据结构​

VideoInfo 数据结构​

FragmentInfo 数据结构​

4.6 请求示例​

4.6.1 视频截图回调​

4.6.2 视频语音片段回调​

4.6.1 视频截图回调​

4.6.2 视频语音片段回调​

5. 视频流结束回调​

5.1 请求参数说明🔥🔥🔥​

JSON 参数说明​

5.2 视频流结束状态回调示例​

5.2.1 正常结束​

5.2.2 异常结束​

5.2.1 正常结束​

5.2.2 异常结束​

6. 更新日志​

1. 接口介绍

截图分辨率

2. 请求

2.1 请求地址

2.2 请求方法

2.3 请求头

2.4 超时时间及异常处理

2.5 请求参数说明 🔥

Video 参数说明

CallbackRules 数据结构

CallbackRule 数据结构

2.6 请求示例

3. 同步响应

3.1 响应参数说明 🔥🔥

JSON 参数说明

Result 参数说明

3.2 响应示例

4. 回调请求

4.1 请求地址

4.2 请求方法

4.3 请求头

4.4 超时时间及异常处理

4.5 请求参数说明 🔥🔥🔥

JSON 参数说明

VideoInfo 数据结构

FragmentInfo 数据结构

VideoInfo 数据结构

FragmentInfo 数据结构

4.6 请求示例

4.6.1 视频截图回调

4.6.2 视频语音片段回调

4.6.1 视频截图回调

4.6.2 视频语音片段回调

5. 视频流结束回调

5.1 请求参数说明🔥🔥🔥

JSON 参数说明

5.2 视频流结束状态回调示例

5.2.1 正常结束

5.2.2 异常结束

5.2.1 正常结束

5.2.2 异常结束

6. 更新日志