# 查询成员列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getRoleList
该接口用于查询小程序直播成员列表。
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/wxaapi/broadcast/role/getrolelist?access_token=ACCESS_TOKEN&offset=OFFSET&limit=LIMIT&keyword=KEYWORD
# 云调用
调用方法:liveBroadcast.getRoleList
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:52
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
| offset | number | 否 | - | 起始偏移量, 默认0 |
| limit | number | 否 | - | 查询个数,最大30,默认10 |
| keyword | string | 否 | - | 搜索的微信号或昵称,不传则返回全部 |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| total | number | 总个数 |
| list | objarray | 角色列表 |
# Res.list(Array) Object Payload
角色列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| headingimg | string | 微信用户头像url |
| nickname | string | 微信用户昵称 |
| openid | string | openid |
| roleList | numarray | 具有的身份,[0-超级管理员,1-管理员,2-主播,3-运营者] |
| updateTimestamp | string | 更新时间 |
| username | string | 微信号 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
GET https://api.weixin.qq.com/wxaapi/broadcast/role/getrolelist?access_token=ACCESS_TOKEN&offset=OFFSET&limit=LIMIT&keyword=KEYWORD
返回示例
{
"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", //脱敏微信号
}]
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。