• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 登录
  • 用户信息
  • tt.getUserInfo
  • tt.getUserProfile
  • 广告
  • 支付
  • 分享
  • 小程序跳转
  • 抖音视频能力
  • 收货地址
  • 设置
  • 授权
  • 评价能力
  • 数据分析
  • 视频拍摄器
  • 引导关注
  • 订阅消息
  • 电商插件能力(即将废弃)
  • AI/AR能力
  • 转发和挂载
  • 直播能力
  • 流量来源识别
  • 侧边栏能力
  • 隐私信息授权
  • web化
  • 行业开放
  • 第三方平台
  • 其它
  • tt.getUserInfo
    收藏
    我的收藏

    基础库 1.0.0 开始支持本方法,这是一个异步方法。
    警告
    此接口将逐步废弃,请切换使用 tt.getUserProfile。请及时修改下线,避免影响小程序使用。
    获取已登录用户的基本信息或特殊信息,首次使用的用户会弹出授权提示窗,若用户同意,则会返回用户的真实数据。

    语法

    tt.getUserInfo(options)

    参数说明

    options 为 object 类型,属性如下:
    属性名
    类型
    默认值
    必填
    说明
    最低支持版本
    withCredentials
    boolean
    false
    是否需要返回敏感数据
    1.0.0
    success
    function
    接口调用成功的回调函数
    1.0.0
    complete
    function
    接口调用结束的回调函数(调用成功、失败都会执行)
    1.0.0
    fail
    function
    接口调用失败的回调函数
    1.0.0

    回调成功

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errMsg
    string
    "getUserInfo:ok"
    1.0.0
    rawData
    string
    userInfo 的 JSON 字符串形式
    1.0.0
    userInfo
    UserInfo
    用户信息
    1.0.0

    UserInfo 类型说明

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    avatarUrl
    string
    用户头像
    1.0.0
    nickName
    string
    用户名
    1.0.0
    gender
    number
    用户性别,0: 未知;1:男性;2:女性
    1.0.0
    city
    string
    用户城市
    1.0.0
    province
    string
    用户省份
    1.0.0
    country
    string
    用户国家
    1.0.0
    language
    string
    用户语言,目前为空
    1.0.0
    如果输入中传递了 withCredentials:true,返回对象参数会增加如下扩展属性:
    属性名
    类型
    说明
    最低支持版本
    signature
    string
    用于校验用户信息是否被篡改,请参考文档
    1.0.0
    encryptedData
    string
    包括敏感信息(如 openId)在内的已加密用户数据,如需解密数据请参考文档
    1.0.0
    iv
    string
    加密算法参数
    1.0.0
    encryptedData 解密后可以获得:
    属性名
    类型
    说明
    最低支持版本
    nickName
    string
    用户昵称
    1.0.0
    avatarUrl
    string
    用户头像网络地址
    1.0.0
    gender
    number
    用户性别,0: 未知;1:男性;2:女性
    1.0.0
    city
    string
    用户所在城市
    1.0.0
    province
    string
    用户所在省份
    1.0.0
    country
    string
    用户所在国家
    1.0.0
    openId
    string
    用户 openId
    1.0.0
    watermark
    Watermark
    敏感数据水印
    1.0.0

    Watermark 类型说明

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    appid
    string
    数据源小程序 id
    1.0.0
    timestamp
    number
    时间戳,可以用于检查数据的时效性
    1.0.0

    回调失败

    object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errMsg
    string
    "getUserInfo:fail " + 详细错误信息
    1.0.0

    错误说明

    errNo
    errMsg
    说明
    最低支持版本
    10201
    "getUserInfo:fail privacy permission is not authorized"
    用户拒绝隐私协议授权,详见小程序隐私协议开发指南
    3.19.0
    10202
    "getUserInfo:fail api scope is not declared in the privacy agreement"
    隐私协议中未定义相关隐私信息类型,详见配置隐私协议
    3.19.0

    扫码体验

    代码示例

    tt.getUserInfo({ withCredentials: true, success(res) { console.log(`getUserInfo 调用成功 ${res.userInfo}`); }, fail(res) { console.log(`getUserInfo 调用失败`); }, });

    Bug & Tip

      Tip:本 API 需要用户授权方可调用,详细信息可参考用户授权
      Tip:本 API 依赖于 tt.login,请确保调用前已经调用了该 API;
      Tip:在今日头条宿主上如果用户设置了性别保密,gender 会返回 3。