家校通讯录事件

本文介绍了家校通讯录事件的相关说明。

事件类型

家校通讯录事件支持以下类别：

类别	企业自主开发应用	服务商开发
人员变更事件	支持	支持
部门变更事件	支持	支持

当家校通讯录发生变化，并且注册回调事件时填写的事件类型“call_back_tag”包含家校通讯录事件，比如call_back_tag字段为“edu_user_insert”“[,“edu_user_relation_insert”]”，那么家校通讯录发生“家校通讯录人员身份新增”和“家校通讯录人员关系新增”，钉钉服务器会向回调url推送事件。此回调事件推送的是最简单的数据，建议配合API查询详情。

事件类型	类别	说明
edu_user_insert	人员身份新增	人员身份新增。
edu_user_update	人员身份更新	人员身份更新。
edu_user_delete	人员身份删除	人员身份删除。
edu_user_relation_insert	人员关系新增	人员关系新增。
edu_user_relation_update	人员关系更新	人员关系更新。
edu_user_relation_delete	人员关系删除	人员关系删除。
edu_dept_insert	部门节点新增	部门节点新增。
edu_dept_update	部门节点更新	部门节点更新。
edu_dept_delete	部门节点删除	部门节点删除。

人员身份新增

示例：

参数说明：

名称	类型	示例	说明
corpId	String	12344556	组织id。
userId	String	123344	用户id。
role	String	teacher	此人在家校的角色类型。
teacher：老师 guardian：监护人。 student: 学生
name	String	eliot	此人在此班级的名字。
classId	Number	4240006	班级ID。
feature	String	JSON格式，各个角色下存在不同属性。
isAdviser	是否班主任，老师角色下有效。
studentNo	学号，学生角色下有效。
syncAction	String	edu_user_insert	事件类型。
errcode	Number	0	返回码。
errmsg	String	ok	返回码描述。

人员身份更新

示例：

参数说明：

名称	类型	示例	说明
corpId	String	12344556	组织id。
userId	String	123344	用户id。
role	String	teacher	此人在家校的角色类型。
teacher：老师 guardian：监护人。 student: 学生
name	String	alan爸爸	此人在此班级的名字。
classId	Number	4240006	班级ID。
feature	String	JSON格式，各个角色下存在不同属性。
isAdviser	是否班主任，老师角色下有效。
studentNo	学号，学生角色下有效。
syncAction	String	edu_user_update	事件类型。
errcode	Number	0	返回码。
errmsg	String	ok	返回码描述。

人员身份删除

示例：

参数说明：

名称	类型	示例	说明
corpId	String	12233445	组织id。
userId	String	manager9707	用户id。
role	String	teacher	此人在家校的角色类型。
teacher：老师 guardian：监护人 student：学生
classId	Number	4240006	班级ID。
isGraduate	Number	0	0：正常的删除 1：由于毕业业务导致的人员删除
feature	String	扩展，老师身份提前下有效。
isAdviser	Integer	1	是否班主任。只有在teacher的角色下有效。
0：非班主任身份 1：班主任身份

关系新增

示例：

参数说明：

名称	类型	示例	说明
corpId	String	1233445556	组织id。
fromUserId	String	1591928760	用户id。
toUserId	String	1592301514-87630	用户id。
classId	Number	4240006	班级ID。
relationCode	String	F	关系code。
relationName	String	爸爸	关系名。

人员关系更新

示例：

参数说明：

名称	类型	示例	说明
corpId	String	1233445556	组织id。
fromUserId	String	1591928760	用户id。
toUserId	String	1592301514-87630	用户id。
classId	Number	4240006	班级ID。
relationCode	String	F	关系code。
relationName	String	爸爸	关系名。

人员关系删除

示例：

参数说明：

名称	类型	示例	说明
corpId	String	1233445556	组织id。
fromUserId	String	1591928760	用户id。
toUserId	String	1592301514-87630	用户id。
classId	Number	4240006	班级ID。
relationCode	String	F	关系code。
relationName	String	爸爸	关系名。

部门节点新增

示例：

参数说明：

名称	类型	示例	说明
corpId	String	ding97d07b05aea229fe	组织id。
deptId	Number	4288001	部门id。

部门节点更新

示例：

参数说明：

名称	类型	示例	说明
corpId	String	ding97d07b05aea229fe	组织id。
deptId	Number	4288001	部门id。

部门节点删除

示例：

参数说明：

名称	类型	示例	说明
corpId	String	ding97d07b05aea229fe	组织id。
deptId	Number	4288001	部门id。
isGraduate	Number	0	0：删除成功 1：毕业

家校通讯录事件

事件类型#

人员身份新增#

人员身份更新#

人员身份删除#

关系新增#

人员关系更新#

人员关系删除#

部门节点新增#

部门节点更新#

部门节点删除#

事件类型

人员身份新增

人员身份更新

人员身份删除

关系新增

人员关系更新

人员关系删除

部门节点新增

部门节点更新

部门节点删除