腾讯电子签导出合同对比任务详情

1. 接口描述

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

本接口（ExportContractComparisonTask）用于导出指定的合同对比任务的结果文件。任务完成后，用户可根据不同的使用场景，选择导出可视化对比报告（PDF）或结构化差异明细（EXCEL）。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ExportContractComparisonTask。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行合同审查任务的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
TaskId	是	String	合同对比任务ID，该参数通过调用接口CreateContractComparisonTask获取。示例值：yD***ob
ExportType	否	Integer	导出对比结果文件类型。类型如下： 0：【PDF】以新合同文件为基础，导出带有可视化对比点标注的PDF文件。 1：【EXCEL】导出结构化的对比点明细表格，以列表形式罗列每一个差异点，包含改动位置、类型、标签及修改前后的完整内容。示例值：1
Ignore	否	Boolean	是否忽略，适用于PDF。 true：导出文件标注去掉忽略项。 false：导出文件包含所有对比点。示例值：true

3. 输出参数

参数名称	类型	描述
ResourceUrl	String	对比任务详情下载链接。示例值：https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF
ExpireTime	Integer	下载链接有效截止时间。示例值：1760009219
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 导出合同对比任务详情

输入示例

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

{
    "Operator": {
        "UserId": "yDwqbUUckp3o2rzmUxHsV0j1FlhYIKo7"
    },
    "TaskId": "yDtrrUUckp94goxhUyjVZ8rSEQ0lg7vb",
    "ExportType": 1,
    "Ignore": true
}

输出示例

{
    "Response": {
        "ExpireTime": 1760182715,
        "RequestId": "s1760182415600292411",
        "ResourceUrl": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.PDF?hkey=*****************"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError.Db	数据库异常。
InvalidParameter	参数错误。
OperationDenied	操作被拒绝。

导出合同对比任务详情

本页目录：