小程序开放平台

文档中心
基础
转发
界面
网络
发起请求
下载
WebSocket
上传
uploadFile
uploadTask
uploadTaskAbort
uploadTaskOffHeadersReceived
uploadTaskOffProgressUpdate
uploadTaskOnHeadersReceived
uploadTaskOnProgressUpdate
数据缓存
渲染
媒体
文件
开放接口
设备
跳转
位置
支付

xhs.uploadFile

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

以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