概述 - 钉钉 API

本文档介绍了通讯录产品，如何查看通讯录，通讯录开放了哪些接口能力，以及如何接入通讯录能力。

什么是通讯录

内部信息统一管理，清晰展示组织架构，快速找人，同时保障企业通讯数据安全。通讯录设置、管理、可见性管理等更多功能介绍请参考钉钉使用手册-通讯录。

如何查看通讯录

企业管理员登录钉钉管理后台-内部通讯录查看并使用。

普通组织成员可在PC端/手机端钉钉-通讯录查看。

通讯录接口能力

通讯录开放的接口列表

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

用户管理

API	API说明	新版规范（新版服务端API）	旧版规范（服务端API）
创建用户	创建新用户。	-	创建用户创建用户（历史版本）
更新用户信息	更新指定的用户信息。	-	更新用户信息更新用户信息（历史版本）
删除用户	根据用户的userid删除指定用户。	-	删除用户删除用户（历史版本）
查询用户详情	获取指定用户的详细信息。	-	查询用户详情查询用户详情（历史版本）
获取部门用户基础信息	获取指定部门的用户基础信息。	-	获取部门用户基础信息获取部门用户基础信息（历史版本）
获取部门用户userid列表	获取指定部门的userid列表。	-	获取部门用户userid列表获取部门用户userid列表（历史版本）
获取部门用户详情	获取指定部门中的用户详细信息。	-	获取部门用户详情获取部门用户详情（历史版本）
获取员工人数	获取员工人数。	-	获取员工人数获取员工人数（历史版本）
获取未登录钉钉的员工列表	查询指定日期内未登录钉钉的企业员工列表。	-	获取未登录钉钉的员工列表获取未登录钉钉的员工列表（历史版本）
根据手机号查询用户	根据手机号获取用户的userId。	-	根据手机号查询用户根据手机号查询用户（历史版本）
根据unionid获取用户userid	根据unionid获取用户的userid。	-	根据unionid获取用户userid 根据unionid获取用户userid（历史版本）
获取管理员列表	查询管理员列表。	-	获取管理员列表获取管理员列表（历史版本）
获取管理员通讯录权限范围	获取管理员通讯录权限范围。	-	获取管理员通讯录权限范围
查询离职记录列表	查询企业离职记录列表。	查询离职记录列表	-
设置高管模式	设置员工的高管模式。	设置高管模式	-
获取用户高管模式设置	获取用户高管模式的设置详情。	获取用户高管模式设置	-
删除用户属性可见性设置	删除企业员工属性字段可见性设置。	删除用户属性可见性设置	-
获取用户属性可见性设置	获取企业员工属性字段隐藏设置。	获取用户属性可见性设置	-
设置用户属性可见性	新增或更新企业员工属性字段隐藏设置。	设置用户属性可见性	-

企业帐号

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
创建企业帐号用户	创建企业帐号新用户。	-	创建企业帐号用户（根据帐号类型选择对应接口）创建SSO企业帐号创建钉钉自建企业帐号邀请其他组织企业帐号加入创建企业帐号用户（历史版本）
更新企业帐号用户信息	更新指定的企业帐号用户信息。	-	更新企业帐号用户信息
查询企业帐号用户详情	获取指定企业帐号用户的详细信息。	-	查询企业帐号用户详情
获取部门企业帐号用户详情	获取指定部门中的用户详细信息。	-	获取部门企业帐号用户详情
根据手机号查询企业帐号用户	根据手机号获取企业帐号用户的userId。	-	根据手机号查询企业帐号用户
启用企业帐号	启用指定企业帐号。	启用企业帐号	-
停用企业帐号	停用指定的企业帐号。	停用企业帐号	-
强制登出企业帐号	强制登出指定的企业帐号。	强制登出企业帐号	-
查询企业帐号状态	查询某企业帐号的启用状态。	查询企业帐号状态	-
授权企业帐号可加入多组织	授权企业帐号可以加入多个组织。	授权企业帐号可加入多组织	-
查询企业帐号拥有的组织	查询企业帐号在哪些企业下拥有创建者身份，并获取这些企业信息。	查询企业帐号拥有的组织	-
企业帐号转交主管理员（创建者）	将本组织内某企业账号有所有权的组织，转交给另一企业账号，如果接收的账号不在该组织内则自动加入。	企业帐号转交主管理员（创建者）	-
根据迁移后的dingId查询原dingId	根据迁移后的dingId查询原dingId。	根据迁移后的dingId查询原dingId	-
根据迁移后的unionId查询原unionId	根据迁移后的unionId查询原unionId。	根据迁移后的unionId查询原unionId	-
根据原dingId查询迁移后的dingId	根据原dingId查询迁移后的dingId。	根据原dingId查询迁移后的dingId	-
根据原unionId查询迁移后的unionId	根据原unionId查询迁移后的unionId。	根据原unionId查询迁移后的unionId	-

