跳到主要内容

查询流程基础信息

1. 接口描述​

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

查询流程基础信息，主要用于查询合同的状态信息。可以配合回调通知使用。

注: 每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeFlowBriefs。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
FlowIds.N是Array of String查询的合同流程ID列表最多支持100个流程ID。

如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。

可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。点击查看FlowId在控制台中的位置
示例值：[yDRCLUUgygq2xun5UuO4zjEwg0vjoimj]
Agent否Agent代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数​

参数名称类型描述
FlowBriefsArray of FlowBrief合同流程基础信息列表，包含流程的名称、状态、创建日期等基本信息。
注：与入参 FlowIds 的顺序可能存在不一致的情况。
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 获取流程基础信息​

获取流程基础信息, 例子中查询2个合同流程的基础信息

输入示例​

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

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "FlowIds": [
        "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
        "yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R"
    ]
}

输出示例​

{
    "Response": {
        "RequestId": "s123456789",
        "FlowBriefs": [
            {
                "FlowId": "yDxbWUyKQDx7OZUuO4zjESvEkRMHc55R",
                "FlowName": "张三的入职合同",
                "FlowDescription": "张三10230822日入职需要签署的合同",
                "FlowType": "入职合同",
                "FlowStatus": 1,
                "CreatedOn": 1604910798,
                "FlowMessage": "",
                "Deadline": 1606910798,
                "Creator": "yDxbWUyKQDxPGGUuO4zjEyI4pZLqE2gh"
            },
            {
                "FlowId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
                "FlowName": "采购1000台MacMini2合同",
                "FlowDescription": "8G256G配置电脑采购",
                "FlowType": "采购销售",
                "FlowStatus": 1,
                "CreatedOn": 1604910797,
                "FlowMessage": "",
                "Deadline": 1606910798,
                "Creator": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
            }
        ]
    }
}

示例2 获取流程基础信息失败情况​

获取流程基础信息, 但是没有对应合同流程的权限, 所以失败

输入示例​

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

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "FlowIds": [
        "yDwqYUZzwwjn1UEq1XhgvJVGELPHP6pB"
    ]
}

输出示例​

{
    "Response": {
        "Error": {
            "Code": "OperationDenied",
            "Message": "无查看权限, 请检查"
        },
        "RequestId": "s1692325082060040872"
    }
}

5. 错误码​

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

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