tt.getUserInfo 1.0.0+

获取已登录用户的基本信息或特殊信息

提示

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

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

输入

object 类型,属性如下:

属性类型默认值必填说明最低支持版本
successfunction接口调用成功的回调函数1.0.0
completefunction接口调用结束的回调函数(调用成功、失败都会执行)1.0.0
failfunction接口调用失败的回调函数1.0.0
withCredentialsbooleanfalse是否需要返回敏感数据1.0.0

success 返回参数说明

object 类型,属性如下:

属性类型说明
userInfoobject用户信息
userInfo.avatarUrlstring用户头像
userInfo.nickNamestring用户名
userInfo.gendernumber用户性别,0: 未知;1:男性;2:女性
userInfo.citystring用户城市
userInfo.provincestring用户省份
userInfo.countrystring用户国家
userInfo.languagestring用户语言,目前为空
rawDatastringuserInfo 的 JSON 字符串形式

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

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

encryptedData 解密后可以获得:

属性类型说明
watermarkobject敏感数据水印
watermark.appidstring数据源小程序 id
watermark.timestampnumber时间戳,可以用于检查数据的时效性

代码示例

tt.getUserInfo({
  success(res) {
    console.log(`getUserInfo 调用成功 ${res.userInfo}`);
  },
  fail(res) {
    console.log(`getUserInfo 调用失败`);
  }
});
点击纠错