提交申请出证报告任务
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
提交申请出证报告任务并返回报告ID。
注意：
- 使用此功能需搭配出证套餐 ，使用前请联系对接的客户经理沟通。
- 操作人必须是发起方或者签署方企业的(非走授权书认证)法人或者超管。
- 合同流程必须所有参与方已经签署完成。
- 出证过程需一定时间，建议在提交出证任务后的24小时之后，通过获取出证报告任务执行结果接口进行查询执行结果和出证报告的下载URL。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateChannelFlowEvidenceReport。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 示例值： |
| FlowId | 是 | String | 合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 示例值：yDwFdUUckpsw**yQ0af8bHosXQtb |
| ReportType | 否 | Integer | 指定申请的报告类型，可选类型如下：
示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReportId | String | 出证报告 ID，可用于获取出证报告任务执行结果查询出证任务结果和出证PDF的下载URL 注意：此字段可能返回 null，表示取不到有效值。 示例值：yDSLVUUckpo3nva8UEnf33kvzHQ19GcL |
| Status | String | 出证任务执行的状态, 状态含义如下：
示例值：EvidenceStatusExecuting |
| ReportUrl | String | 废除，字段无效 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建并返回出证报告
通过已完成签署的流程FlowId，发起出证请求，获取出证报告的ID。
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateChannelFlowEvidenceReport
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"FlowId": "yDSLVUUckpo1c11xUxtOq8cvKy24by9M",
"ReportType": 0
}
输出示例
{
"Response": {
"ReportId": "yDSLVUUckpo3nva8UEnf33kvzHQ19GcL",
"Status": "EvidenceStatusSuccess",
"ReportUrl": "",
"RequestId": "78062b87-6571-4f9a-b7a2-ba2d8d6c6698"
}
}
示例2 创建并返回公证处核验报告
通过已完成签署的流程FlowId，发起出证请求，获取公证处核验报告的ID。
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateChannelFlowEvidenceReport
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"FlowId": "yDSLVUUckpo1c11xUxtOq8cvKy24by9M",
"ReportType": 1
}
输出示例
{
"Response": {
"ReportId": "yDSLVUUckpo3nva8UEnf33kvzHQ19GcL",
"Status": "EvidenceStatusSuccess",
"ReportUrl": "",
"RequestId": "78062b87-6571-4f9a-b7a2-ba2d8d6c6698"
}
}
示例3 流程未签署完，请求出证失败
流程FlowId必须处于全部签署完成的状态，否则请求将无法成功。
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateChannelFlowEvidenceReport
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"FlowId": "yDSLVUUckpo1c11xUxtOq8cvKy24by9M"
}
输出示例
{
"Response": {
"Error": {
"Code": "OperationDenied.FlowStatusForbid",
"Message": "当前流程状态不支持出证"
},
"RequestId": "78062b87-6571-4f9a-b7a2-ba2d8d6c6698"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError.System | 系统错误。 |
| MissingParameter.FlowId | 缺少流程id，请检查后重试。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.FlowStatusForbid | 签署流程状态不正确，请检查后重试。 |
| OperationDenied.NotBelongSuperAdminOrLegalPerson | 不属于企业超管或者法人。 |
| OperationDenied.ProveNoQuota | 出证计费额度不足。 |
| OperationDenied.WhiteListForbid | 接口功能暂未开放，请联系客户经理申请白名单使用 |
| ResourceNotFound.Flow | 未找到对应流程。 |
| ResourceNotFound.FlowApprover | 签署流程的签署人不存在，请检查后重试。 |
| ResourceNotFound.URL | Url不存在。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |