查询合同（签署流程）的详细信息

1. 接口描述

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

此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFlowDetailInfo。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，本接口不需要传递此参数。
Agent	是	Agent	应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
FlowIds.N	否	Array of String	合同(流程)编号数组，最多支持100个。（备注：该参数和合同组编号必须二选一）
FlowGroupId	否	String	合同组编号（备注：该参数和合同(流程)编号数组必须二选一）
Operator	否	UserInfo	暂未开放

3. 输出参数

参数名称	类型	描述
ApplicationId	String	第三方平台应用号Id
ProxyOrganizationOpenId	String	第三方平台子客企业OpenId
FlowInfo	Array of FlowDetailInfo	合同(签署流程)的具体详细描述信息注意：此字段可能返回 null，表示取不到有效值。
FlowGroupId	String	合同组编号注意：此字段可能返回 null，表示取不到有效值。
FlowGroupName	String	合同组名称注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询签署流程合同的详细信息

查询签署流程合同的详细信息

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "子客企业经办人id"
        },
        "ProxyOrganizationOpenId": "子客企业第三方id",
        "AppId": "16fd2f7d7xxxxx5f8d501d57b5ec"
    },
    "FlowIds": [
        "yDxjGUUgydjxxxxxzjERvGKmZJeX"
    ]
}

输出示例

{
    "Response": {
        "ApplicationId": "16fd2f7d7axxxxxd501d57b5ec",
        "FlowInfo": [
            {
                "CreateOn": 1638954201,
                "CustomData": "{\"hello\": 123}",
                "DeadLine": 1689688460,
                "FlowApproverInfos": [
                    {
                        "ApproveMessage": "",
                        "ApproveName": "签署方1",
                        "ApproveStatus": "PENDING",
                        "ApproveTime": 0,
                        "ApproveType": "PERSON",
                        "Mobile": "签署方手机号码(11位数字)",
                        "ProxyOperatorOpenId": "us-a9f05aaxxxxxe963ff3f935d7fa39",
                        "ProxyOrganizationName": "第三方平台子客企业名称",
                        "ProxyOrganizationOpenId": "第三方平台子客企业OpenId",
                        "ReceiptId": "签署人信息",
                        "SignOrder": 1
                    },
                    {
                        "ApproveMessage": "",
                        "ApproveName": "签署方2",
                        "ApproveStatus": "PENDING",
                        "ApproveTime": 0,
                        "ApproveType": "ORGANIZATION",
                        "Mobile": "签署方手机号码(11位数字)",
                        "ProxyOperatorOpenId": "us-a9f05axxxxxf935d7fa39",
                        "ProxyOrganizationName": "第三方平台子客企业名称",
                        "ProxyOrganizationOpenId": "第三方平台子客企业OpenId",
                        "ReceiptId": "签署人信息",
                        "SignOrder": 0
                    }
                ],
                "FlowId": "yDxjGUUgxxxxxvGKmZJeX",
                "FlowMessage": "",
                "FlowName": "示例1",
                "FlowStatus": "INIT",
                "FlowType": "示例"
            }
        ],
        "ProxyOrganizationOpenId": "第三方平台子客企业OpenId",
        "FlowGroupName": "",
        "FlowGroupId": "",
        "RequestId": "s16399xxxx603599"
    }
}

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. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Db	数据库错误。
InternalError.System	系统错误。
InvalidParameter	参数错误。
InvalidParameter.EndPoint	不合法的EndPoint，请检查修改后重试。
InvalidParameter.FlowIds	参数错误，合同id列表长度非法，请检查后重试。
InvalidParameter.fFowIds	流程id不存在。
LimitExceeded.FlowIds	合同id数超出限制。
MissingParameter	缺少参数错误。
MissingParameter.FlowIds	缺少流程id，请检查后重试。
MissingParameter.FlowIdsOrFlowGroupId	请传入需要查询的合同或合同组的ID。
OperationDenied	操作被拒绝。
OperationDenied.UserNotInOrganization	用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound	资源不存在。
ResourceNotFound.Application	应用号不存在。
ResourceNotFound.FlowApprovers	签署人信息不存在，请检查后重试。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 查询签署流程合同的详细信息​

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​