请求方式:GET(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID
参数说明 :
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| id | 否 | 部门id。获取指定部门及其下的子部门。 如果不填,默认获取全量组织架构 |
权限说明:
调用的应用需要满足如下的权限
| 应用类型 | 权限要求 |
|---|---|
| 自建应用 | 配置到「 家校沟通- 读取和编辑家校通讯录的应用」或「 家校沟通- 读取家校通讯录的应用」或“家长可使用应用”列表中 |
| 代开发应用 | 具有 「家校沟通」权限 |
| 第三方应用 | 具有 「家校沟通」使用权限 |
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"departments": [
{
"name": "一年级",
"parentid": 1,
"id": 2,
"type":2,
"register_year":2018,
"standard_grade":1,
"order":1,
"department_admins": [
{
"userid": "zhangsan",
"type": 1
},
{
"userid": "lisi",
"type": 2
}
],
"is_graduated": 0
},
{
"name": "一年级一班",
"parentid": 1,
"id": 3,
"type": 1,
"department_admins": [
{
"userid": "zhangsan",
"type": 3,
"subject":"语文"
},
{
"userid": "lisi",
"type": 4,
"subject":"数学"
}
],
"open_group_chat": 1,
"group_chat_id": "group_chat_id"
}
]
}
参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| departments | 部门列表数据 |
| id | 部门id,根部门固定为1 |
| type | 部门类型,32位整型,1表示班级,2表示年级,3表示学段,4表示校区,5表示学校(根部门) |
| name | 部门名称 |
| parentid | 父亲部门id,根部门该项为0 |
| register_year | 入学年份,仅标准年级返回,格式为YYYY |
| standard_grade | 标准年级,当为部门为标准年级时返回,返回值具体请参考标准年级对照表 |
| order | 在父部门中的次序值,order值大的排序靠前。有效的值范围是[0, 2^32),仅在API设置后才返回 |
| department_admins.userid | 部门管理员的userid |
| department_admins.type | 部门管理员的类型,1表示校区负责人,2表示年级负责人,3表示班主任,4表示任课老师,5表示学段负责人 |
| department_admins.subject | 教师或班主任的科目 |
| open_group_chat | 是否开启班级群,1表示开启,0表示关闭。仅部门类型为班级时才返回该字段 |
| group_chat_id | 班级群id。仅部门类型为班级时且open_group_chat为1时才返回该字段 |
| is_graduated | 是否是已毕业,1表示是,0表示不是。仅部门类型为年级时才返回该字段 |
