组织云钉钉API
  1. 通讯录管理
组织云钉钉API
  • 服务端API
    • 如何调用服务端API
    • 服务端SDK下载
    • 获取凭证（access_token）
      • 获取企业内部应用的access_token
      • 获取jsapi_ticket
    • 身份验证（免登）
      • 企业内部应用免登
      • 免登常见问题
    • 通讯录管理
      • 通讯录事件
      • 用户管理
        • 创建用户
        • 更新用户信息
        • 删除用户
        • 根据userid获取用户详情
        • 获取部门用户基础信息
        • 获取部门用户userid列表
        • 获取部门用户详情
        • 获取员工人数
        • 获取未登录钉钉的员工列表
        • 根据手机号获取userid
        • 根据unionid获取用户userid
        • 获取管理员列表
        • 获取管理员通讯录权限范围
        • 获取管理员的应用管理权限
      • 部门管理
        • 获取部门详情
        • 获取部门列表
        • 获取子部门ID列表
        • 获取指定部门的所有父部门列表
        • 获取指定用户的所有父部门列表
      • 角色管理
        • 删除角色
        • 创建角色
        • 创建角色组
        • 更新角色
        • 批量增加员工角色
        • 批量删除员工角色
        • 设定角色成员管理范围
        • 获取角色组列表
        • 获取角色列表
        • 获取角色详情
        • 获取指定角色的员工列表
    • 消息通知
      • 消息通知概述
      • 消息类型与数据格式
      • 消息链接说明
      • 工作通知
        • 发送工作通知
        • 更新工作通知状态栏
        • 获取工作通知消息的发送进度
        • 获取工作通知消息的发送结果
        • 撤回工作通知消息
      • 普通消息
        • 发送普通消息
  • 钉钉回调相关
    • 钉钉Stream回调
    • 事件订阅列表
  1. 通讯录管理

通讯录事件

当企业通讯录发生变化，并且注册回调事件时填写的事件类型“call_back_tag”包含通讯录事件，比如call_back_tag字段为“user_add_org”、“user_modify_org”，那么企业通讯录发生“通讯录用户增加”和“通讯录用户更改”，钉钉服务器会向回调url推送事件。

事件类型#

事件类型类别说明
user_add_org用户变更通讯录用户增加。
user_modify_org用户变更通讯录用户更改。
user_leave_org用户变更通讯录用户离职。
user_active_org用户变更加入企业后用户激活。
org_admin_add用户变更通讯录用户被设为管理员。
org_admin_remove用户变更通讯录用户被取消设置管理员。
org_dept_create部门变更通讯录企业部门创建。
org_dept_modify部门变更通讯录企业部门修改。
org_dept_remove部门变更通讯录企业部门删除。
org_remove企业信息变更企业被解散。
org_change企业信息变更企业信息发生变更。
label_user_change角色变更员工角色信息发生变更。
label_conf_add角色变更增加角色或者角色组。
label_conf_del角色变更删除角色或者角色组。
label_conf_modify角色变更修改角色或者角色组。

通讯录用户增加#

示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "user_add_org",
  "UserId": [
    "0119296xxx"
  ],
  "OptStaffId":"WB8351xx",
  "TimeStamp": "1608017258073"
}
参数说明：
参数说明
EventType事件类型。
OptStaffId操作人的userId。
TimeStamp时间戳。
UserId用户发生变更的userId列表。
CorpId发生通讯录变更的企业。

通讯录用户更改#

说明
只有当前企业内的用户信息变更时才会触发此事件，用户的个人信息变更并不会触发，例如个人头像、个人昵称、钉钉号等。
示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "user_modify_org",
  "UserId": [
    "0119296xxx"
  ],
  "OptStaffId":"WB8351xx",
  "TimeStamp": "1608017258073"
}
参数说明：
参数说明
EventType事件类型。
OptStaffId操作人的userId。
TimeStamp时间戳。
UserId用户发生变更的userId列表。
CorpId发生通讯录变更的企业。

通讯录用户离职#

示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "user_leave_org",
  "UserId": [
    "0119296xxx"
  ],
  "OptStaffId":"WB8351xx",
  "TimeStamp": "1608017258073"
}
参数说明：
参数说明
EventType事件类型。
OptStaffId操作人的userId。
TimeStamp时间戳。
UserId用户发生变更的userId列表。
CorpId发生通讯录变更的企业。

