tt.getUserProfile
基础库 2.30.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。
获取用户的基本信息,只可在 tap 事件回调中调用,每次调用都会弹出授权提示窗,若用户同意,则会返回用户的真实数据。
语法
tt.getUserProfile(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
force | boolean | false | 否 | tt.getUserProfile 依赖宿主(如抖音)登录,force 为 true 可以在宿主未登录时,强制拉起登录框 | 2.54.0 |
success | function | 否 | 接口调用成功的回调函数 | 2.30.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 2.30.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.30.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getUserProfile:ok" | 2.30.0 |
rawData | string | userInfo 的 JSON 字符串形式 | 2.30.0 |
userInfo | UserInfo | 用户信息 | 2.30.0 |
signature | string | 用于校验用户信息是否被篡改,请参考文档 | 2.30.0 |
encryptedData | string | 已加密用户数据,不包含 openId、unionId,如需解密数据请参考文档 | 2.30.0 |
iv | string | 加密算法参数 | 2.30.0 |
UserInfo 类型说明
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
avatarUrl | string | 用户头像 | 2.30.0 |
nickName | string | 用户昵称 | 2.30.0 |
gender | number | 用户性别,0: 未知;1:男性;2:女性 | 2.30.0 |
city | string | 用户城市 | 2.30.0 |
province | string | 用户省份 | 2.30.0 |
country | string | 用户国家 | 2.30.0 |
language | string | 用户语言,目前为空 | 2.30.0 |
encryptedData 解密后的数据
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
avatarUrl | string | 用户头像网络地址 | 2.30.0 |
nickName | string | 用户昵称 | 2.30.0 |
gender | number | 用户性别,0: 未知;1:男性;2:女性 | 2.30.0 |
city | string | 用户所在城市 | 2.30.0 |
province | string | 用户所在省份 | 2.30.0 |
country | string | 用户所在国家 | 2.30.0 |
language | string | 用户语言,目前为空 | 2.30.0 |
watermark | Watermark | 敏感数据水印 | 2.30.0 |
Watermark 类型说明
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
appid | string | 数据源小程序 id | 2.30.0 |
timestamp | number | 时间戳,可以用于检查数据的时效性 | 2.30.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errNo | number | 错误码 | 2.30.0 |
errMsg | string | "getUserProfile:fail " + 详细错误信息 | 2.30.0 |
错误说明
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
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。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助