提交合同组签署流程审批结果
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
- 在使用通过多文件创建合同组签署流程或通过多模板创建合同组签署流程创建合同组签署流程时,若指定了参数以下参数为true,则可以调用此接口提交企业内部签署审批结果,即使是自动签署也需要进行审核通过才会进行签署。
- 同一合同组,同一签署人可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateFlowGroupSignReview。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 |
FlowGroupId | 是 | String | 合同(流程)组的合同组Id,为32位字符串,通过接口通过多文件创建合同组签署流程 或通过多模板创建合同组签署流程创建合同组签署流程时返回。 示例值:yDSxIUUckpt1ea9hUx5oXYkSgVNJaxOE |
ReviewType | 是 | String | 提交的审核结果,审核结果有下面三种情况
示例值:PASS |
ApproverInfo | 是 | NeedReviewApproverInfo | 需要进行签署审核的签署人的个人信息或企业信息,签署方的匹配方式按照以下规则: 个人:二选一(选择其中任意信息组合即可)
企业:二选一 (选择其中任意信息组合即可)
|
ReviewMessage | 否 | String | 审核不通过的原因,该字段的字符串长度不超过200个字符。 注: 当审核类型(ReviewType)为审核拒绝(REJECT)或拒签(SIGN_REJECT)时,审核结果原因字段必须填写 示例值:这个合同里边的价格写错了 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通过姓名+证件类型+证件号通过某个个人签署人的签署阻断
1.签署审核通过企业签署人(ApproverType 设置为PERSON) 2.使用 姓名 + 手机号 定位合同组内所有子合同的该签署人 3.拒绝(阻断)该签署人的签署操作 (ReviewType 设置为REJECT)
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowGroupSignReview
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"FlowGroupId": "yDSxIUUckpt1ea9hUx5oXYkSgVNJaxOE",
"ReviewType": "REJECT",
"ReviewMessage": "不能签署",
"ApproverInfo": {
"ApproverName": "典子谦",
"ApproverIdCardNumber": "620000198802020000",
"ApproverIdCardType": "ID_CARD",
"ApproverType": "PERSON"
}
}
输出示例
{
"Response": {
"RequestId": "s1703576009516564065"
}
}
示例2 示例1 通过企业名称+姓名+手机号通过某个企业签署人的签署阻断
1.签署审核通过企业签署人(ApproverType 设置为ORGANIZATION) 2.使用企业名称 + 姓名 + 手机号 定位合同组内所有子合同的该签署人 3.通过该签署人的签署审核(该签署人可以进行签署操作)(ReviewType 设置为PASS)
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowGroupSignReview
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"FlowGroupId": "yDSxIUUckpt1ea9hUx5oXYkSgVNJaxOE",
"ReviewType": "PASS",
"ReviewMessage": "可以签署",
"ApproverInfo": {
"ApproverType": "ORGANIZATION",
"ApproverName": "典子签",
"OrganizationName": "典子签示例企业",
"ApproverMobile": "18200000000"
}
}
输出示例
{
"Response": {
"RequestId": "s1703576009516564064"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.NotAvailableSignReview | 当前合同状态无法进行签署审批。 |
InternalError | 内部错误。 |
InternalError.Db | 数据库错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameter.Status | 状态异常。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.NoFlowPermission | 无权操作合同。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Flow | 未找到对应流程。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |