---
url: /api-proxy/network/download/downloadFile.md
---
## [DownloadTask](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.html) mpx.downloadFile(Object object)

下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径 (本地路径)，单次下载允许的最大文件为 200MB。使用前请注意阅读相关说明。

注意：请在服务端响应的 header 中指定合理的 Content-Type 字段，以保证客户端正确处理文件类型。

支持情况： 微信、支付宝

[参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/wx.downloadFile.html)

### 参数 {#parameters}

**Object object**

| 属性           | 类型     | 默认值 | 必填 | 说明                                                                                                                        | 最低版本 | 支付宝 |
| -------------- | -------- | ------ | ---- | --------------------------------------------------------------------------------------------------------------------------- | -------- | ------ |
| url            | string   |        | 是   | 下载资源的 url                                                                                                              |          | ✓ |
| header         | Object   |        | 否   | HTTP 请求的 Header，Header 中不能设置 Referer                                                                               |          | ✓ |
| timeout        | number   | 60000  | 否   | 超时时间，单位为毫秒，默认值为 60000 即一分钟。                                                                             | 2.10.0   | ✓ |
| filePath       | string   |        | 否   | 指定文件下载后存储的路径 (本地路径)                                                                                          | 1.8.0    | ✓ |
| enableProfile  | boolean  | true   | 否   | 是否开启 profile。iOS 和 Android 端默认开启，其他端暂不支持。开启后可在接口回调的 res.profile 中查看性能调试信息。           |          | ✗ |
| enableHttp2    | boolean  | false  | 否   | 是否开启 http2                                                                                                              | 2.10.4   | ✗ |
| enableQuic     | boolean  | false  | 否   | 是否开启 Quic/h3 协议（iOS 微信目前使用 gQUIC-Q43；Android 微信在 v8.0.54 前使用 gQUIC-Q43，v8.0.54 开始使用 IETF QUIC，即 h3 协议；PC微信使用 IETF QUIC，即 h3 协议） | 2.10.4   | ✗ |
| success        | function |        | 否   | 接口调用成功的回调函数                                                                                                      |          | ✓ |
| fail           | function |        | 否   | 接口调用失败的回调函数                                                                                                      |          | ✓ |
| complete       | function |        | 否   | 接口调用结束的回调函数（调用成功、失败都会执行）                                                                            |          | ✓ |

**object.success 回调函数**

**参数**

**Object res**

### 返回值 {#return-value}

[DownloadTask](https://developers.weixin.qq.com/miniprogram/dev/api/network/download/DownloadTask.html)

### 示例代码 {#example-code}

```js
mpx.downloadFile({
  url: 'https://example.com/audio/123', //仅为示例，并非真实的资源
  success (res) {
    // 只要服务器有响应数据，就会把响应内容写入文件并进入 success 回调，业务需要自行判断是否下载到了想要的内容
    if (res.statusCode === 200) {
      mpx.playVoice({
        filePath: res.tempFilePath
      })
    }
  }
})
```