跳到主要内容

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

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 必填。
FlowIds.N否Array of String合同(流程)编号数组，最多支持100个。

备注：该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参
FlowGroupId否String合同组编号

备注：该参数和合同(流程)编号数组必须二选一

3. 输出参数​

参数名称类型描述
ApplicationIdString第三方平台应用号Id
ProxyOrganizationOpenIdString第三方平台子客企业OpenId
FlowInfoArray of FlowDetailInfo合同(签署流程)的具体详细描述信息
注意：此字段可能返回 null，表示取不到有效值。
FlowGroupIdString合同组编号
注意：此字段可能返回 null，表示取不到有效值。
FlowGroupNameString合同组名称
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 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": "yDwcC******ciRHST9jtYB",
        "FlowGroupId": "",
        "FlowGroupName": "",
        "FlowInfo": [
            {
                "CcInfos": [],
                "CreateOn": 1686120086,
                "CustomData": "",
                "DeadLine": 1717656086,
                "FlowApproverInfos": [
                    {
                        "ApproveMessage": "",
                        "ApproveName": "张三",
                        "ApproveStatus": "PENDING",
                        "ApproveTime": 0,
                        "ApproveType": "PERSON",
                        "Mobile": "133*****75",
                        "ProxyOperatorOpenId": "oHeIG5gF****TXeXZrb4",
                        "ProxyOrganizationName": "",
                        "ProxyOrganizationOpenId": "",
                        "ReceiptId": "yDwg4UUc****QEAn6BWc39jZVY",
                        "SignOrder": 0
                    }
                ],
                "FlowId": "yDwg4UUc******6CLBKPEvnl",
                "FlowMessage": "",
                "FlowName": "电子合同",
                "FlowStatus": "INIT",
                "FlowType": "",
                "NeedCreateReview": false
            }
        ],
        "ProxyOrganizationOpenId": "t1td99d*****d28ec280dd4",
        "RequestId": "c1f80560-****-ae0be7462559"
    }
}

5. 错误码​

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

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