腾讯电子签创建合同对比任务

1. 接口描述

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

此接口（CreateContractComparisonTask）用于创建合同对比任务。
适用场景：对比两份合同中字段（如：金额、日期、甲方名称等）的内容差异。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateContractComparisonTask。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行合同审查任务的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
OriginFileResourceId	是	String	原版文件ID，对比基准的旧版本文件唯一标识，通过UploadFiles接口获取文件资源ID。示例值：yD***Cj
DiffFileResourceId	是	String	新版文件ID，与旧版进行对比的新版本文件唯一标识，通过UploadFiles接口获取文件资源ID。示例值：yD***Ed
Comment	否	String	对比任务备注，长度不能超过50个字符。示例值：这是一项对比任务
UserData	否	String	调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。示例值：QmFzZTY0IEJhc2U2NCA
Tags.N	否	Array of Tag	标签列表，用户自定义的键值对（Key-Value），可绑定到资源上，用于资源的分类、管理和访问控制。

3. 输出参数

参数名称	类型	描述
UserData	String	调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。示例值：QmFzZTY0IEJhc2U2NCA
TaskId	String	合同对比任务ID，可以调用接口查询合同对比任务结果查看对比任务的结果。示例值：yD***Qi
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建合同对比任务

此接口（CreateContractComparisonTask）用于创建合同对比任务。
适用场景：对比两份合同中字段（如：金额、日期、甲方名称等）的内容差异。

输入示例

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

{
    "Operator": {
        "UserId": "yD*****************ZC"
    },
    "DiffFileResourceId": "yD***************yQ",
    "OriginFileResourceId": "yD**************Xy",
    "Comment": "这是一个合同对比任务",
    "UserData": "QmFzZTY0IEJhc2U2NCA",
    "Tags": [
        {
            "TagKey": "电子签",
            "TagValue": "对比任务"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "s1760425670608827095",
        "TaskId": "yD*************Ks",
        "UserData": "QmFzZTY0IEJhc2U2NCA"
    }
}

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. 错误码

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

错误码	描述
InternalError.Db	数据库异常。
InternalError.Mq	消息队列失败
InvalidParameterValue	参数取值错误。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。

创建合同对比任务

本页目录：