提交企业签署流程审批结果
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
提交企业流程审批结果 当前存在两种审核操作:
- 签署审核
- 在通过接口
- CreateFlowsByTemplates
- ChannelCreateFlowByFiles
- ChannelCreateFlowGroupByTemplates
- ChannelCreateFlowGroupByFiles
- ChannelCreatePrepareFlow
- 在通过接口
- CreateFlowsByTemplates
- ChannelCreateFlowByFiles
- ChannelCreateFlowGroupByTemplates
- ChannelCreateFlowGroupByFiles
- 在通过接口
- 发起审核
- 通过接口ChannelCreatePrepareFlow指定发起后需要审核,那么可以调用此接口,并指定operate=CreateReview,以提交企业内部审批结果。可以多次提交审批结果,但一旦审批通过,后续提交的结果将无效
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateFlowSignReview。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经经过实名认证 |
FlowId | 是 | String | 合同流程ID,为32位字符串。 示例值:yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc |
ReviewType | 是 | String | 企业内部审核结果
示例值:REJECT |
ReviewMessage | 否 | String | 审核结果原因
示例值:合同里边的价格写错了 |
RecipientId | 否 | String | 审核节点的签署人标志,用于指定当前审核的签署方。 注意:以下情况必须传递RecipientId
示例值:yDRS4UUgygqdcj56UuO4zjExBQcOiB68 |
OperateType | 否 | String | 流程审核操作类型,取值如下:
示例值:CreateReview |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 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 | 操作不支持。 |