小程序开放平台

文档中心
基础
界面
网络
发起请求
上传
uploadFile
UploadTask
下载
Websocket
数据缓存
媒体
位置
开放接口
设备
XHSML
性能
文件
画布

xhs.uploadFile

开发
>
JS API
>
网络
>
上传
>
uploadFile
>
更新时间:2025-12-18 14:50:12

以Promise风格调用: 不支持。

将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求。

参数

Object object

属性
类型
默认值
必填
说明
urlstring开发者服务器地址
filePathstring要上传文件资源的路径 (本地路径)
namestring文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
headerobjectHTTP 请求 Header,Header 中不能设置 Referer, 不能将content-type 为 multipart/form-data,客户端会自动处理
formDataobjectHTTP 请求中其他额外的 form data
timeoutnumber超时时间,单位为毫秒
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
datastring,object开发者服务器返回的数据
statusCodenumber开发者服务器返回的 HTTP 状态码
errMsgstring

返回值

Object res

属性
类型
说明
codenumber
dataobject
msgstring

实例代码

// 调用 uploadFile 上传文件
xhs.uploadFile({
  url: 'https://example.com/upload', // 开发者服务器地址
  filePath: '/path/to/local/file.jpg', // 本地文件路径
  name: 'file', // 文件对应的 key
  header: {},
  formData: {
    userId: '12345', // 额外的表单数据
    description: '这是一个测试文件'
  },
  timeout: 10000, // 超时时间,单位为毫秒
  success: (res) => {
    console.log('上传成功:', res);
    console.log('服务器返回的数据:', res.data);
    console.log('HTTP 状态码:', res.statusCode);
  },
  fail: (err) => {
    console.error('上传失败:', err.errMsg);
  },
  complete: () => {
    console.log('uploadFile 调用结束');
  }
});