提交企业签署流程审批结果
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
提交企业流程审批结果 目前存在两种审核操作,签署审核,发起审核 签署审核:通过接口(CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow)发起签署流程后,若指定了参数 NeedSignReview 为true,则可以调用此接口,指定operate=SignReview,提交企业内部签署审批结果;若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效
发起审核:通过接口ChannelCreatePrepareFlow指定发起后需要审核,则可以通过调用此接口,指定operate=CreateReview,提交企业内部审批结果,可多次提交,当通过后,后续提交结果无效
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateFlowSignReview。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 |
FlowId | 是 | String | 签署流程编号 示例值:xxx |
ReviewType | 是 | String | 企业内部审核结果 PASS: 通过 REJECT: 拒绝 SIGN_REJECT:拒签(流程结束) 示例值:xxx |
ReviewMessage | 否 | String | 审核原因 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200 |
RecipientId | 否 | String | 签署节点审核时需要指定,给个人审核时必填。 示例值:32984r94w8f |
OperateType | 否 | String | 操作类型,默认:SignReview;SignReview:签署审核,CreateReview:发起审核 注:接口通过该字段区分操作类型 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程 若想使用发起审核,请指定该字段为:CreateReview 若发起个人审核,则指定该字段为:SignReview |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交企业签署流程审批结果
提交企业签署流程审批结果
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateFlowSignReview
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "622201xxxx508023314"
},
"ProxyOrganizationOpenId": "shaxxxxang-testorg-pay",
"AppId": "15edb41xxxxff533ac0185ebb0b"
},
"FlowId": "id",
"ReviewType": "PASS",
"ReviewMessage": "企业内部审核通过,允许签署"
}
输出示例
{
"Response": {
"RequestId": "s16221xxxx12775546"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.NotAvailableSignReview | 当前合同状态无法进行签署审批。 |
InternalError | 内部错误。 |
InternalError.Db | 数据库错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameter.Status | 状态异常。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.NoFlowPermission | 无权操作合同。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Flow | 未找到对应流程。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |