开发
API

tt.getUserProfile

基础库 2.30.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。

获取用户的基本信息,只可在 tap 事件回调中调用,每次调用都会弹出授权提示窗,若用户同意,则会返回用户的真实数据。

语法

tt.getUserProfile(options)

参数说明

options 为 object 类型,属性如下:

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

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"getUserProfile:ok"2.30.0
rawDatastringuserInfo 的 JSON 字符串形式2.30.0
userInfoUserInfo用户信息2.30.0
signaturestring用于校验用户信息是否被篡改,请参考文档2.30.0
encryptedDatastring已加密用户数据,不包含 openId、unionId,如需解密数据请参考文档2.30.0
ivstring加密算法参数2.30.0

UserInfo 说明

object 类型,属性如下:

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

encryptedData 解密后的数据

object 类型,属性如下:

属性名类型说明最低支持版本
avatarUrlstring用户头像网络地址2.30.0
nickNamestring用户昵称2.30.0
gendernumber用户性别,0: 未知;1:男性;2:女性2.30.0
citystring用户所在城市2.30.0
provincestring用户所在省份2.30.0
countrystring用户所在国家2.30.0
languagestring用户语言,目前为空2.30.0
watermarkWatermark敏感数据水印2.30.0

Watermark 说明

object 类型,属性如下:

属性名类型说明最低支持版本
appidstring数据源小程序 id2.30.0
timestampnumber时间戳,可以用于检查数据的时效性2.30.0

回调失败

object 类型,属性如下:

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

错误说明

errNoerrMsg说明最低支持版本
10103"getUserProfile:fail network unavailable"网络错误2.30.0
10200"getUserProfile:fail auth deny"用户拒绝授权2.30.0
10301"getUserProfile:fail feature is not supported in app"宿主不支持相关功能2.30.0
10401"getUserProfile:fail internal error"内部错误2.30.0
10601"getUserProfile:fail not login"宿主未登录2.30.0
10603"getUserProfile:fail invalid session"宿主登录,小程序未登录2.30.0
21500"getUserProfile:fail must be invoked by user tap gesture"必须在点击事件回调中调用该接口2.30.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.getUserProfile({
  success(res) {
    console.log("getUserProfile 调用成功:", res.userInfo);
  },
  fail(res) {
    console.log("getUserProfile 调用失败", res);
  },
});

Bug & Tip

  • Tip:请在点击事件回调中调用本 API;
  • Tip:本 API 依赖于 tt.login,请确保调用前已经调用了该 API。
点击纠错
评价此篇文档