腾讯电子签获取合同智能提取任务详情

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

本接口（DescribeInformationExtractionTask）用于获取合同智能提取任务详情，包括任务的状态和提取的字段结果信息。

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInformationExtractionTask。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
TaskId	否	String	合同智能提取任务ID，该参数通过调用接口批量创建合同智能提取任务接口获取。示例值：yDRS4UUgygqdcj56UuO4zjExBQcOiB68

3. 输出参数

参数名称	类型	描述
Fields	Array of ExtractionField	信息提取任务结果示例值：[{"Description":"PDF文件中的机构名称","Name":"机构名称","Type":"TEXT","Values":["广州xxxx有限公司"]},{"Description":"","Name":"社会信用代码","Type":"TEXT","Values":["91440xxxxT"]}]
Status	Integer	合同智能提取任务状态。状态如下： 0 - 任务创建成功（还未执行） 1 - 排队中（等待执行） 2 - 提取中（正在执行） 3 - 提取成功 4 - 提取失败示例值：3
Url	String	合同智能提取结果下载，文件格式为`xlsx`。注意：`链接有效期为5分钟，过期后可重新获取` 示例值：https://file.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=cxx
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取合同智能提取任务详情

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInformationExtractionTask
<公共请求参数>

{
    "Operator": {
        "UserId": "yDx************************xxx"
    },
    "TaskId": "yDx************************yyy"
}

输出示例

{
    "Response": {
        "Fields": [
            {
                "Name": "甲方",
                "Values": [
                    "张三",
                    "李四"
                ],
                "Type": "Text",
                "Description": "提取甲方信息"
            }
        ],
        "Status": 3,
        "Url": "https://file.ess.tencent.cn/bresource/resource/resource/0/0.XLSX?hkey=c83cf852247f9075f675f350e6d6ebeda61fa2d74d136f8efccdde201dc72cb280dcd8992c91808c55817c57c4bf87f718adfa54bf152500e9a45beb6cc9f697a0c938dc46f2abe3288a77d1fddf145d4cd2027ed8e4b6030b2f95355be37221",
        "RequestId": "s1735294966632123121"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.DependsApi	依赖的第三方API返回错误。
InternalError.DependsDb	数据库执行错误。
InternalError.System	系统错误，请稍后重试。
InvalidParameter.ParamError	参数错误。
OperationDenied	操作被拒绝。
OperationDenied.NoLogin	用户未登录,请先登录后再操作。

获取合同智能提取任务详情

本页目录：