getUserInfo 1.0.0+

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

提示

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

提示

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

输入

继承标准对象输入,扩展属性描述:

名称 数据类型 属性 默认值 描述
withCredentials boolean optional false 是否需要返回敏感数据

输出

success返回对象参数的扩展属性:

名称 数据类型 描述
userInfo object 用户信息
userInfo.avatarUrl string 用户头像
userInfo.nickName string 用户名
userInfo.gender number 用户性别,0: 未知;1:男性;2:女性
userInfo.city string 用户城市
userInfo.province string 用户省份
userInfo.country string 用户国家
userInfo.language string 用户语言,目前为空
rawData string userInfo的JSON字符串形式

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

名称 数据类型 描述
signature string 用于校验用户信息是否被篡改,请参考文档
encryptedData string 包括敏感信息(如openId)在内的已加密用户数据,如需解密数据请参考文档
iv string 加密算法参数

encryptedData解密后可以获得:

名称 数据类型 描述
watermark object 敏感数据水印
watermark.appid object 数据源小程序id
watermark.timestamp object 时间戳,可以用于检查数据的时效性

代码示例

 








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