跳到主要内容

提交企业签署流程审批结果

1. 接口描述

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

提交企业流程审批结果 当前存在两种审核操作:

  • 签署审核
    • 在通过接口
      • CreateFlowsByTemplates
      • ChannelCreateFlowByFiles
      • ChannelCreateFlowGroupByTemplates
      • ChannelCreateFlowGroupByFiles
      • ChannelCreatePrepareFlow
      发起签署流程时,通过指定NeedSignReview为true,则可以调用此接口,并指定operate=SignReview,以提交企业内部签署审批结果
    • 在通过接口
      • CreateFlowsByTemplates
      • ChannelCreateFlowByFiles
      • ChannelCreateFlowGroupByTemplates
      • ChannelCreateFlowGroupByFiles
      发起签署流程时,通过指定签署人ApproverNeedSignReview为true,则可以调用此接口,并指定operate=SignReview,并指定RecipientId,以提交企业内部签署审批结果
  • 发起审核
    • 通过接口ChannelCreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelCreateFlowSignReview。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
FlowIdString合同流程ID,为32位字符串。
示例值:yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc
ReviewTypeString企业内部审核结果
  • PASS: 审核通过(流程可以继续签署或者发起)
  • REJECT: 审核拒绝(流程状态不变,可以继续调用审核接口通过审核)
  • SIGN_REJECT:拒签(流程终止,流程状态变为拒签状态)

示例值:REJECT
ReviewMessageString审核结果原因
  • 字符串长度不超过200
  • 当ReviewType 是拒绝(REJECT) 时此字段必填。
  • 当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。

示例值:合同里边的价格写错了
RecipientIdString审核节点的签署人标志,用于指定当前审核的签署方
  • 如果签署审核节点是个人, 此参数必填

示例值:yDRS4UUgygqdcj56UuO4zjExBQcOiB68
OperateTypeString流程审核操作类型,取值如下:
  • SignReview:(默认)签署审核
  • CreateReview:发起审核
  • 注意:该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程



示例值:CreateReview

3. 输出参数

参数名称类型描述
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 提交企业签署流程审批结果(通过审核)

提交企业签署流程审批结果(通过审核:ReviewType=PASS)

输入示例

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

{
"Agent": {
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyOrganizationOpenId": "org_dianziqian",
"AppId": "yDRS4UUgygqdcj8xUuO4zjEwOT8IN9Ec"
},
"FlowId": "yDRS4UUgygqdcjjhUuO4zjEBpXdcsHWX",
"ReviewType": "PASS",
"ReviewMessage": "企业内部审核通过,允许签署"
}

输出示例

{
"Response": {
"RequestId": "e8b48d05-c6b0-4b82-a218-fbc1f45aefa9"
}
}

5. 错误码

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

错误码描述
FailedOperation.NotAvailableSignReview当前合同状态无法进行签署审批。
InternalError内部错误。
InternalError.Db数据库错误。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
InvalidParameter.Status状态异常。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
OperationDenied.NoFlowPermission无权操作合同。
ResourceNotFound资源不存在。
ResourceNotFound.Flow未找到对应流程。
ResourceUnavailable资源不可用。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062