查询合同详情

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFlowInfo。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，本接口不需要传递此参数。
FlowIds.N	是	Array of String	需要查询的流程ID列表，限制最大100个
Operator	否	UserInfo	调用方用户信息，userId 必填
Agent	否	Agent	代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填

3. 输出参数

参数名称	类型	描述
FlowDetailInfos	Array of FlowDetailInfo	签署流程信息
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询合同详情

查询合同详情

输入示例

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

{
    "FlowIds": [
        "c7b5ca37ae*******2b4c6644",
        "61a82f0c1******d0d807"
    ]
}

输出示例

{
    "Response": {
        "FlowDetailInfos": [
            {
                "FlowId": "abc",
                "FlowName": "abc",
                "FlowType": "abc",
                "FlowStatus": 0,
                "FlowMessage": "abc",
                "FlowDescription": "abc",
                "CreatedOn": 0,
                "FlowApproverInfos": [
                    {
                        "ApproveMessage": "abc",
                        "ApproveName": "abc",
                        "ApproveStatus": 0,
                        "ReceiptId": "abc",
                        "CustomUserId": "abc",
                        "Mobile": "abc",
                        "SignOrder": 0,
                        "ApproveTime": 0,
                        "ApproveType": "abc",
                        "ApproverSource": "abc",
                        "CustomApproverTag": "abc",
                        "OrganizationId": "abc",
                        "OrganizationName": "abc"
                    }
                ],
                "CcInfos": [
                    {
                        "ApproveMessage": "abc",
                        "ApproveName": "abc",
                        "ApproveStatus": 0,
                        "ReceiptId": "abc",
                        "CustomUserId": "abc",
                        "Mobile": "abc",
                        "SignOrder": 0,
                        "ApproveTime": 0,
                        "ApproveType": "abc",
                        "ApproverSource": "abc",
                        "CustomApproverTag": "abc",
                        "OrganizationId": "abc",
                        "OrganizationName": "abc"
                    }
                ],
                "Creator": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

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.System	系统错误，请稍后重试。
MissingParameter	缺少参数错误。
OperationDenied.Forbid	禁止此项操作。
ResourceNotFound.Resource	未获取到文件资源，请检查资源是否完成上传，是否有效，并在修改后重试。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 查询合同详情​

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​