企学院获取学员列表
| 拥有此API的权限集 |
|---|
| 学员管理-查询（限企学院） |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.college.employee.list/1.0.0 - 频率限制：
10秒3000次
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 专属token |
| department_id | 是 | int | 部门id |
| page_index | 是 | int | 第几页，不传默认1 |
| page_size | 是 | int | 页数，不传默认10 |
| fetch_child | 否 | int | 是否递归子部门：0-否，1-是；不传默认为是 |
| refresh | 否 | bool | 是否需要刷新通讯录，默认为：false |
| search | 否 | string | 是否搜索，默认为空 |
请求示例
{
"access_token":"xe_xxx",
"department_id":0,
"page_index":1,
"page_size":10,
"fetch_child":0,
"refresh":false,
"search":""
}
返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| msg | string | 错误描述 |
| data | object | 返回值 |
| data.list | array | 数据列表 |
| data.total | int | 员工数量 |
| data.user_id | array | 用户id列表 |
数据列表data.list
| 参数名 | 类型 | 说明 |
|---|---|---|
| user_id | string | 用户id |
| user_name | string | 用户名 |
| employee_id | string | 账号 |
| password | string | 密码 |
| departments | array | 部门列表 |
| alias | string | 别名 |
| gender | string | 性别:1男，0女 |
| mobile | string | 手机号码 |
| string | 邮箱 | |
| id_card | string | 身份证 |
| position | string | 职位 |
| entry_time | string | 入职时间 |
| avatar | string | 头像 |
| avatar_compress | string | 头像url，小图 |
| is_leader | int | 标示是否为上级，对应企业微信is_leader |
| telephone | string | 座机。企业微信中第三方仅通讯录套件可获取 |
| state | int | 账号状态：0-正常，1-禁用 |
| is_auth | bool | 是否授权true为已授权 |
部门列表departments
| 参数名 | 类型 | 说明 |
|---|---|---|
| department_id | int | 部门id |
| name | string | 部门名称 |
返回示例
{
"code": 0,
"msg": "OK",
"data": {
"total": 62,
"list": [
{
"user_id": "u_wework_613b1cc918f8a_huLEp41lvoO9QHNb",
"employee_id": "12377643",
"user_name": "新测试43",
"position": "",
"mobile": "",
"gender": 1,
"email": "",
"is_leader": 0,
"avatar": "",
"avatar_compress": null,
"telephone": null,
"alias": "",
"entry_time": "2021-09-10",
"state": 0,
"departments": [
{
"department_id": "24",
"name": "子部门3"
}
],
"is_auth": true
}
],
"user_id": []
}
}