客户端 API/网页应用/小程序API/网络/下载/downloadFile
# downloadFile(Object object)

下载网络文件到本地临时目录。
**注意事项**：注意事项：
- HTTP 请求 method 为GET
- tt.downloadFile的最大并发限制是 5 个

## 支持说明

应用能力 | Android | iOS | PC | 预览效果
---|---|---|---|---
小程序 | **✓** | **✓** | **✓** | 预览
网页应用 | **X** | **X** | **X** | /

## 输入

继承[标准对象输入](https://open.larksuite.com/document/uYjL24iN/ukzNy4SO3IjL5cjM)，扩展属性描述：

名称 | 数据类型 | 必填 | 默认值 | 描述
---|---|---|---|---
url | string | 是 | &nbsp; | 文件地址<br>**示例值**：https://open.lark.com/a.txt
header | object | 是 | {} | 请求 Header<br>**示例值**：{\"Content-Type\": \"application/json\"}
filePath | string | 否 | &nbsp; | 指定文件下载后存储的路径 (本地路径)。格式为 ttfile://temp/lark.png 或 ttfile://user/lark.png，其中 ttfile://temp/ 和 ttfile://user/ 为下载目录，lark.png 为文件名。详情可参考[文件系统](https://open.larksuite.com/document/uYjL24iN/uETOuETOuETO/file-system)。<br>默认下载目录为 ttfile://temp/<br>**示例值**：ttfile://temp/lark.png<br>**注意事项**：Lark[V3.43.0](https://open.larksuite.com/document/uYjL24iN/uAjMuAjMuAjM/version-compatibility)及以上版本支持

## 输出

`success`返回对象的扩展属性：

名称 | 数据类型 | 描述
---|---|---
tempFilePath | string | 文件本地路径
statusCode | number | 返回 HTTP 状态码
errMsg | string | 错误消息
trace | string | 请求ID，用于请求问题的诊断和全链路追踪

`fail`返回对象的扩展属性：

名称 | 数据类型 | 描述
---|---|---
tempFilePath | string | 文件本地路径
statusCode | number | 返回 HTTP 状态码
errMsg | string | 错误消息

返回值：`downloadTask`，该对象的方法列表参见下表：
**注意事项**：点击下表中的方法名，查看对应API的支持说明、调用方法

方法 | 介绍
---|---
[onProgressUpdate](https://open.larksuite.com/document/uYjL24iN/ugDNugDNugDN/downloadfile/onprogressupdate) | 监听下载进度
[abort](https://open.larksuite.com/document/uYjL24iN/ugDNugDNugDN/downloadfile/abort) | 中断请求任务

## 示例代码

```js
tt.downloadFile({
    "url": "https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fimg.jj20.com%2Fup%2Fallimg%2Ftp05%2F19100120461512E-0-lp.jpg&refer=http%3A%2F%2Fimg.jj20.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1640079653&t=22aafb14cb145c11fc833022d61507c5",
    success(res) {
      console.log(JSON.stringify(res));
    },
    fail(res) {
      console.log(`downloadFile fail: ${JSON.stringify(res)}`);
    }
});
```

`success`返回对象示例：

```json
{
    "trace": "021637487932728d06e52699ed7c796bac157dc5fca6dde1vbbbb",
    "tempFilePath": "ttfile://temp/src=http___img.jj20.com_up_allimg_tp05_19100120461512E-0-lp.jpg&refer=http___img.jj20.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg",
    "statusCode": 200,
    "errMsg": "downloadFile:ok"
}
``` 

`fail`返回对象示例：
```json
{
    "errMsg": "downloadFile:fail 不支持的URL",
    "tempFilePath": "",
    "statusCode": "0"
}
```