跳到主要内容

新建审查要点清单web页面

1. 接口描述

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

此接口(CreateContractReviewChecklistWebUrl)用来创建新建审查要点清单web页面链接(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。

适用场景:根据合同内容识别出合同的风险信息。审查结果由AI生成,仅供参考。请结合相关法律法规和公司制度要求综合判断。

注意: 如果文件资源为word类型生成的链接不能进行iframe嵌入,需要在单独窗口打开

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:CreateContractReviewChecklistWebUrl。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。使用此接口时,必须填写userId。

注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。

3. 输出参数

参数名称类型描述
WebUrlString嵌入式web页面链接。注意:链接有效期为5分钟,且链接仅能使用一次。
示例值:https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDt4AUUckp9qgovnUy2vfEF8hYOjMMYZ&channel=TENCENTCLOUD&embedType=CONTRACT_REVIE
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新建审查要点清单web页面

输入示例

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

{
"Operator": {
"UserId": "yDtzDUUcpfhltUxpgD3IvZBJ10dg"
}
}

输出示例

{
"Response": {
"RequestId": "4e0ea7ed-6f15-40ea-888b-19b67270254e",
"WebUrl": "https://embed.test.qian.tencent.cn/ai-contract-review?embed=1&code=yDtO7UUckpft9ureUxJPqXtCggpiZ9iW&channel=TENCENTCLOUD&embedType=CONTRACT_REVIEW&action=CreateChecklist&shortKey=yDtO7UAApxPiHOuJcC9b"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
InternalError.Api第三方接口失败。
InternalError.Db数据库异常。
InternalError.DependsApi依赖的第三方API返回错误。
InvalidParameterValue参数取值错误。
OperationDenied操作被拒绝。
ResourceNotFound资源不存在。
更多开发者交流反馈