家校通讯录是指平台的学生和家长组织架构

部门管理

创建部门（school/department/create）

使用场景： 创建校区、学段、年级或班级，用于学年开始时的数据初始化。创建后会返回部门的ID，可以继续作为参数来创建下一级的部门。一般情况下，使用/school/department/list获取到家校部门后，可以取出Level=0（一般为首条数据）的根节点，来创建校区，然后根据校区的部门ID来创建学段，根据学段ID来创建年级，根据年级ID来创建班级。其中班级必须是在年级下边的，年级则可以在根节点、校区、学段任一级别下。

是否需额外授权: 是

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/department/create?access_token=ACCESS_TOKEN

请求包体：

 {
     "name": "一年级",
     "parentid": 1,
     "order": 1,
     "tag": 5,
     "department_type":4,
     "register_year": 2020,
     "standard_grade": 1,
     "code": "ynj",
     "org_attribute":0,
     "department_admins": [
         {
             "userid": "zhangsan",
             "type": 3,
             "subject": "语文"
         },
         {
             "userid": "lisi",
             "type": 4,
             "subject": "数学"
         }
     ]
 }

参数说明 ：

返回结果：

{
   "errcode": 0,
   "errmsg": "ok",
   "id": 2
}

参数说明：

修改部门（school/department/update）

使用场景： 修改指定部门的数据，可以迁移部门节点到同样类型的父部门下边，也可以增删改班级类型的部门教师。

是否需额外授权: 是

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/department/update?access_token=ACCESS_TOKEN

请求包体：

 {
     "id": 2,
     "name": "一年级",
     "parentid": 1,
     "order": 1,
     "code": "ynj",
     "org_attribute":0,
     "department_admins": [
         {
             "op": 0,
             "userid": "zhangsan",
             "type": 3,
             "subject": "语文"
         },
         {
             "op": 1,
             "userid": "lisi",
             "type": 4,
             "subject": "数学"
         }
     ]
 }

参数说明 ：

注意：更新和删除管理员是以userid和type作为判断依据的

返回结果：

{
   "errcode": 0,
   "errmsg": "ok"
}

参数说明：

删除部门（school/department/delete）

使用场景： 删除指定部门，部门下不能含有子部门或学生。

是否需额外授权: 是

请求方式： GET（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/department/delete?access_token=ACCESS_TOKEN&id=ID

参数说明 ：

返回结果：

{
   "errcode": 0,
   "errmsg": "ok"
}

参数说明：

获取部门列表（school/department/list）

使用场景： 获取家校的部门列表，应用可缓存起来构建部门树，用于展示校区、学段、年级和班级列表。

是否需额外授权: 否

请求方式： GET（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/department/list?access_token=ACCESS_TOKEN&id=ID

参数说明 ：

获取学生组织架构根节点示例： https://oapi.epaas.qq.com/school/department/list?access_token=ACCESS_TOKEN&next_level_only=1&need_role_node=true

权限说明：

只能拉取token对应的应用的权限范围内的部门列表

返回结果：（下面就是获取教师组织架构根节点的返回示例，后续学生相关部门节点，可以逐层挂到“学生”节点下面）

{
    "errmsg": "ok",
    "errcode": 0,
    "departments": [
        {
            "id": 222,
            "type": 5,
            "name": "xxx学校",
            "parentid": 0,
            "register_year": 2020,
            "standard_grade": 0,
            "order": 0,
            "department_admins": [],
            "open_group_chat": 0,
            "code": "",
            "org_attribute": 0,
            "level": 1,
            "tag": 0
        },
        {
            "id": 224,
            "type": 0,
            "name": "学生",
            "parentid": 222,
            "register_year": 2020,
            "standard_grade": 0,
            "order": 1,
            "department_admins": [],
            "open_group_chat": 0,
            "code": "",
            "org_attribute": 0,
            "level": 2,
            "tag": 1
        }
    ]
}

参数说明：

班级毕业（school/department/graduate）

使用场景：令班级所有学生毕业，成为毕业生。

