查询合同流程的详情信息

最近更新时间：2024-03-12 01:30:47

我的收藏

本页目录：

1. 接口描述

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

此接口用于查询合同流程的详情信息，支持查询多个（数量不能超过100）。

适用场景：可用于主动查询某个合同详情信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFlowInfo。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	否	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
FlowIds.N	否	Array of String	需要查询的流程ID列表，最多可传入100个ID。如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。点击查看FlowId在控制台中的位置示例值：["yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"]
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
FlowGroupId	否	String	需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。该合同组由通过多文件创建合同组签署流程等接口创建。示例值：yDwJKUUckpk3cp9kUybilmdvXgzy4Gv4

3. 输出参数

参数名称	类型	描述
FlowDetailInfos	Array of FlowDetailInfo	合同流程的详细信息。如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。
FlowGroupId	String	合同组ID，只有在查询合同组信息时才会返回。
FlowGroupName	String	合同组名称，只有在查询合同组信息时才会返回。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询合同详情

查询合同详情

输入示例

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

{
    "FlowIds": [
        "yDwhIUUf*******tSuWZWJuzI0Zv"
    ]
}

输出示例

{
    "Response": {
        "FlowDetailInfos": [
            {
                "CcInfos": [],
                "CreatedOn": 1695277267,
                "Creator": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj",
                "FlowApproverInfos": [
                    {
                        "ApproveMessage": "",
                        "ApproveName": "典子谦",
                        "ApproveStatus": 2,
                        "ApproveTime": 0,
                        "ApproveType": "PERSON",
                        "ApproverSource": "",
                        "CustomApproverTag": "",
                        "CustomUserId": "",
                        "Mobile": "13200000000",
                        "OrganizationId": "",
                        "OrganizationName": "",
                        "ReceiptId": "yDwJWUUckpkt3r17UxsD2OmvMWKhPCsC",
                        "SignId": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS",
                        "SignOrder": 0
                    },
                    {
                        "ApproveMessage": "",
                        "ApproveName": "张三",
                        "ApproveStatus": 1,
                        "ApproveTime": 0,
                        "ApproveType": "ORGANIZATION",
                        "ApproverSource": "",
                        "CustomApproverTag": "",
                        "CustomUserId": "",
                        "Mobile": "18888888888",
                        "OrganizationId": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
                        "OrganizationName": "张三示例企业",
                        "ReceiptId": "yDwJWUUckpkt3r1bUxsD2Om8NdhsvAFk",
                        "SignId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR",
                        "SignOrder": 1
                    }
                ],
                "FlowDescription": "",
                "FlowId": "yDwhIUUf*******tSuWZWJuzI0Zv",
                "FlowMessage": "",
                "FlowName": "典子谦购买腾讯云机器的协议",
                "FlowStatus": 1,
                "FlowType": "劳动合同"
            }
        ],
        "FlowGroupId": "",
        "FlowGroupName": "",
        "RequestId": "fc6c2e4b-3f0b-402c-91a4-d74e9e96369e"
    }
}

示例2 查询合同组详情

查询合同组详情

输入示例

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

{
    "FlowGroupId": "yDwJWUUcss*******MjPKFm7bzFToAyk"
}

输出示例

{
    "Response": {
        "FlowDetailInfos": [
            {
                "CcInfos": [],
                "CreatedOn": 1695279629,
                "Creator": "yDwfRUUw2vb22UESurE588OReErDv9jv",
                "FlowApproverInfos": [
                    {
                        "ApproveMessage": "",
                        "ApproveName": "张志英",
                        "ApproveStatus": 3,
                        "ApproveTime": 1695279840,
                        "ApproveType": "PERSON",
                        "ApproverSource": "",
                        "CustomApproverTag": "",
                        "CustomUserId": "",
                        "Mobile": "13200000000",
                        "OrganizationId": "",
                        "OrganizationName": "",
                        "ReceiptId": "yDwJWUUcss36hUx8VMjPR4jOb5ugrMSx",
                        "SignId": "yDwJWUUcss36rUx8VMjPwzdNESvociQv",
                        "SignOrder": 0
                    }
                ],
                "FlowDescription": "",
                "FlowId": "yDwJWUUcss*******MjPCmyDWhY5b6Ku",
                "FlowMessage": "",
                "FlowName": "个人征信查询申请表",
                "FlowStatus": 4,
                "FlowType": ""
            },
            {
                "CcInfos": [],
                "CreatedOn": 1695279629,
                "Creator": "yDwfRUUw2vb22UESurE588OReErDv9jv",
                "FlowApproverInfos": [
                    {
                        "ApproveMessage": "",
                        "ApproveName": "张志英",
                        "ApproveStatus": 3,
                        "ApproveTime": 1695279840,
                        "ApproveType": "PERSON",
                        "ApproverSource": "",
                        "CustomApproverTag": "",
                        "CustomUserId": "",
                        "Mobile": "13200000000",
                        "OrganizationId": "",
                        "OrganizationName": "",
                        "ReceiptId": "yDwJWUUcss36jUx8VMjPwPdsft773X11",
                        "SignId": "yDwJWUUcss362Ux8VMjPvn1TbsDyp85v",
                        "SignOrder": 0
                    }
                ],
                "FlowDescription": "",
                "FlowId": "yDwJWUUcss*******MjPEkLDPZBawumc",
                "FlowMessage": "",
                "FlowName": "个人征信查询授权书",
                "FlowStatus": 4,
                "FlowType": ""
            }
        ],
        "FlowGroupId": "",
        "FlowGroupName": "合同组JJ202309210000000017",
        "RequestId": "s1695280316032350176"
    }
}

示例3 查询合同详情(如果合同ID不存在或者没有权限)

如果FlowIds中某个合同ID不存在或者没有权限则会报错, 因为下面示例中的c7b5ca37ae***2b4c6644不存在所以报错

输入示例

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

{
    "FlowIds": [
        "c7b5ca37ae*******2b4c6644",
        "yDRSRUUgygj******uO4zjESlnSFPcIE"
    ]
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation",
            "Message": "无效的流程合同Id，检查后重试"
        },
        "RequestId": "s1692325082060040872"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError.System	系统错误，请稍后重试。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.Forbid	禁止此项操作。
OperationDenied.OrganizationNotActivated	企业未激活。
OperationDenied.SubOrgNotJoin	子企业暂未加入。
ResourceNotFound.Resource	未获取到文件资源，请检查资源是否完成上传，是否有效，并在修改后重试。
ResourceUnavailable	资源不可用。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

上一篇: 查询流程基础信息下一篇: 查询流程填写控件内容