概述 - 钉钉 API

本文介绍了什么是新教育，新教育开放了哪些接口能力，以及如何接入新教育能力。

什么是新教育

新教育提供了线上授课、在线布置及批改作业等，让家校沟通更高效，给用户良好的使用体验。更多介绍请参见钉钉使用手册-新教育。

家校通讯录2.0

支持类型

家校通讯录2.0接口，支持“基础教育通讯录”和“自定义家校通讯录”两种类型的通讯录。

部门完整示例

当前一个测试组织，其下包含基础教育通讯录和自定义通讯录两种类型。以下通过获取部门列表，完整的展示整条链路的数据。

基础教育经典类型

顶层节点校区ID：4240004

其中一个校区下的所有学段列表：

{
  "result": {
    "details": [
      {
        "dept_id":4242002,
        "nick": "",
        "chain": "[4240004]",
        "feature": "{\"name_mode\":\"number\",\"period_type\":\"kindergarten\"}",
        "name": "幼儿园",
        "contact_type": "classic",
        "dept_type": "period"
      }
    ],
    "has_more": false,
    "super_id": 4240004
  },
  "success": true,
  "errcode": 0,
  "request_id":"63h2j929f9oj"
}

其中一个学段下的所有年级列表

{
  "result": {
    "details": [
      {
        "dept_id":4242003,
        "nick": "",
        "chain": "[4240004, 4242002]",
        "feature": "{\"grade_level\":1,\"start_year\":\"2019\"}",
        "name": "一年级",
        "contact_type": "classic",
        "dept_type": "grade"
      },
      {
        "dept_id":4242004,
        "nick": "",
        "chain": "[4240004, 4242002]",
        "feature": "{\"grade_level\":2,\"start_year\":\"2018\"}",
        "name": "二年级",
        "contact_type": "classic",
        "dept_type": "grade"
      },
      {
        "dept_id":4242005,
        "nick": "",
        "chain": "[4240004, 4242002]",
        "feature": "{\"grade_level\":3,\"start_year\":\"2017\"}",
        "name": "三年级",
        "contact_type": "classic",
        "dept_type": "grade"
      }
    ],
    "has_more": false,
    "super_id": 4242002
  },
  "success": true
  "errcode": 0,
  "request_id":"10c0wt6haqhdo"
}

其中一个年级下的所有班级列表

说明

班级是叶子节点，其下不存在接口可返回的结构数据。

{
  "result": {
    "details": [
      {
        "dept_id":4242006,
        "nick": "",
        "chain": "[4240004, 4242002, 4242005]",
        "feature": "{\"class_level\":1,\"grade_level\":3}",
        "name": "三年级1班",
        "contact_type": "classic",
        "dept_type": "class"
      }
    ],
    "has_more": false,
    "super_id": 4242005
  },
  "success": true,
  "errcode": 0,
  "request_id":"plqhiw9f9pa0"
}

自定义通讯录类型：

顶层节点id：4240016

其中一个自定义顶层节点下的所有子节点

{
  "result": {
    "details": [
      {
        "dept_id":4240017,
        "nick": "",
        "chain": "[4240016]",
        "feature": "{}",
        "name": "2020",
        "contact_type": "custom",
        "dept_type": "dept"
      }
    ],
    "has_more": false,
    "super_id": 4240016
  },
  "success": true,
  "errcode": 0,
  "request_id":"plqhiw9f9pa0"
}

其中一个自定义节点下的所有班级节点

{
  "result": {
    "details": [
      {
        "dept_id":4240018,
        "nick": "",
        "chain": "[4240016, 4240017]",
        "feature": "{\"class_level\":0,\"grade_level\":0}",
        "name": "自定义下的班级",
        "contact_type": "custom",
        "dept_type": "class"
      }
    ],
    "has_more": false,
    "super_id": 4240017
  },
  "success": true,
  "errcode": 0,
  "request_id":"plqhiw9f9pa0"
}

新教育接口能力

新教育开放的接口列表

新教育提供了丰富的接口开放能力，开发者通过API接口可以实现新教育和企业业务系统打通。

家校通讯录2.0

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取部门详情	查看某个部门详情。	-	获取部门详情
获取部门列表	查看某个部门下的所有子部门列表。	-	获取部门列表
获取人员列表	查看班级下的人员身份列表。	-	获取人员列表
获取人员详情	查看班级下的人员详细信息。	-	获取人员详情
获取班级内学生的关系列表	查看班级下的所有学生的关系列表。	-	获取班级内学生的关系列表
获取学生监护人详情	查看班级下某个监护人的详情。	-	获取学生监护人详情
初始化家校结构	初始化家校结构。	-	初始化家校架构
创建学段	在指定校区下创建学段。	-	创建学段
创建年级	创建年级。	-	创建年级
创建班级	在指定的年级下创建班级。	-	创建班级
添加学生	在指定的班级下新增学生信息。	-	添加学生
添加家长	在指定的班级下添加家长信息。	-	添加家长
添加老师	在指定班级下新增老师信息。	-	添加老师
学生调班	学生调班。	学生调班	-
删除老师	删除老师。	删除老师	-
删除学生	删除学生。	删除学生	-
删除家长关系	删除与此家长关联的家长身份。	删除家长关系	-
删除家校部门	删除家校部门。	删除家校部门	-
创建自定义校区或部门	创建自定义校区或部门。	创建自定义校区或部门
创建自定义部门下的班级	创建自定义部门下的班级。	创建自定义部门下的班级

班级圈

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取班级圈话题列表	获取班级圈话题列表。	-	获取班级圈话题列表
获取班级圈动态列表	获取班级圈动态列表。	-	获取班级圈动态列表

数字化证书

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取数字化证书	获取数字化证书。	-	获取数字化证书

新教育回调事件列表

新教育支持人员身份变更、关系变更等回调事件。

家校通讯录事件

概述

什么是新教育#

家校通讯录2.0#

支持类型#

部门完整示例#

新教育接口能力#

新教育开放的接口列表#