# 获取用户列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getuserlist
通过该接口可获取用户信息列表。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/vip/user/list/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page_num | number | 是 | 当前页,从1开始 |
| page_size | number | 是 | 每页数量,最大200 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| list | objarray | 用户信息列表 |
| total_num | number | 总数 |
# Res.list(Array) Object Payload
用户信息列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| openid | string | 用户openId |
| user_grade_info | object | 用户对象信息 |
| unionid | string | 用户unionid |
# Res.list(Array).user_grade_info Object Payload
用户对象信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| grade | number | 等级 |
| experience_value | number | 当前等级经验值 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"page_num": 1,
"page_size": 10
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"list": [
{
"openid": "OPENID",
"user_grade_info": {
"grade": 3,
"experience_value": 1000
},
"unionid": "UNIONID"
}
],
"total_num": 1230
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10100001 | 系统错误 | |
| 10100002 | 参数错误 | |
| 10100003 | 信息不存在 |
# 7. 适用范围
本接口支持「微信小店(需开通)」账号类型调用。其他账号类型如无特殊说明,均不可调用。