文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>腾讯电子签>API 文档>合同智能相关接口>查询合同对比任务结果

查询合同对比任务结果

最近更新时间：2025-10-17 01:20:29

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeContractComparisonTask）用于查询合同对比任务结果详情。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeContractComparisonTask。
Version 是 String 公共参数，本接口取值：2020-11-11。
Region 否 String 公共参数，此参数为可选参数。
Operator 是 UserInfo 执行合同审查任务的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
TaskId 是 String 合同对比任务ID，该参数通过调用接口CreateContractComparisonTask获取。
示例值：yD***ob
ShowDetail 否 Boolean 是否返回详细的对比结果。为 true时，响应中将包含详细的对比信息，如相似度、文本差异具体内容等；为 false时，仅返回任务基本状态信息。
注：详细结果数据量可能较大，请按需开启。
示例值：true

3. 输出参数

参数名称 类型 描述
TaskId String 合同对比任务ID。
示例值：yD***ob
Status Integer 合同对比任务状态。
状态如下：
  • 0：待创建（未执行）
  • 1：对比中
  • 2：对比成功
  • 3：对比失败


示例值：2
Message String 对比失败的具体原因描述，仅当状态为失败时返回此字段。
示例值：对比失败
OriginalFileResourceId String 原版文件ID，对比基准的旧版本文件唯一标识。
示例值：yD***Cj
DiffFileResourceId String 新版文件ID，与旧版进行对比的新版本文件唯一标识。
示例值：yD***Ed
Comment String 对比任务备注，长度不能超过50个字符。
示例值：这是一项对比任务
TotalDiffCount Integer 合同对比差异点总数。
示例值：10
AddDiffCount Integer 合同对比新增点数量。
示例值：4
ChangeDiffCount Integer 合同对比修改点数量。
示例值：4
DeleteDiffCount Integer 合同对比删除点数量。
示例值：2
Operator String 提交人，提交此任务或请求的用户唯一标识。
示例值：yD***dc
CreateTime Integer 合同对比任务创建时间，时间戳。
示例值：1758526698
ComparisonDetail Array of ComparisonDetail 对比差异详情，请求参数ShowDetail为true时返回。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询合同对比任务结果

本接口（DescribeContractComparisonTask）用于查询合同对比任务结果详情。

输入示例

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

{
    "Operator": {
        "UserId": "yDwqbUUckp3o2rzmUxHsV0j1FlhYIKo7"
    },
    "TaskId": "yDtrrUUckp94goxhUyjVZ8rSEQ0lg7vb"
}

输出示例

{
    "Response": {
        "AddDiffCount": 7,
        "ChangeDiffCount": 2,
        "Comment": "备注备注备注",
        "CreateTime": 1758526698,
        "DeleteDiffCount": 3,
        "DiffFileResourceId": "yDtryUUckp9tv5kcUEdITpJ9VXDn080c",
        "Message": "",
        "Operator": "yDtGuUUckp955n9yUECLj6JusBmg10dc",
        "OriginalFileResourceId": "yDtryUUckp9tv5odUEdITpJvu1v2faCj",
        "RequestId": "s1760000134519523795",
        "Status": 2,
        "TaskId": "yDtrrUUckp94goxhUyjVZ8rSEQ0lg7vb",
        "TotalDiffCount": 12
    }
}

示例2 查询合同对比任务结果（展示详情）

输入示例

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

{
    "Operator": {
        "UserId": "yDwqbUUckp3o2rzmUxHsV0j1FlhYIKo7"
    },
    "TaskId": "yDtrrUUckp94goxhUyjVZ8rSEQ0lg7vb",
    "ShowDetail": true
}

输出示例

{
    "Response": {
        "AddDiffCount": 7,
        "ChangeDiffCount": 2,
        "Comment": "测试备注",
        "ComparisonDetail": [
            {
                "ComparisonType": "delete",
                "ContentType": "text",
                "DiffText": "",
                "OriginText": "@huaxi"
            },
            {
                "ComparisonType": "change",
                "ContentType": "text",
                "DiffText": "完整地填写上",
                "OriginText": "请乙方务必准确、完整"
            },
            {
                "ComparisonType": "add",
                "ContentType": "text",
                "DiffText": "行贷款本息",
                "OriginText": ""
            }
        ],
        "CreateTime": 1760430451,
        "DeleteDiffCount": 3,
        "DiffFileResourceId": "yDtrDUUckp99jn93UE5rKNiyiKd4XGyQ",
        "Message": "",
        "Operator": "yDt49UUckp936q0sUx2QXTeCzkDPurYe",
        "OriginalFileResourceId": "yDtrDUUckp99jn9kUE5rKNiyseDep5Xy",
        "RequestId": "s1760430603916269519",
        "Status": 2,
        "TaskId": "yDtTFUUckp9elogcUudRpd6uv7cdx6Qa",
        "TotalDiffCount": 12
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError.Db 数据库异常。
InvalidParameterValue 参数取值错误。
OperationDenied 操作被拒绝。
ResourceNotFound 资源不存在。
中国站
目录