有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

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

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

默认接口请求频率限制: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: 审核拒绝
  • SIGN_REJECT:拒签(流程结束)
Agent Agent 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
RecipientId String 审核节点的签署人标志,用于指定当前审核的签署方
  • 如果签署审核节点是个人, 此参数必填
OperateType String 操作类型:(接口通过该字段区分不同的操作类型)

  • SignReview: 签署审核(默认)
  • CreateReview: 创建审核


如果审核节点是个人,则操作类型只能为SignReview。
ReviewMessage String 审核结果原因
  • 字符串长度不超过200
  • 当ReviewType 是拒绝(REJECT) 时此字段必填。
  • 当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。


3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
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 请升级到对应版本后即可使用该接口。