# 查询用户组成员列表
通过该接口可查询某个用户组的成员列表(支持查询成员中的用户和部门)。如果应用的通讯录权限范围是“全部员工”,则可查询企业内任何用户组的成员列表。
# 请求
基本 | |
---|---|
HTTP URL | https://hi-gw.weizhipin.com/open-apis/contact/group/:group_id/member/simplelist |
HTTP Method | GET |
支持的应用类型 | 自建应用 |
权限要求 | 获取用户组信息 |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token "示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" |
# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)
名称 | 类型 | 描述 |
---|---|---|
group_id | string | 用户组ID 示例值:"g128187" |
# 查询参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
page_size | int | 否 | 分页大小 示例值:50 默认值: 50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:"AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=" |
member_id_type | string | 否 | 欲获取成员ID类型。当member_type=user时候,member_id_type表示user_id_type,枚举值open_id, union_id和user_id。 示例值:"open_id" 可选值有: * open_id :member_type =user时候,表示用户的open_id* union_id :member_type =user时候,表示用户的union_id* user_id :member_type =user时候,表示用户的user_id默认值: open_id |
# 响应
# 响应体
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | - | - |
∟memberlist | memberlist[] | 成员列表 |
∟member_id | string | 成员ID |
∟member_type | string | 用户组成员的类型,取值为 user或department。 |
page_token | string | 下次分页获取的page_token |
has_more | boolean | 是否还需要分页获取 |
# 响应体示例
{
"code": 0,
"traceId": "_Ao59UOIBLPCeAAu",
"success": true,
"data": {
"memberlist": [
{
"memberId": "0326",
"memberType": "user"
},
{
"memberId": "010404",
"memberType": "department"
}
],
"page_token": null,
"has_more": false
},
"msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20