# 查询群成员列表
请求方式: GET
请求地址: https://nbd-api.myscrm.cn/open-nbd-qw-groupchat/v1/groupchat/member/list
请求参数说明:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
app_id | string | 是 | 企微中台应用 ID |
chat_id | string | 是 | 客户群 id |
keyword | string | 否 | 关键词(群成员名称) |
status | int32 | 否 | 状态:0-全部,1-在群,2-已退群 |
join_scene | int32 | 否 | 入群方式:0-全部,1-群成员直接邀请,2-群成员邀请链接,3-群二维码 |
role | int32 | 否 | 角色:0-全部,1-普通群员,2-群管理员,3-群主 |
pager.page | int64 | 否 | 页码 |
pager.page_size | int64 | 否 | 分页行数 |
请求参数示例:
https://nbd-api.myscrm.cn/open-nbd-qw-groupchat/v1/groupchat/member/list?app_id=xxx&chat_id=xxx
返回数据:
{
"errcode": 0,
"errmsg": "ok",
"list": [
{
"userid": "string",
"name": "string",
"group_nickname": "string",
"avatar": "string",
"user_type": 0,
"join_scene": 0,
"status": 0,
"join_time": "string"
}
],
"pager": {
"page": "1",
"page_size": "10",
"total_rows": "100"
}
}
返回参数说明:
参数 | 类型 | 说明 |
---|---|---|
list | object [] | 成员列表 |
list.userid | string | 群成员 id |
list.name | string | 群成员名称 |
list.group_nickname | string | 在群里的昵称 |
list.avatar | string | 群成员头像 |
list.user_type | int32 | 用户类型:1-企微成员,2-外部联系人 |
list.join_scene | int32 | 入群方式:1-群成员直接邀请,2-群成员邀请链接,3-群二维码 |
list.status | int32 | 状态:1-在群,2-已退群 |
list.join_time | string | 入群时间: yyyy-mm-dd hh:ii:ss |
pager | object | 分页信息 |
pager.page | string | 页码 |
pager.page_size | string | 分页行数 |
pager.total_rows | string | 总行数 |