​ 班级毕业后，学生将变更为毕业生角色，拉取正常学生接口将无法拉取到毕业生，且该操作不可逆转；另外，此操作会删除企业微信侧数据，请谨慎操作。

是否需额外授权: 否

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/department/graduate?access_token=ACCESS_TOKEN

请求包体：

{
    "department_id":8542
}

参数说明 ：

返回结果：

{
    "errcode": 0,
    "errmsg": "ok"
}

参数说明：

成员管理

创建学生（school/user/create_student）

使用场景： 创建一个学生，用于学年开始时的数据初始化，一般用于新生入学。学生只能放在班级节点下。

是否需额外授权: 是

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/create_student?access_token=ACCESS_TOKEN

请求包体：

 {
     "name": "张三",
     "department": [1,2],
     "user_number": "student001",
     "gender": "1",
     "initial_password": "123456ff",
     "department_type":4,
     "mobile":"13522221225",
     "basic_profile": "{\"ic_card\": \"278652\",\"join_date\": \"2010-01-02\"}",
     "extend_profile": "{\"studentField1\": \"\info1\",\"studentField2\": \"info2\"}"
}

参数说明 ：

返回结果：

{
   "errcode": 0,
   "errmsg": "ok",
   "userid": "student_user_id",
   "profile_msg": ""
}

参数说明：

更新学生资料（school/user/update_student_info）

使用场景： 更新学生资料。

是否需额外授权: 是

请求地址: https://oapi.epaas.qq.com/school/user/update_student_info

请求方法: POST

请求示例：

{
  "userid": "30046274",
  "basic_profile": "{\"ic_card\": \"278652\",\"join_date\": \"2010-01-02\"}",
  "extend_profile": "{\"studentField1\": \"\info1\",\"studentField2\": \"info2\"}"
}

请求参数:

返回结果：

{
  "errcode": 0,
  "errmsg": "ok"
}

参数说明:

学生调班（/school/user/move_department）

使用场景： 学生调班

是否需额外授权: 否

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/move_department?access_token=ACCESS_TOKEN

请求包体：

{
    "userids":["3724804326"],
    "department_id":5670337,
    "department_type":1
}

参数说明：

返回结果：

{
    "errcode": 0,
    "errmsg": "ok"
}

参数说明：

删除学生（school/user/delete_student）

使用场景： 删除指定学生。

是否需额外授权: 是

请求方式： GET（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/delete_student?access_token=ACCESS_TOKEN&userid=ID

参数说明 ：

返回结果：

{
   "errcode": 0,
   "errmsg": "ok"
}

参数说明：

创建家长（school/user/create_parent）

使用场景： 创建一个家长，同时指定与学生的关系，一般用于新生入学，或者收集好家长关信息后录入。需要先创建学生，用学生的userid来指定关系。

是否需额外授权: 是

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/create_parent?access_token=ACCESS_TOKEN

请求包体：

 {
     "name": "张三",
     "mobile": "13800000000",
     "children": [
        {
            "student_userid": "zhangsan",
            "relation": "爸爸"
        },
        {
            "student_userid": "lisi",
            "relation": "家长"
        }
     ],
     "basic_profile": "{\"top_edu\": \"6\",\"age\": \"35\"}",
     "extend_profile": "{\"field1\": \"info1\"}"
 }

参数说明 ：

返回结果：

{
   "errcode": 0,
   "errmsg": "ok",
   "userid": "parent_user_id",
   "fail_list": [
        {
            "idx": 0,
            "errmsg": "学生不存在"
        },
        {
            "idx": 2,
            "errmsg": "该学生已经存在关系为爸爸的家长"
        }
    ],
    "profile_msg": ""
}

参数说明：

更新家长资料（school/user/update_parent_info）

使用场景： 仅更新家长信息。

是否需额外授权: 是

请求地址: https://oapi.epaas.qq.com/school/user/update_parent_info

请求方法: POST

请求示例：

