获取圈子成员列表
| 拥有此API的权限集 |
|---|
| 圈子管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.community.user.list/2.0.0 - 频率限制:
10秒500次
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 专属token |
| community_id | 是 | string | 圈子id |
| page_index | 是 | string | 当前页（起始值：1） |
| page_size | 是 | string | 每页记录数量 |
| user_state | 否 | int | -1:全部，0: 正常，1: 删除，2: 被设为黑名单，3: 封禁 |
| is_quit | 否 | int | -1:全部，0: 有效，1: 已退出，2: 已移除，10: 待续费 ,0-10：有效+待续费 |
请求示例
{
"access_token":"{{TOKEN}}",
"community_id": "c_xxx",
"page_index": 1,
"page_size": 10,
"is_quit":0
}
返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 状态码 |
| msg | string | 返回消息 |
| data | object | 数据 |
| data.total_count | int | 总数 |
| data.users | array | 用户列表 |
data.users用户信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| app_id | string | 店铺id |
| community_id | string | 圈子id |
| user_id | string | 用户id |
| nick_name | string | 用户圈子昵称 |
| wx_avatar | string | 压缩后的头像 |
| state | int | 用户状态(0-正常用户, 1-已删除用户, 2-拉入黑名单,3-封禁) |
| expire_end_time | string | 过期时间 |
| expire_end_time_text | string | 过期时间展示文本 |
| join_time | string | 加入时间 |
| roles | array | 角色身份列表，0-普通用户，1-圈主，2-管理员，3-助教，4-组长，5-嘉宾 |
| group_id | string | 所属分组id |
| group_name | string | 所属分组名 |
返回示例
{
"code": 0,
"msg": "操作成功",
"data": {
"total_count": 1,
"users": [
{
"app_id": "appxxx",
"community_id": "c_xxx",
"expire_end_time": "2024-01-19 11:47:48",
"expire_end_time_text": "2024-01-19 11:47:48",
"group_id": "g_ungrouped",
"group_name": "未分组",
"growth_num": 0,
"is_quit": 0,
"join_time": "2023-12-20 11:47:48",
"nick_name": "Ling_",
"roles": [],
"state": 0,
"user_id": "u_xxx",
"wx_avatar": "http://xxx.png"
}
]
}
}