# 获取指定群成员
商家通过调用“获取指定群成员信息”这个接口可以获取到某个群指定的群成员信息。
注意:该接口仅获取本地缓存的数据,若机器人未关注该群,因不再接受群内成员的入群、退群回调。因此无法获取到最新的群成员数据。若期望获取最新的群成员数据,通过调用【企业微信群成员接口】-【分页获取机器人群成员列表】。
请求方式:POST
请求地址:https://$basehost/gateway/qopen/GetGroupMembersSync
body参数:
{
"robot_id": "机器人id",
"group_id": "群id",
"member_id_list":["群成员id"]
}
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
robot_id | string | 是 | 机器人id |
group_id | string | 是 | 群id |
member_id_list | array | 否 | 群成员id,注:不传群成员编号,则获取全量群成员信息;暂不限制传入个数 |
返回值:
{
"data": {
"robot_id": "",
"group_id": "",
"members": [
{
"member_id": "群成员id",
"inviter_id": "邀请人id",
"name": "姓名",
"base64_name": "BASE64编码过后的用户姓名",
"profile_photo": "头像",
"gender": 1,
"alias": "别名",
"base64_alias": "BASE64编码过后的用户别名",
"department": "所属企业",
"type": 1
}
]
},
"errcode": 0,
"errmsg": "",
"hint": ""
}
返回说明
字段 | 类型 | 说明 |
---|---|---|
data | json | json返回值 |
robot_id | string | 机器人id |
group_id | string | 群编号 |
members | array | 群成员信息列表 |
member_id | string | 群成员id |
inviter_id | string | 邀请人id |
name | string | 姓名 |
base64_name | string | BASE64编码过后的用户姓名 |
profile_photo | string | 头像 |
alias | string | 别名 |
gender | int | 性别:1男 2女 |
base64_alias | string | BASE64编码过后的用户别名 |
department | string | 所属企业 |
type | int | 群成员类型:-1未获取类型 0普通成员 1管理员 2群主 |
errcode | int | 状态码,0为正常,非0代表错误 |
errmsg | string | 错误信息 |
hint | string | 请求日志ID |
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/GetGroupMembersSync \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id": "",
"group_id": "",
"member_id_list":["",""]
}'
← 分页获取群成员列表 获取机器人所在的群数量 →