Skip to content

download_file

将公开 HTTP(S) 地址的文件下载到萌卡 NT 框架目录下,并返回后端可直接读取的本地绝对路径。该接口是框架级接口,不需要 self_id

调用

js
const result = await api.download_file({
  url: 'https://example.com/files/example.zip',
  headers: {
    Authorization: 'Bearer example-token',
  },
})

参数

参数类型必填说明
urlstring仅支持公开的 HTTP(S) 地址
thread_countnumber兼容字段;当前版本使用稳定的单连接下载
headersobject | string[]下载请求头;数组格式为 Header-Name: value

返回值

js
{
  file: '/framework/data/plugin-downloads/随机前缀-example.zip',
}

文件始终保存在框架目录的 data/plugin-downloads 中,不会写入系统临时目录或框架目录之外。单个文件最大 128 MiB,最多跟随 5 次重定向;本机、内网和保留网段地址会被拒绝,防止插件借下载接口访问框架内部服务。

下载失败时会返回明确的 HTTP 状态、文件大小或地址安全错误,不会保留未完成的 .part 文件。

调用前必读

协议与使用指南

无需账号协议
适用协议
无需账号协议
使用前准备
不依赖 Bot 在线,但插件连接必须已授权;涉及文件时,路径或 URL 必须能被萌卡 NT 后端访问。

建议搭配

常见失败原因

  • 插件未授权或连接已断开
  • 后端无法读取给定路径或远程资源
  • 请求超时或参数格式不符合接口要求

注意事项

  • 本地路径按后端主机解释;插件与框架不在同一主机时,请传后端可访问的 HTTP(S) 地址。

萌卡NT 开发文档