部门管理

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
创建部门	创建新部门。	-	创建部门创建部门（历史版本）
更新部门	更新部门信息。	-	更新部门更新部门（历史版本）
删除部门	根据部门ID删除指定部门。	-	删除部门删除部门（历史版本）
获取部门详情	根据部门ID获取指定部门详情。	-	获取部门详情获取部门详情（历史版本）
获取部门列表	获取下一级部门基础信息。	-	获取部门列表获取部门列表（历史版本）
获取子部门ID列表	获取企业部门下的所有直属子部门列表。	-	获取子部门ID列表获取子部门ID列表（历史版本）
获取指定部门的所有父部门列表	获取指定部门的所有父部门ID列表。	-	获取指定部门的所有父部门列表获取指定部门的所有父部门列表（历史版本）
获取指定用户的所有父部门列表	查询指定用户所属的所有父级部门。	-	获取指定用户的所有父部门列表获取指定用户的所有父部门列表（历史版本）

角色管理

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
创建角色	创建新角色。	-	创建角色
创建角色组	创建角色组。	-	创建角色组
更新角色名称	更新角色名称。	-	更新角色名称
批量增加员工角色	批量增加员工角色。	-	批量增加员工角色
删除角色	根据角色ID删除指定的角色。	-	删除角色
批量删除员工角色	批量删除员工的角色。	-	批量删除员工角色
设定角色成员管理范围	设定角色成员管理范围。	-	设定角色成员管理范围
获取角色组列表	获取角色组信息。	-	获取角色组列表
获取角色列表	获取角色列表。	-	获取角色列表
获取角色详情	根据角色ID获取指定角色详情。	-	获取角色详情
获取指定角色的员工列表	获取指定角色的员工列表。	-	获取指定角色的员工列表

外部联系人

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
添加外部联系人	添加企业外部联系人。	-	添加外部联系人
删除外部联系人	删除企业外部联系人。	-	删除外部联系人
更新外部联系人	更新企业外部联系人。	-	更新外部联系人
获取外部联系人列表	获取企业外部联系人列表。	-	获取外部联系人列表
获取外部联系人标签列表	获取企业外部联系人的标签。	-	获取外部联系人标签列表
获取外部联系人详情	获取企业外部联系人的详细信息。	-	获取外部联系人详情

企业管理

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取企业邀请信息	获取企业的邀请信息。	获取企业邀请信息	-
获取企业最新钉钉指数信息	获取企业最新钉钉指数信息。	获取企业最新钉钉指数信息	-
获取企业认证信息	获取企业认证信息。	获取企业认证信息	-

通讯录可见性管理

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取通讯录隐藏设置	批量获取通讯录隐藏的设置列表。	获取通讯录隐藏设置	-
删除通讯录隐藏设置	删除通讯录隐藏设置。	删除通讯录隐藏设置	-
更新通讯录隐藏设置	新增或更新通讯录隐藏设置。	更新通讯录隐藏设置	-
设置部门可见性优先级	设置通讯录部门可见性优先级。	设置部门可见性优先级	-
新增或修改限制查看通讯录设置	新增或修改限制查看通讯录设置。	新增或修改限制查看通讯录设置	-
获取限制查看通讯录设置列表	获取限制查看通讯录的设置列表。	获取限制查看通讯录设置列表	-
删除限制查看通讯录设置	删除限制查看通讯录设置	删除限制查看通讯录设置	-

行业通讯录

API	说明	新版规范（新版服务端API）	旧版规范（服务端API）
获取部门详情	根据部门ID获取部门详情。	获取部门详情	-
获取部门下人员列表	获取部门下的人员列表信息。	获取部门下人员列表	-
获取部门列表	根据部门ID获取行业通讯录部门列表。	获取部门列表	-
获取部门用户详情	获取部门用户详情。	获取部门用户详情	-
获取企业信息	获取行业通讯录的企业信息。	获取企业信息	-