开发
API
开放能力
数据分析
视频拍摄器
多端支持

tt.getUserInfo

获取已登录用户的基本信息或特殊信息,首次使用的用户会弹出授权提示窗,若用户同意,则会返回用户的真实数据。

提示

本 API 需要用户授权方可调用,详细信息可参考 用户授权

本 API 依赖于 login,请确保调用前已经调用了该 API

语法

tt.getUserInfo(options);

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
successFunction接口调用成功的回调函数1.0.0
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)1.0.0
failFunction接口调用失败的回调函数1.0.0
withCredentialsbooleanfalse是否需要返回敏感数据1.0.0
withRealNameAuthenticationInfobooleanfalse是否需要返回用户实名认证状态1.80.0

回调成功

object 类型,属性如下:

属性类型说明最低支持版本
errMsgstring"getUserInfo:ok"1.0.0
rawDatastringuserInfo 的 JSON 字符串形式1.0.0
userInfoobject用户信息1.0.0

userInfo 为 object 类型,属性如下:

属性类型说明
avatarUrlstring用户头像
nickNamestring用户名
gendernumber用户性别,0: 未知;1:男性;2:女性
citystring用户城市
provincestring用户省份
countrystring用户国家
languagestring用户语言,目前为空

如果输入中传递了 withCredentials:true,返回对象参数会增加如下扩展属性:

属性类型说明
signaturestring用于校验用户信息是否被篡改,请参考文档
encryptedDatastring包括敏感信息(如 openId)在内的已加密用户数据,如需解密数据请参考文档
ivstring加密算法参数

encryptedData 解密后可以获得:

属性类型说明
nickNamestring用户昵称
avatarUrlstring用户头像网络地址
gendernumber用户性别,0: 未知;1:男性;2:女性
citystring用户所在城市
provincestring用户所在省份
countrystring用户所在国家
openIdstring用户 openId
watermarkobject敏感数据水印

敏感数据水印包含字段:

属性类型说明
appidstring数据源小程序 id
timestampnumber时间戳,可以用于检查数据的时效性

如果输入装传递了 withRealNameAuthenticationInfo:true, 返回对象会增加 realNameAuthenticationStatus 字段, 说明如下

类型说明
"certified"object当前用户已经通过实名认证
"uncertified"object当前用户未通过实名认证

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"getUserInfo:fail " + 详细错误信息1.0.0

代码示例

tt.login({
  success(_res) {
    console.log("登录成功");
    // 调用 getUserInfo 前, 请确保登录成功

    // 获取用户信息
    tt.getUserInfo({
      // withCredentials: true,
      // withRealNameAuthenticationInfo: true,
      success(res) {
        console.log(`getUserInfo 调用成功`, res.userInfo);
      },
      fail(res) {
        console.log(`getUserInfo 调用失败`, res.errMsg);
      },
    });
  },
});

Bug & Tip

  • Tip:本 API 需要用户授权方可调用,详细信息可参考用户授权
  • Tip:本 API 依赖于 tt.login,请确保调用前已经调用了该 API
点击纠错
评价此篇文档