加入企业后用户激活#

示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "user_active_org",
  "UserId": [
    "0119296xxx"
  ],
  "TimeStamp": "1608017258073"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
UserId用户发生变更的userId列表。
CorpId发生通讯录变更的企业。

通讯录用户被设为管理员#

示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "org_admin_add",
  "UserId": [
    "0119296xxx"
  ],
  "TimeStamp": "1608017258073"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
UserId用户发生变更的userId列表。
CorpId发生通讯录变更的企业。

通讯录用户被取消设置管理员#

示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "org_admin_remove",
  "UserId": [
    "0119296xxx"
  ],
  "TimeStamp": "1608017258073"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
UserId用户发生变更的userId列表。
CorpId发生通讯录变更的企业。

通讯录企业部门创建#

示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "org_dept_create",
  "DeptId": [
    "432825033"
  ],
  "TimeStamp": "1608021552827"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
DeptId部门发生变更的DeptId列表。
CorpId发生通讯录变更的企业。

通讯录企业部门修改#

示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "org_dept_modify",
  "DeptId": [
    "432825033"
  ],
  "TimeStamp": "1608021552827"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
DeptId部门发生变更的DeptId列表。
CorpId发生通讯录变更的企业。

通讯录企业部门删除#

示例：
{
  "CorpId": "dinge8a5xxxx",
  "EventType": "org_dept_remove",
  "DeptId": [
    "432825033"
  ],
  "TimeStamp": "1608021552827"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
DeptId部门发生变更的DeptId列表。
CorpId发生通讯录变更的企业。

员工角色信息发生变更#

示例**：**
{
  "UserIdList": [
    "user456"
  ],
  "CorpId": "dinge8axxxx",
  "EventType": "label_user_change",
  "LabelIdList": [
    1507113581
  ],
  "action": "add",
  "TimeStamp": "1608023403474"
}
参数示例：
参数说明
EventType事件类型。
TimeStamp时间戳。
LabelIdList角色或者角色组id列表。
CorpId发生通讯录变更的企业。
UserIdList员工角色发生变更的userId列表。
action变更类型。

增加角色或者角色组#

示例：
{
  "CorpId": "dinge8axxxx",
  "EventType": "label_conf_add",
  "LabelIdList": [
    1769078330
  ],
  "scope": "1",
  "TimeStamp": "1608023994407"
}
参数描述：
参数说明
EventType事件类型。
TimeStamp时间戳。
CorpId发生通讯录变更的企业。
LabelIdList角色或者角色组id列表。

删除角色或者角色组#

示例：
{
  "CorpId": "dinge8axxxx",
  "EventType": "label_conf_del",
  "LabelIdList": [
    1688607309
  ],
  "scope": "1",
  "TimeStamp": "1608024640936"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
CorpId发生通讯录变更的企业。
LabelIdList角色或者角色组id列表。
scope管理范围。

修改角色或者角色组#

示例：
{
  "PostLabelList": [
    "{\"hidden\":false,\"name\":\"test\",\"id\":1688607309,\"extraInfo\":{}}"
  ],
  "CorpId": "dinge8axxxx",
  "EventType": "label_conf_modify",
  "PreLabelList": [
    "{\"deleted\":false,\"color\":-11687445,\"hidden\":false,\"level\":1,\"scope\":1,\"name\":\"测试\",\"id\":1688607309,\"parentId\":1688611118,\"extraInfo\":{}}"
  ],
  "LabelIdList": [
    1688607309
  ],
  "scope": "1",
  "TimeStamp": "1608024523560"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
CorpId发生通讯录变更的企业。
PreLabelList变更前的角色或者角色组。
PostLabelList变更后的角色或者角色组。
LabelIdList角色或者角色组id列表。
scope管理范围。

企业信息发生变更#

示例：
{
  "CorpId": "dinge8axxxx",
  "EventType": "org_change",
  "TimeStamp": "1608024823604"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
CorpId发生通讯录变更的企业。

企业被解散#

示例：
{
  "CorpId": "dinge8axxxx",
  "EventType": "org_remove",
  "TimeStamp": "1608024823604"
}
参数说明：
参数说明
EventType事件类型。
TimeStamp时间戳。
CorpId发生通讯录变更的企业。
修改于 2023-12-26 06:53:26
上一页
免登常见问题
下一页
创建用户
Built with