查询文件下载URL

1. 接口描述

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

本接口（DescribeFileUrls）用于查询文件的下载URL。
适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询的文件没有权限

输入示例

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

{
    "Operator": {
        "UserId": "yDxM6UyK********QDV8dJUuO4zjEu"
    },
    "FileType": "PDF",
    "BusinessType": "FLOW",
    "FileName": "合同",
    "Limit": 0,
    "Offset": 0,
    "BusinessIds": [
        "11114444",
        "11114444555",
        "12315215515",
        "12415251512"
    ]
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "ResourceNotFound",
            "Message": "资源不存在或无权限"
        },
        "RequestId": "s166*******3046"
    }
}

示例2 获取下载文件链接 --- 单个合同

下载单个合同文件

输入示例

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

{
    "Operator": {
        "UserId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    },
    "BusinessType": "FLOW",
    "BusinessIds": [
        "yDwFkUUckpstzjhfUugNAWf1KibXqS26"
    ]
}

输出示例

{
    "Response": {
        "FileUrls": [
            {
                "Option": "[\"595.00,841.00\",\"-1\"]",
                "Url": "https://file.test.ess.tencent.cn/file/FLOW/yDR0dUxxxxxxxxWe1SbE7r/0/0.PDF?hkey=c80b3f1357821exxxxxxxxxxx2ad82345c777"
            }
        ],
        "RequestId": "1e1da50xxxxxx5d570ab151c9",
        "TotalCount": 1
    }
}

示例3 获取下载文件链接 --- 多个文件

下载多个合同文件

输入示例

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

{
    "Operator": {
        "UserId": "yDxM6UyK********QDV8dJUuO4zjEu"
    },
    "FileType": "PDF",
    "BusinessType": "DOCUMENT",
    "FileName": "合同",
    "Limit": 0,
    "Offset": 0,
    "BusinessIds": [
        "11114444",
        "11114444555",
        "12315215515",
        "12415251512"
    ]
}

输出示例

{
    "Response": {
        "FileUrls": [
            {
                "Url": "https://file.ess.myqcloud.com/file/xxxx.PDF?key=abc",
                "Option": ""
            },
            {
                "Url": "https://file.ess.myqcloud.com/file/DOCUMENT/xxxx.PDF?key=abc",
                "Option": ""
            },
            {
                "Url": "https://file.ess.myqcloud.com/file/DOCUMENT/xxx.PDF?key=abc",
                "Option": ""
            },
            {
                "Url": "https://file.ess.myqcloud.com/file/DOCUMENT/xxx.PDF?key=abc",
                "Option": ""
            }
        ],
        "TotalCount": 4,
        "RequestId": "XXXX"
    }
}

示例4 获取下载文件链接 --- 压缩多文件

下载文件压缩包

输入示例

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

{
    "Operator": {
        "UserId": "f2d8********f56b7"
    },
    "FileType": "ZIP",
    "BusinessType": "DOCUMENT",
    "FileName": "合同",
    "Limit": 0,
    "Offset": 0,
    "BusinessIds": [
        "e1a5****dfabfdbec6",
        "670d****590d4dcd",
        "dc3df****07f8323"
    ]
}

输出示例

{
    "Response": {
        "FileUrls": [
            {
                "Url": "https://file.ess.myqcloud.com/files/DOCUMENT/xxxx.ZIP?key=key********1234",
                "Option": ""
            }
        ],
        "TotalCount": 1,
        "RequestId": "XXXX"
    }
}

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

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