获取控制台下载合同页面跳转链接

1. 接口描述

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

此接口（GetDownloadFlowUrl）用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击下载按钮后就会下载传入的合同列表, 下载页面如下图

注:

• 仅支持下载 本企业 下合同，链接会 登录企业控制台
• 链接仅可使用一次，不可重复使用

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetDownloadFlowUrl。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证
DownLoadFlows.N	否	Array of DownloadFlowInfo	程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹最多20个合同, 所有文件夹最多50个合同 如下列组织形式, 控制台下载页面点击下载按钮后, 会生成2023采购合同.zip和2023入职合同.zip 两个下载任务(注:部分浏览器需要授权或不支持创建多下载任务) 2023采购合同.zip压缩包会有yDwivUUckpor6wtoUuogwQHCAB0ES0pQ和yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh两个合同的文件 2023入职合同.zip 压缩包会有yDwivUUckpor6wobUuogwQHvdGfvDi5K的文件

3. 输出参数

4. 示例

示例1 生成批量下载控制台连接地址

生成批量下载控制台连接地址

输入示例

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "DownLoadFlows": [
        {
            "FileName": "2023采购合同",
            "FlowIdList": [
                "yDwivUUckpor6wtoUuogwQHCAB0ES0pQ",
                "yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh"
            ]
        },
        {
            "FileName": "2023入职合同",
            "FlowIdList": [
                "yDwivUUckpor6wobUuogwQHvdGfvDi5K",
                "yDwFmUUckpst10i3UubBSat8PWOt2iQF",
                "yDwFdUUckpswdrniUuzcbXw8N43W6Kcz"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "DownLoadUrl": "https://beta.ess.tencent.cn/contract-mgr?channel=PROXYCHANNEL&expiredTime=1698393037&code=yDwivU**QH1Jir8mgiZ&token=yDwivUUckpo**H1Jir8mgiZ&operate=downloadFlow",
        "RequestId": "d6c869b7-6383-4ae5-8c30-6375f392e7c4"
    }
}

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

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