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

获取合同审查任务详情

最近更新时间：2025-08-26 01:47:52

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeContractReviewTask）用于获取合同审查任务详情，包括任务的状态和识别出的风险信息。

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
ChecklistId String 用于审查任务的审查清单ID。注意：如果用户没有配置清单时此值可能为空，需要等大模型根据合同内容推荐出可以使用的审查清单。
示例值：yDtCMUUckpx3boo7Uyxx4vx0j0a6Ii
CreatedOn Integer 合同审查任务创建时间。
示例值：1753417470
FinishedOn Integer 合同审查任务完成时间。
示例值：1753417470
PolicyType Integer 合同审查的审查立场方。

审查立场方如下：

  • 0 - 【严格】以保护己方利益为核心，对合同条款进行严格把控，尽可能争取对己方有利的条款，同时对对方提出的不合理条款可进行坚决修改或删除。

  • 1 - 【中立】以公平合理为原则，平衡双方的权利义务，既不过分强调己方利益，也不过度让步，力求达成双方均可接受的条款。

  • 2 - 【宽松】以促成交易为核心，对合同条款的修改要求较为宽松，倾向于接受对方提出的条款，以尽快达成合作。


示例值：0
ResourceId String 合同审查的PDF文件资源ID。
示例值：yDtCMUUckpx3boo7Uyxx4vx0j0a6Ii
Risks Array of OutputRisk 合同审查识别出的PDF文件风险信息，如果是空数组表示无风险。

注意：审查结果由AI生成，仅供参考。请结合相关法律法规和公司制度要求综合判断。
Role RiskIdentificationRoleInfo 合同审查中的角色信息。注意： 如果用户没有配置审查角色时此值可能为null，需要等大模型根据合同内容推荐出审查角色信息。
注意：此字段可能返回 null，表示取不到有效值。
Status Integer 合同审查任务状态。
状态如下：

  • 1 - 合同审查任务创建成功

  • 2 - 合同审查任务排队中

  • 3 - 合同审查任务执行中

  • 4 - 合同审查任务执行成功

  • 5 - 合同审查任务执行失败


示例值：4
TaskId String 合同审查任务ID
示例值：yDtIFUU2tnsxz7UulGxxx4WkTq
Comment String 审查任务备注信息，长度不能超过100个字符
示例值：wu
UserData String 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 1024长度。

在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
示例值：QmFzZTY0IEJhc2U2NCA
HighRiskCount Integer 合同审查出的高风险项数量
示例值：5
TotalRiskCount Integer 合同审查出的风险总数
示例值：10
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询合同审查任务详情

输入示例

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

{
    "Operator": {
        "UserId": "yDwJGxxrmBe"
    },
    "TaskId": "yDtIFxxxq"
}

输出示例

{
    "Response": {
        "ChecklistId": "yDtCMxxxxIi",
        "CreatedOn": 1753417470,
        "FinishedOn": 1753417684,
        "PolicyType": 2,
        "RequestId": "s1753417731216986125",
        "ResourceId": "yDtG1UUxxxEsrBwa",
        "Risks": [
            {
                "Content": "第三十二条乙方应当保守甲方的商业秘密，商业秘密系指不为公众所知悉，能为甲方带来经济利益，具有实用性并经甲方采取保密措施的技术秘密和经营信息。包括但不限于下述内容:",
                "RiskAdvice": "建议在第三十二条后增加：「乙方离职后的竞业限制期限不得超过两年，竞业限制补偿金标准为......」",
                "RiskBasis": "【通用商业合同审查清单】{特殊类型合同补充要点}, 系统审查要求。",
                "RiskDescription": "保密条款未明确竞业限制期限，存在超出法定期限的法律风险，可能被认定为无效条款。",
                "RiskId": "yDtIFUU2tnxxxKveWxm",
                "RiskLevel": "NORMAL",
                "RiskName": "竞业限制期限缺失",
                "RiskPresentation": [
                    "不符合清单要求"
                ]
            }
        ],
        "Role": {
            "Description": "",
            "Name": "授权方"
        },
        "Status": 4,
        "TaskId": "yDtIFxxxq"
    }
}

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 内部错误。
InternalError.DependsApi 依赖的第三方API返回错误。
InternalError.DependsDb 数据库执行错误。
InternalError.System 系统错误，请稍后重试。
InvalidParameter.ParamError 参数错误。
OperationDenied 操作被拒绝。
OperationDenied.NoLogin 用户未登录,请先登录后再操作。
中国站
目录