小程序开放平台

文档中心
基础
路由
跳转
转发
界面
网络
支付
数据缓存
媒体
位置
开放接口
登录
授权
设置
收货地址
用户信息
getUserProfile
帐号信息
引导关注
专业号
服务组件
直播预约/跳转/打开
设备
XHSML
性能
第三方平台
文件
数据分析
画布

xhs.getUserProfile

开发
>
JS API
>
开放接口
>
用户信息
>
getUserProfile
>
更新时间:2025-04-11 18:36:26

以Promise风格调用: 支持

获取用户信息。暂不支持API直接获取,参考 button 组件文档

参数

Object object

属性
类型
默认值
必填
说明
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
errMsgstring
userInfouserInfo用户信息

userInfo

属性
类型
说明
nickNamestring用户昵称
avatarUrlstring用户头像图片的 URL。URL 中的w/number或者h/number一个数值代表头像宽高值(任意宽高值可选)。
gendernumber用户性别

实例代码

function getUserProfile() {
  return new Promise((resolve, reject) => {
    xhs.getUserProfile({
      success: (res) => {
        console.log('获取用户信息成功:', res);
        resolve(res.userInfo); // 返回用户信息
      },
      fail: (err) => {
        console.error('获取用户信息失败:', err);
        reject(err); // 返回错误信息
      },
      complete: () => {
        console.log('获取用户信息操作完成');
      }
    });
  });
}

// 调用示例
getUserProfile()
  .then((userInfo) => {
    console.log('用户信息:');
    console.log('昵称:', userInfo.nickName);
    console.log('头像 URL:', userInfo.avatarUrl);
    console.log('性别:', userInfo.gender === 1 ? '男' : userInfo.gender === 2 ? '女' : '未知');
  })
  .catch((err) => {
    console.error('操作失败:', err);
  });