跳到主要内容

获取合同信息

1. 接口描述​

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

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

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

注: 只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致)

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeFlowDetailInfo。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证
FlowIds.N否Array of String需要查询的流程ID列表，最多可传入100个ID。
如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。
FlowGroupId否String需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。

合同组由通过多模板创建合同组签署流程和通过多文件创建合同组签署流程等接口创建。

3. 输出参数​

参数名称类型描述
ApplicationIdString合同归属的第三方平台应用号ID
ProxyOrganizationOpenIdString合同归属的第三方平台子客企业OpenId
FlowInfoArray of FlowDetailInfo合同流程的详细信息。
如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。
注意：此字段可能返回 null，表示取不到有效值。
FlowGroupIdString合同组ID，只有在查询合同组信息时才会返回。
注意：此字段可能返回 null，表示取不到有效值。
FlowGroupNameString合同组名称，只有在查询合同组信息时才会返回。
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 查询本企业创建的两个合同的详细信息​

查询本企业创建的两个合同的详细信息, FlowIds传了两个合同的ID数组

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowIds": [
        "yDSLNUUckpos0iylUyzyvt7TwYVXYRh7",
        "yDSLKUUckpoq19jtUxflhN4ugLFOCBNT"
    ]
}

输出示例​

{
    "Response": {
        "ApplicationId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "FlowInfo": [
            {
                "FlowId": "yDSLKUUckpoq19jtUxflhN4ugLFOCBNT",
                "FlowName": "购买50吨西红柿合同",
                "FlowType": "采购合同",
                "FlowStatus": "INIT",
                "FlowMessage": "",
                "CreateOn": 1698895092,
                "DeadLine": 1730431092,
                "CustomData": "",
                "FlowApproverInfos": [
                    {
                        "ReceiptId": "yDSLOUUckpoj6ocqUyzilW6RdWiojxfG",
                        "ProxyOrganizationOpenId": "org_dianziqian",
                        "ProxyOperatorOpenId": "n9527",
                        "ProxyOrganizationName": "典子谦示例企业",
                        "Mobile": "1850000000",
                        "SignOrder": 0,
                        "ApproveName": "典子谦",
                        "ApproveStatus": "PENDING",
                        "ApproveMessage": "",
                        "ApproveTime": 0,
                        "ApproveType": "ORGANIZATION",
                        "ApproverRoleName": "买方"
                    },
                    {
                        "ReceiptId": "yDSLOUUckpoj6ocjUyzilW6E0SsA8ggh",
                        "ProxyOrganizationOpenId": "",
                        "ProxyOperatorOpenId": "org_zhangsan",
                        "ProxyOrganizationName": "张三谦示例企业",
                        "Mobile": "1730000000",
                        "SignOrder": 0,
                        "ApproveName": "张三",
                        "ApproveStatus": "PENDING",
                        "ApproveMessage": "",
                        "ApproveTime": 0,
                        "ApproveType": "ORGANIZATION",
                        "ApproverRoleName": "卖方"
                    }
                ],
                "CcInfos": [],
                "NeedCreateReview": false
            },
            {
                "FlowId": "yDSLNUUckpos0iylUyzyvt7TwYVXYRh7",
                "FlowName": "购买50吨西瓜合同",
                "FlowType": "采购合同",
                "FlowStatus": "INIT",
                "FlowMessage": "",
                "CreateOn": 1698978129,
                "DeadLine": 1730514129,
                "CustomData": "",
                "FlowApproverInfos": [
                    {
                        "ReceiptId": "yDSLKUUckpoqohr5UcuKmnx5zDmZ7Tl4",
                        "ProxyOrganizationOpenId": "org_dianziqian",
                        "ProxyOperatorOpenId": "n9527",
                        "ProxyOrganizationName": "典子谦示例企业",
                        "Mobile": "1850000000",
                        "SignOrder": 0,
                        "ApproveName": "典子谦",
                        "ApproveStatus": "PENDING",
                        "ApproveMessage": "",
                        "ApproveTime": 0,
                        "ApproveType": "ORGANIZATION",
                        "ApproverRoleName": "买方"
                    },
                    {
                        "ReceiptId": "yDSLKUUckpoqohr0UcuKmnBmx1YdqgMW",
                        "ProxyOrganizationOpenId": "",
                        "ProxyOperatorOpenId": "org_zhangsan",
                        "ProxyOrganizationName": "张三示例企业",
                        "Mobile": "1730000000",
                        "SignOrder": 0,
                        "ApproveName": "张三",
                        "ApproveStatus": "PENDING",
                        "ApproveMessage": "",
                        "ApproveTime": 0,
                        "ApproveType": "ORGANIZATION",
                        "ApproverRoleName": "卖方"
                    }
                ],
                "CcInfos": [],
                "NeedCreateReview": false
            }
        ],
        "FlowGroupId": "",
        "FlowGroupName": "",
        "RequestId": "940b70b6-ef38-4932-ba80-936efe55b601"
    }
}

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操作不支持。
更多开发者交流反馈
购买咨询
4006-808-062
4006-808-062