文档中心>API 中心

查询智慧表单任务状态

最近更新时间:2024-08-30 01:57:14

我的收藏

1. 接口描述

此接口处于预下线状态 。

预计下线时间:2024-11-27 10:18:09

接口请求域名: ocr.tencentcloudapi.com 。

智慧表单产品已下线,需要下线相关API

支持查询智能表单录入任务的状态。本产品免费公测中,您可以点击demo(超链接:https://ocr.smartform.cloud.tencent.com/)试用,如需购买请与商务团队联系。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetTaskState。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。
TaskId String 智慧表单任务唯一身份ID
示例值:"209fef6e-117c-11ed-9368-525400e51a47"

3. 输出参数

参数名称 类型 描述
TaskState Integer 1:任务识别完成,还未提交
2:任务已手动关闭
3:任务已提交
4:任务识别中
5:超时:任务超过了可操作的24H时限
6:任务识别失败
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询智慧表单任务状态

查询智慧表单任务状态

输入示例

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTaskState
Version:2018-11-19
Region:ap-beijing
<公共请求参数>

{
    "TaskId": "209fef6e-117c-11ed-9368-525400e51a47"
}

输出示例

{
    "Response": {
        "TaskState": 1,
        "RequestId": "a857a857-cb70-4oo4-12hv-909967tbc2bc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DbError 数据库异常。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。