查询成员列表

查询成员列表

接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

接口说明

接口英文名

getRoleList

功能描述

该接口用于查询小程序直播成员列表。

调用方式

HTTPS 调用

GET https://api.weixin.qq.com/wxaapi/broadcast/role/getrolelist?access_token=ACCESS_TOKEN 

云调用

• 出入参和HTTPS调用相同，调用方式可查看云调用说明文档
• 接口方法为: openapi.liveBroadcast.getRoleList

第三方调用

• 调用方式以及出入参和HTTPS相同，仅是调用的token不同
• 该接口所属的权限集id为：52
• 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

URL query 参数含义

参数	类型	必填	说明
role	Number	否	查询的用户角色，取值 [-1-所有成员， 0-超级管理员，1-管理员，2-主播，3-运营者]，默认-1
offset	Number	否	起始偏移量, 默认0
limit	Number	否	查询个数，最大30，默认10
keyword	String	否	搜索的微信号或昵称，不传则返回全部

返回参数含义

参数	说明
total	总个数
list	角色列表
headingimg	微信用户头像url
nickname	微信用户昵称
openid	openid
roleList	具有的身份，[0-超级管理员，1-管理员，2-主播，3-运营者]
updateTimestamp	更新时间
username	微信号

请求示例

{
    role: 1, // 取值 [-1-所有成员， 0-超级管理员，1-管理员，2-主播，3-运营者]
    offset: 0, // 起始偏移量
    limit: 10, // 查询个数，最大30，默认10
    keyword: 'test_1' // 搜索的微信号，不传返回全部
}

正确返回示例

{
    "errcode": 0,
    "total" : 1, // 总个数
    "list": [{
        "headingimg": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM5jBhFwrHoeoaxTlhP9YzlVica7wu6lZLnGreKAj7CVicA/0", // 头像
        "nickname": "test1", // 昵称
        "openid": "o7esq5MvImF2SEm7OHYohausj2o",
        "roleList": [2, 3], // 具有的身份，[0-超级管理员，1-管理员，2-主播，3-运营者]
        "updateTimestamp": "1600340080", // 更新时间
        "username": "o0****0o", //脱敏微信号
    }]
} 

调用示例

示例说明: HTTPS请求示例

请求数据示例

// URL query 参数
{
    role: 1, // 取值 [-1-所有成员， 0-超级管理员，1-管理员，2-主播，3-运营者]
    offset: 0, // 起始偏移量
    limit: 10, // 查询个数，最大30，默认10
    keyword: 'test_1' // 搜索的微信号，不传返回全部
} 

返回数据示例

{
    "errcode": 0,
    "total" : 1, // 总个数
    "list": [{
        "headingimg": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM5jBhFwrHoeoaxTlhP9YzlVica7wu6lZLnGreKAj7CVicA/0", // 头像
        "nickname": "test1", // 昵称
        "openid": "o7esq5MvImF2SEm7OHYohausj2o",
        "roleList": [2, 3], // 具有的身份，[0-超级管理员，1-管理员，2-主播，3-运营者]
        "updateTimestamp": "1600340080", // 更新时间
        "username": "o0****0o", //脱敏微信号
    }]
}  

错误码

错误码	错误码取值	解决方案
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口