# 分页获取群成员列表
请求方式:POST
请求地址:https://$basehost/gateway/qopen/GetGroupMemberList
body参数:
{
"group_id": "群id",
"offset": 0,
"limit": 10
}
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
group_id | string | 是 | 群id |
offset | int | 是 | 每次获取的的开始位置,最小值为0 |
limit | int | 是 | 每次获取的条数,取值范围(1~100) |
返回值:
{
"data": {
"has_more": false,
"member_list": [
{
"alias": "群内昵称",
"avatar_url": "群内头像",
"union_id": "微信union id",
"external_user_id": "微信external_user_id",
"group_id": "群id",
"member_id": "群员id",
"member_name": "群员姓名",
"sex": 1,
"admin_type": 2,
"member_type": 1,
"join_scene": 1,
"join_time": "加入时间",
"is_watch": false,
"department" : "所属企业"
}
]
},
"errcode": 0,
"errmsg": "",
"hint": ""
}
返回说明
字段 | 类型 | 说明 |
---|---|---|
data | json | json返回值 |
has_more | bool | 是否还有更多 |
member_list | array | 获取到的群成员列表 |
errcode | int | 状态码,0为正常,非0代表错误 |
errmsg | string | 错误信息 |
hint | string | 请求日志ID |
member_list说明
字段 | 类型 | 说明 |
---|---|---|
alias | string | 群内昵称 |
avatar_url | string | 群内头像 |
group_id | string | 群id |
union_id | string | 微信union id |
external_user_id | string | 微信external_user_id |
member_id | string | 群员id |
member_name | string | 群员姓名 |
sex | int | 性别:0=未知,1=男,2=女 |
admin_type | int | 管理员类型:0普通成员 1管理员 2群主 |
member_type | int | 成员类型:1-员工,2-微信外部联系人,3-企业微信外部联系人 |
join_scene | int | 入群方式 1 、2 是由xx邀请入群 3是由xx分享的二维码入群, 异步处理填充的数据,新成员入群这个字段值为空 |
join_time | int | 入群时间, 异步处理填充的数据,新成员入群这个字段值为空 |
is_watch | bool | 是否已关注 |
department | bool | 所属企业 |
注意:union id字段,由于底层机制问题,并不一定有值,只有当的群数据跟企微的群数据匹配上,且成员为机器人客户才会有值
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/GetGroupMemberList \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"group_id": "群id",
"offset": 0,
"limit": 10
}'
← 获取机器人所在的群列表 获取指定群成员 →