跳到主要内容

提交签署流程审批结果

1. 接口描述​

接口请求域名： ess.tencentcloudapi.com 。

提交签署流程审批结果的适用场景包括：

  1. 在使用模板（CreateFlow）或文件（CreateFlowByFiles）创建签署流程时，若指定了参数NeedSignReview为true，且发起方企业作为签署方参与了流程签署，则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。
  2. 若签署流程状态正常，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。

默认接口请求频率限制：300次/秒。

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateFlowSignReview。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
FlowId是String合同流程ID，为32位字符串。
建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
ReviewType是String企业审核结果
  • PASS: 通过

  • REJECT: 拒绝
ReviewMessage否String审核结果原因，
字符串长度不超过200
当ReviewType 是拒绝（REJECT） 时此字段必填。
Agent否Agent代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
RecipientId否String审核签署节点人标识，
用来标识审核的签署方。
如果签署审核节点是个人， 此参数必填。
OperateType否String操作类型：（接口通过该字段区分不同的操作类型）

  • SignReview: 签署审核（默认）
  • CreateReview: 创建审核


如果审核节点是个人，则操作类型只能为SignReview。

3. 输出参数​

参数名称类型描述
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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": "s1234345677xxxx"
    }
}

示例2 提交企业签署流程审批结果，结果为拒绝。​

提交企业签署流程审批结果，结果为拒绝。

输入示例​

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "FlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "ReviewType": "REJECT",
    "ReviewMessage": "合同内容姓名填写错误，不允许进行签署"
}

输出示例​

{
    "Response": {
        "RequestId": "s1234345677xxxx"
    }
}

示例3 错误示例，提交企业签署流程审批结果，没有填写原因​

错误示例，提交企业签署流程审批结果，没有填写原因

输入示例​

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "FlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "ReviewType": "REJECT"
}

输出示例​

{
    "Response": {
        "Error": {
            "Code": "InvalidParameter.ParamError",
            "Message": "审核操作原因(ReviewMessage)在取消时不能为空，请确认后重试"
        },
        "RequestId": "s1694848471031289687"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.AgeNotAchieveNormalLegal年龄限制无法使用电子签服务，请联系客服咨询处理。
FailedOperation.NotAvailableSignReview此合同流程不支持审批
FailedOperation.OrganizationExperienceChange企业经营状态与工商局信息不符。
FailedOperation.OrganizationNameChanged企业名称与工商局信息不符。
FailedOperation.OrganizationNameNeedChange企业名称与工商局信息不符,需要超管修改。
InternalError.Db数据库异常。
InternalError.DbRead内部错误,数据库查询失败,请稍后重试。
InternalError.Decryption解密失败。
InternalError.DependsApi依赖的第三方API返回错误。
InternalError.DependsDb数据库执行错误。
InternalError.Encryption加密失败。
InternalError.System系统错误，请稍后重试。
InvalidParameter.ParamError参数错误。
OperationDenied操作被拒绝。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoIdentityVerify未通过个人实名认证。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
OperationDenied.NoQuota企业额度不足，请检查企业额度后处理。
ResourceNotFound资源不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。