{
  "userid": "parent_id",
  "basic_profile": "{\"top_edu\": \"6\",\"age\": \"35\"}",
  "extend_profile": "{\"field1\": \"info1\"}"
}

请求参数:

返回结果：

{
  "errcode": 0,
  "errmsg": "ok"
}

参数说明:

删除家长（school/user/delete_parent）

使用场景： 删除指定家长。

是否需额外授权: 是

请求方式： GET（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=ID

参数说明 ：

返回结果：

{
   "errcode": 0,
   "errmsg": "ok"
}

参数说明：

绑定学生和家长关系

使用场景: 批量绑定学生和家长关系

是否需额外授权: 是 机构授权

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/batch_bind_student_parent?access_token=ACCESS_TOKEN

请求包体：

 {
  "access_token": "",
  "data_list": [
    {
      "child_userid": "1",
      "parent_userid": "2",
      "relation":"家长"
    }
  ]
 }

参数说明 ：

返回结果：

{
  "errcode": 0,
  "errmsg": "",
  "data_list": [
    {
      "child_userid": "1",
      "parent_userid": "2",
      "errcode": 1,
      "errmsg": "参数错误"
    }
  ]
}

参数说明：

解除学生和家长的绑定

使用场景: 批量解除学生和家长的绑定关系

是否需额外授权: 是 机构授权

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/batch_unbind_student_parent?access_token=ACCESS_TOKEN

请求包体：

 {
  "access_token": "",
  "data_list": [
    {
      "child_userid": "1",
      "parent_userid": "2"
    }
  ]
 }

参数说明 ：

返回结果：

{
  "errcode": 0,
  "errmsg": "",
  "data_list": [
    {
      "child_userid": "1",
      "parent_userid": "2",
      "errcode": 1,
      "errmsg": "参数错误"
    }
  ]
}

参数说明：

批添加学生到课程班/教学班（school/user/batch_add_course）

使用场景： 批量添加学生到课程班/教学班

是否需额外授权: 否

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/batch_add_course?access_token=ACCESS_TOKEN

请求包体：

{
    "department_id": "5323182",
    "userids": ["3724236300","3724236301"]
}

参数说明：

返回结果：

{
    "errmsg": "ok",
    "errcode": 0,
    "course_result": [
        {
            "errcode": 0,
            "errmsg": "ok",
            "userid": "3724236300"
        },
        {
            "errcode": 0,
            "errmsg": "ok",
            "userid": "3724236301"
        }
    ]
}

参数说明：

批量将学生从课程班/教学班中删除（school/user/batch_delete_course）

使用场景：批量将学生从课程班/教学班中删除

是否需额外授权: 否

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/user/batch_delete_course?access_token=ACCESS_TOKEN

请求包体：

{
    "department_id": "5323182",
    "userids": ["3724236300","3724236301"]
}

参数说明：

返回结果：

{
    "errmsg": "ok",
    "errcode": 0,
    "course_result": [
        {
            "errcode": 0,
            "errmsg": "ok",
            "userid": "3724236300"
        },
        {
            "errcode": 0,
            "errmsg": "ok",
            "userid": "3724236301"
        }
    ]
}

参数说明：

学生变动（退休学）（school/student/move）

使用场景： 学生退学、休学或者其他变动。

是否需额外授权: 是

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/student/move?access_token=ACCESS_TOKEN

请求包体：

 {
     "userid": "3724127543",
     "move_type":2,
     "reason":"变动原因"
 }

参数说明 ：

返回结果：

{
   "errcode": 0,
   "errmsg": "ok"
}

参数说明：

学生迁回（school/student/move_back）

使用场景： 学生在退学、休学或者其他变动后，迁回学校。

是否需额外授权: 是

请求方式： POST（HTTPS）

请求地址： https://oapi.epaas.qq.com/school/student/move_back?access_token=ACCESS_TOKEN

请求包体：

 {
     "id": 14506,
     "userid":"3724127543",
     "department_ids":[5010291]
 }

参数说明 ：

返回结果：

{
   "errcode": 0,
   "errmsg": "ok"
}

参数说明：