跳到主要内容

查询智能合同起草任务

1. 接口描述​

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

此接口（DescribeDraftContractByPromptsTask）用于查询智能合同起草任务状态。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeDraftContractByPromptsTask。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
TaskId是String任务id
示例值：yD3a5UUs1b****Hu4sn4VpzPXtIy

3. 输出参数​

参数名称类型描述
StatusInteger任务状态，枚举，0 已创建，1 执行中，2 成功，3 失败
示例值：2
MessageString任务错误信息，仅在失败时返回
示例值：需求校验未通过: 该需求意图为“买卖合同”*，属于严重违法犯罪行为，内容违法违规，无法用于生成任何合同。
ContractNameString生成的合同名称
示例值：软件开发服务合同
ResourceIdString生成的合同文件资源id
示例值：yD3a5UUs1i****UEMs3KDC7ewKOitKTm
ContractUrlString生成的合同文件下载链接，有效期2小时
示例值：https://file.test.ess.tencent.cn/
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 查询起草任务结果​

输入示例​

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

{
    "Operator": {
        "UserId": "yDCZcUUpn********ZGci8dkgk03ZIow"
    },
    "TaskId": "yD3a5UUs1b********Hu4sn4VpzPXtIy"
}

输出示例​

{
    "Response": {
        "ContractName": "软件开发服务合同",
        "Message": "需求校验未通过: 该需求意图为“**买卖合同”*******，属于严重违法犯罪行为，内容违法违规，无法用于生成任何合同。",
        "ResourceId": "yD3a5UUs1i****UEMs3KDC7ewKOitKTm",
        "Status": 2,
        "RequestId": "47c5c8a5-e32d-4ba1-bbd2-25cc41ea96f9",
        "ContractUrl": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.DOCX?hkey=483e25687aa346406a47bb85ebd2a3c344ccd82e8f1bdcd0b*****c619366746dd65aa9b2877d**e**a1c73802075f7d71d2c8471**79c**c6ea5761c943d3181de0a**dd0bd**b4137abc57b33fe151d6*519399f0***570f12cfc97e07314*"
    }
}

5. 错误码​

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

错误码描述
InternalError内部错误。
ResourceNotFound.NotExistResource指定的资源不存在。
更多开发者交流反馈