# 获取抖音用户信息(选接)
# 接口说明
用于获取抖音用户的个人信息,如昵称、头像等。
sdkInstance.getUserInfo(options);
注意事项
一般通过此服务获取抖音用户的昵称、头像,用来作为玩家在游戏内的昵称、头像,如果无此需求,此服务可不对接!
最低基础库版本要求
若传递了 withRealNameAuthenticationInfo
参数,则要求用户客户端基础库版本不低于 1.80.0
;若低于该版本,调用 sdkInstance.getUserInfo(options)
接口将中断用户当前操作并弹出升级提示,不会报错!
# 参数说明
参数说明如下表所示:
选项 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
withCredentials | boolean | 否 | false | 是否需要返回敏感数据 |
withRealNameAuthenticationInfo | boolean | 否 | false | 是否需要返回用户实名认证状态 |
success | function | 否 | -- | 获取成功的回调函数,返回抖音用户信息 |
fail | function | 否 | -- | 获取失败的回调函数,返回错误信息 |
complete | function | 否 | -- | 获取完成的回调函数,成功或失败均会调用 |
# 返回值说明
WARNING
返回值格式:JSON
格式。
选项 | 类型 | 说明 |
---|---|---|
code | number | 响应状态码,为 0 时表示获取成功,其他非 0 状态码均表示获取失败 |
data | object / null | 获取成功时返回抖音用户信息,详情请参考 tt.getUserInfo() 接口说明,失败时返回 null |
message | string | 获取成功或失败时的相应描述信息 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 若传递了 withRealNameAuthenticationInfo 参数,且用户客户端基础库版本低于 1.80.0,调用 sdkInstance.getUserInfo(options) 接口将中断用户当前操作并弹出升级提示,不会报错!
sdkInstance.getUserInfo({
success: function(response) {
const userInfo = response.data.userInfo;
console.log(userInfo.nickName); // 抖音昵称
console.log(userInfo.avatarUrl); // 抖音头像
},
fail: function(error) {
sdkInstance.modal.message(error.message);
},
complete: function(result) {
// do something here...
}
});