提交签署流程审批结果
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
提交企业流程审批结果 当前存在两种审核操作:
- 签署审核
- 在通过接口
- CreateFlowByFiles
- CreateFlow
- CreateFlowGroupByTemplates
- CreateFlowGroupByFiles
- CreatePrepareFlow
- 在通过接口
- CreateFlowByFiles
- CreateFlow
- CreateFlowGroupByTemplates
- CreateFlowGroupByFiles
- 在通过接口
- 发起审核
- 通过接口CreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效(审核对象:本企业合同发起方的发起动作)
对应发起人在发起合同的最后环节会有提交审批的按钮:
对应签署人在签署页面会看到下面的提示:
默认接口请求频率限制:300次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateFlowSignReview。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
FlowId | 是 | String | 合同流程ID,为32位字符串。
示例值:yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy |
ReviewType | 是 | String | 企业内部审核结果
示例值:PASS |
Agent | 否 | Agent | 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填 |
RecipientId | 否 | String | 审核节点的签署人标志,用于指定当前审核的签署方
示例值:yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP |
OperateType | 否 | String | 操作类型:(接口通过该字段区分不同的操作类型)
如果审核节点是个人,则操作类型只能为SignReview。 示例值:SignReview |
ReviewMessage | 否 | String | 审核结果原因
示例值:合同内容错误 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交企业签署流程审批结果通过
提交企业签署流程审批结果通过
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowSignReview
<公共请求参数>
{
"Operator": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
},
"FlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
"ReviewType": "PASS",
"ReviewMessage": "企业内部审核通过,允许签署"
}
输出示例
{
"Response": {
"RequestId":