开发
API

tt.getLiveUserInfo

基础库 2.28.0 开始支持本方法,该 API 为异步 API。
调用方:主播端/观众端
使用该功能前,开发者需要申请并通过「直播能力」准入,并开通「获取当前用户基础信息」能力,具体可参考接入流程

获取当前用户基础信息。

语法

tt.getLiveUserInfo(options);

参数说明

options 为 object 类型,属性如下:

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

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"getLiveUserInfo:ok"2.28.0
userInfoobject用户信息2.28.0

userInfo 为 object 类型,属性如下:

属性名类型说明最低支持版本
openUIDstring用户的 open UID2.28.0
secNicknamestring用户的加密后昵称,配合加密昵称组件使用,只能在同一个直播间使用2.28.0
secAvatarURLstring用户的加密后头像 URL,配合加密头像组件使用,只能在同一个直播间使用2.28.0
rolestring用户身份,anchor - 主播,audience - 观众2.28.0

回调失败

object 类型,属性如下:

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

errNo 的可枚举值:

描述
40001参数错误
40002没有调用权限
40007接口调用频率过高

代码示例

开发者工具中预览

tt.getLiveUserInfo({
    success: function (res) {
        console.log('getLiveUserInfo success', res)
        that.setData({
            hasUserInfo: true,
            userInfo: res.userInfo
        });
    },
    fail (e) {
        console.log('getLiveUserInfo error', e)
        tt.showModal({
            title: '调用 getLiveUserInfo 失败'
        })
    },
    complete (data) {
        console.log('complete', data)
    }
});

Bug & Tip

  • Tips:目前该接口只支持抖音 App,版本需满足 18.2.0 版本及以上
点击纠错
评价此篇文档