tt.getLiveUserInfo
收藏
我的收藏

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

警告
此接口将逐步废弃，后续不再维护，请及时修改下线，避免影响小程序使用​

获取当前用户基础信息。

语法

js复制
tt.getLiveUserInfo(options);

参数说明

options 为 object 类型，属性如下：

属性名	类型	默认值	必填	说明	最低支持版本
success	function		否	接口调用成功的回调函数	2.28.0
fail	function		否	接口调用失败的回调函数	2.28.0
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）	2.28.0

回调成功

object 类型，属性如下：

属性名	类型	说明	最低支持版本
errMsg	string	"getLiveUserInfo:ok"	2.28.0
userInfo	object	用户信息	2.28.0

userInfo 为 object 类型，属性如下：

属性名	类型	说明	最低支持版本
openUID	string	用户的 open UID	2.28.0
secNickname	string	用户的加密后昵称，配合加密昵称组件使用，只能在同一个直播间使用	2.28.0
secAvatarURL	string	用户的加密后头像 URL，配合加密头像组件使用，只能在同一个直播间使用	2.28.0
role	string	用户身份，anchor - 主播，audience - 观众	2.28.0

回调失败

object 类型，属性如下：

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

errNo 的可枚举值：

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

代码示例

开发者工具中预览

js复制
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);
  },
});