tt.getGroupLiveMember
收藏
我的收藏基础库 3.50.0 开始支持本方法,这是一个异步方法。
获取直播团播成员数据
前提条件 | 需要申请团成员能力 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | 无 |
支持沙盒 | 否 |
相关教程 | 无 |
语法
tt.getGroupLiveMember(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
success | function | 否 | 接口调用成功的回调函数 | 3.50.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.50.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.50.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getGroupLiveMember:ok" | 3.50.0 |
members | array | 团成员列表 | 3.50.0 |
members 类型说明
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
avatar_url | string | 团成员头像 | 3.50.0 |
member_name | string | 团成员昵称 | 3.50.0 |
sec_open_id | string | 团成员 id | 3.50.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持 版本 |
---|---|---|---|
errMsg | string | "getGroupLiveMember:fail " + 错误信息 | 3.50.0 |
错误码
errorCode | errMsg | errorType | 说明 | 最低支持版本 |
---|---|---|---|---|
175601 | request params error | D | 请求参数错误 | 3.50.0 |
175602 | execute fail before creating a live card | U | 未创建直播间卡片 | 3.50.0 |
175603 | live room is not exist | U | 直播间不存在 | 3.50.0 |
175604 | service internal error | F | 小程序框架内部错误,有需要请拉客服咨询 | 3.50.0 |
175605 | has no api access permission | D | 未申请 API 权限 | 3.50.0 |
175606 | live room owner no match | U | 直播间主播和当前登录主播不一致 | 3.50.0 |
175607 | access too frequent | U | 操作过于频繁 | 3.50.0 |
175608 | not group live room | U | 非团播直播间 | 3.50.0 |
代码示例
tt.getGroupLiveMember({ success(res) { console.log(res.memebers); }, fail(err) { } })