小程序开放平台

文档中心
基础
路由
跳转
转发
界面
网络
发起请求
上传
uploadFile
uploadTask
uploadTaskAbort
uploadTaskOffHeadersReceived
uploadTaskOffProgressUpdate
uploadTaskOnHeadersReceived
uploadTaskOnProgressUpdate
uploadXhsFile
下载
WebSocket
支付
数据缓存
媒体
位置
开放接口
设备
XHSML
性能
第三方平台
文件
数据分析
画布

xhs.uploadXhsFile

开发
>
JS API
>
网络
>
上传
>
uploadXhsFile
>
更新时间:2025-04-10 15:47:13

以Promise风格调用: 支持

将客户端本地文件上传至服务器,支持分片上传(仅小红书内部业务使用)

参数

Object object

属性
类型
默认值
必填
说明
filePathstring要上传文件资源的路径 (客户端本地路径),通过 chooseMedia 等选择文件API获得
bizCodenumber如需使用,请联系小程序开发同学申请配置
scenestring上传场景,如需使用,请联系小程序开发同学申请配置
timeoutnumber超时时间,单位 ms
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
previewUrlstring上传成功后的临时预览地址(需要联系CDN后端配置,否则为空)
fileIdstring该次上传的加密fileId
errMsgstring

实例代码

// 调用 uploadXhsFile 上传文件
xhs.uploadXhsFile({
  filePath: '/path/to/local/file.jpg', // 本地文件路径,通过 chooseMedia 等 API 获取
  bizCode: 12345, // 业务代码(如需使用,请联系小程序开发同学申请配置)
  scene: 'example_scene', // 上传场景(如需使用,请联系小程序开发同学申请配置)
  timeout: 10000, // 超时时间,单位为毫秒
  success: (res) => {
    console.log('上传成功:', res);
    console.log('临时预览地址:', res.previewUrl); // 上传成功后的临时预览地址
    console.log('文件 ID:', res.fileId); // 上传的加密 fileId
  },
  fail: (err) => {
    console.error('上传失败:', err.errMsg);
  },
  complete: () => {
    console.log('uploadXhsFile 调用结束');
  }
});