查询流程摘要

1. 接口描述

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

查询流程摘要适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。日调用量默认10W

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFlowBriefs。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，本接口不需要传递此参数。
Operator	是	UserInfo	调用方用户信息，userId 必填
FlowIds.N	是	Array of String	需要查询的流程ID列表，限制最大100个
Agent	否	Agent	代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

3. 输出参数

参数名称	类型	描述
FlowBriefs	Array of FlowBrief	流程列表
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取流程简要信息

获取流程简要信息

输入示例

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

{
    "Operator": {
        "UserId": "yDxM6UyK********QDV8dJUuO4zjEu"
    },
    "FlowIds": [
        "c7b5ca37ae*******2b4c6644",
        "61a82f0c1******d0d807"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "s123456789",
        "FlowBriefs": [
            {
                "FlowId": "c7b5ca37ae*******2b4c6644",
                "FlowName": "测试合同-1",
                "FlowDescription": "测试流程的描述信息",
                "FlowType": "合同",
                "FlowStatus": 1,
                "CreatedOn": 1604910798,
                "FlowMessage": ""
            },
            {
                "FlowId": "61a82f0c1******d0d807",
                "FlowName": "测试合同-2",
                "FlowDescription": "测试流程的描述信息",
                "FlowType": "合同",
                "FlowStatus": 1,
                "CreatedOn": 1604910797,
                "FlowMessage": ""
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation	操作失败。
FailedOperation.AccountVerifyFail	实名认证失败。
InternalError	内部错误。
InternalError.Cache	缓存错误。
InternalError.Db	数据库异常。
InternalError.DbRead	内部错误,数据库查询失败,请稍后重试。
InternalError.Decryption	解密失败。
InternalError.DependsApi	依赖的第三方API返回错误。
InternalError.DependsDb	数据库执行错误。
InternalError.Encryption	加密失败。
InternalError.System	系统错误，请稍后重试。
InvalidParameter	参数错误。
InvalidParameter.DataExists	数据已存在。
InvalidParameter.DataNotFound	数据不存在。
InvalidParameter.InvalidChannel	Channel不正确。
InvalidParameter.InvalidOpenId	OpenId不正确。
InvalidParameter.InvalidOperatorId	操作人ID不正确。
InvalidParameter.InvalidOrganizationId	机构ID不正确。
InvalidParameter.InvalidOrganizationName	组织机构名称不正确。
InvalidParameter.InvalidRoleId	角色ID不正确。
InvalidParameter.InvalidRoleName	角色名称不正确。
InvalidParameter.InvalidVerifyChannel	实名认证渠道不正确。
InvalidParameter.InvalidVerifyCode	验证码不正确。
InvalidParameter.ParamError	参数错误。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
MissingParameter.FlowId	缺少签署流程id，请检查修改后重试。
OperationDenied	操作被拒绝。
OperationDenied.Forbid	禁止此项操作。
OperationDenied.NoIdentityVerify	未通过个人实名认证。
OperationDenied.NoLogin	用户未登录,请先登录后再操作。
OperationDenied.OrganizationNotActivated	企业未激活。
OperationDenied.OutQueryLimit	查询限频，请先联系客服了解限频策略，稍后重试。
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceNotFound.Application	应用号不存在或已删除。
ResourceNotFound.Flow	签署流程未找到，请检查参数。
ResourceNotFound.Resource	未获取到文件资源，请检查资源是否完成上传，是否有效，并在修改后重试。
ResourceUnavailable	资源不可用。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 获取流程简要信息​

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​