钉钉 API
服务端 API
获取访问凭证
获取应用身份相关访问凭证
钉钉 API
应用开发平台简介(新版)
应用类型介绍
应用能力介绍
基础概念
开发应用
开发流程概述
创建应用
获取开发者权限
添加应用能力
配置应用:(可选)添加开发人员
开发 AI 应用
发布应用
监控应用
开发小程序应用
(可选)开发小程序服务端
(可选)配置安全域名
开发小程序前端
上传小程序
(可选)添加小程序地址
小程序开发参考
框架
小程序目录结构
小程序框架概述
文件结构
ACSS样式语法参考
小程序 scheme
小程序的 JavaScript 引擎
性能优化建议
小程序全局配置
全局配置介绍
app.js注册小程序
app.json全局配置
getApp()方法
多语言配置
小程序页面配置
小程序页面介绍
注册小程序页面
页面样式
getCurrentPages 方法
AXML视图层
视图层概述
数据绑定
条件渲染
列表渲染
引用
模板
SJS 语法参考
SJS概述
变量
注释
运算符
语句
数据类型
基础类库
esnext
事件
事件概述
事件对象
自定义组件
开发流程
使用自定义组件
发布自定义组件
开发自定义组件
组件配置
组件模板和样式
data
组件对象
组件生命周期
mixins
其他组件实例属性
基础组件
web-view
open-avatar 头像组件
视图容器
view 视图容器
swiper 滑块视图容器
scroll-view 可滚动视图区域
movable-view 可移动视图容器
movable-area 可移动视图区域
基础内容
text 文本
icon 图标
progress 进度条
rich-text 富文本
表单
form 表单
button 按钮
label 标签
input 输入框
textarea 多行输入框
radio 单选按钮
radio-group 单项项目组
checkbox 多项选择器
switch 单选开关
slider 滑动选择器
picker view 滚动选择器
picker底部弹起的滚动选择器
导航
navigator 页面链接
媒体
Image 图片
video 视频播放器
地图
map 地图
画布
canvas 画布
移动客户端接入
小程序使用网页应用客户端 API
小程序运行/更新机制
小程序运行机制
小程序更新机制
开发网页应用
配置网页应用
(可选)开发网页应用前端
(可选)开发网页应用服务端
H5微应用开发参考
客户端SDK
图片缩放
前端组件 (Ding Design)
错误码说明
跳转协议
页面事件监听
移动客户端接入
接入钉钉分享
钉钉分享介绍
iOS分享SDK接入流程
Android分享SDK接入流程
IOS分享SDK合规指南
Android分享SDK合规指南
分享SDK下载
分享SDK常见问题
接入钉钉登录
钉钉登录介绍
Android应用授权登录接入流程
iOS 应用授权登录接入流程
Android登录SDK合规指南
开发酷应用
概述
创建酷应用
开发群聊酷应用
概述
接入群聊酷应用
(可选)进阶功能
接入机器人能力
管理酷应用
互动卡片
吊顶卡片
感知群变化(事件订阅)
开发单聊酷应用
概述
接入单聊酷应用
(可选)进阶功能
接入机器人功能
开发互动卡片
单聊酷应用开发参考
单聊相关跳转协议
开发消息菜单酷应用
概述
接入消息菜单
开发链接增强酷应用
概述
接入链 接增强
开发快捷指令酷应用
概述
接入快捷指令
开发成员资料页酷应用
概述
接入成员资料页
成员资料页开发参考
创建通讯录卡片
成员资料页扩展互动卡片能力
开发文档酷应用、
概述
接入文档酷应用
文档酷应用开发参考
配置文档酷应用Manifest
开发文档酷应用脚本服务和 UI 页面
开发机器人应用
概述
企业机器人
配置机器人应用
添加机器人入群
Webhook 机器人
开发机器人服务端
机器人接收消息
机器人回复/发送消息
添加机器人入群
服务端 API
开发指南
如何调用服务端API
新旧版规范服务端API区别
添加接口调用权限
使用新版服务端API
如何调用新版服务端API
安装SDK
分页
错误码
调用量和调用频次说明
关于企业内部应用API调用量和频次限制的调整说明
身份验证(免登)
概述
常见问题
操作流程
企业内部应用免登
应用管理后台免登
使用教程
实现登录第三方网站
通过免登码获取用户信息
获取应用管理员的身份信息
获取访问凭证
概述
使用教程
获取应用的API访问凭证
获取用户个人身份访问凭证
获取登录用户的访问凭证
获取用户token
获取应用身份相关访问凭证
获取jsapiTicket
POST
获取定制应用的accessToken
POST
获取企业内部应用的accessToken
POST
获取微应用后台免登的accessToken
POST
通讯录管理
概述
权限申请
常见问题
使用教程
企业OA系统与钉钉通讯录实现同步
通讯录员工相关操作
通讯录部门相关操作
获取企业下所有部门列表
获取企业下所有员工信息
用户管理
创建用户
更新用户信息
删除用户
查询用户详情
获取部门用户基础信息
获取部门用户userid列表
获取部门用户详情
获取员工人数
获取未登录钉钉的员工列表
根据手机号查询企业账号用户
根据unionid获取用户userid
获取管理员列表
获取管理员通讯录权限范围
查询离职记录列表
设置高管模式
获取用户高管模式设置
删除用户属性可见性设置
获取用户属性可见性设置
设置用户属性可见性
企业账号
企业账号概述
创建SSO企业账号
创建钉钉自建企业账号
邀请其他组织企业账号加入
更新企业账号用户信息
查询企业账号用户详情
获取部门企业账号用户详情
根据手机号查询企业账号用户
根据迁移后的dingId查询原dingId
根据迁移后的unionId查询原unionId
根据原dingId查询迁移后的dingId
根据原unionId查询迁移后的unionId
启用企业帐号
停用企业帐号
强制登出企业帐号
查询企业帐号状态
授权企业帐号可加入多组织
查询企业帐号拥有的组织
企业帐号转交主管理员(创建者)
部门管理
创建部门
更新部门
删除部门
获取部门详情
获取部门列表
获取子部门ID列表
获取指定部门的所有父部门列表
获取指定用户的所有父部门列表
角色管理
创建角色
创建角色组
更新角色名称
批量增加员工角色
删除角色
批量删除员工角色
设定角色成员管理范围
获取角色组列表
获取角色列表
获取角色详情
获取指定角色的员工列表
外部联系人
添加外部联系人
删除外部联系人
更新外部联系人
获取外部联系人列表
获取外部联系人标签列表
获取外部联系人详情
企业管理
获取企业邀请信息
获取企业最新钉钉指数信息
获取企业认证信息
通讯录可见性管理
新增或更新通讯录隐藏设置
获取通讯录隐藏设置
删除通讯录隐藏设置
设置部门可见性优先级
新增或修改限制查看通讯录设置
获取限制查看通讯录设置列表
删除限制查看通讯录设置
行业通讯录
权限申请
获取部门列表
获取部门详情
获取部门下人员列表
获取部门用户详情
获取企业信息
获取通讯录权限范围
获取用户通讯录个人信息
上下游组织
概述
创建上下游组织
解除关联组织
获取上下游组织的邀请信息
批量通过伙伴组织的加入申请
更新分支组织在主干组织内的属性信息
设置伙伴组织在上下游组织内的可见范围
获取企业已经加入的或申请加入中的上下游组织的信息
获取已加入或正在申请加入上下游组织的组织和个人信息
上下级组织
概述
申请权限
授权数据编码及入参条件概览
解除关联组织
获取主干组织列表
获取分支组织列表
批量通过伙伴组织的加入申请
获取上下级组织分支授权的数据
设置分支组织在主干组织内的可见范围
更新分支组织在主干组织内的属性信息
服务窗
概述
客户案例
操作流程:自建服务窗应用
服务窗消息类型介绍
批量发送服务窗消息
发送服务窗单人消息
获取企业下服务窗列表
批量获取关注服务窗用户信息
获取关注服务窗用户信息
即时通信IM
会话管理
概述
权限申请
操作流程
创建群聊会话(场景群)
创建快捷入口(群插件)
使用教程
群助手发送消息
群会话操作流程
群聊会话入门流程
快捷入口接入教程(群插件)
纯拉模式流程指南
创建及更新互动卡片
群成员管理流程
群信息查询相关流程
企业内部群升级为群聊会话
快捷入口实现跳转到企业内部应用(免登)
会话1.0
群管理
创建群
更新群
查询群信息
更新群成员的群昵称
更新群管理员
批量更新群管理员
设置禁止群成员私聊
获取入群二维码链接
获取群会话的OpenConversationId
会话2.0
常见问题
群管理
创建群
更新群
查询群信息
新增群成员
删除群成员
设置群成员禁言状态
查询群禁言状态
更新群成员的群昵称
更新群管理员
查询群简要信息
查询群成员
查询群内群模版机器人
群模板
启用群模板
停用群模板
群吊顶
创建并开启互动卡片吊顶
关闭互动卡片吊顶
群助手
发送群助手消息
消息通知
概述
权限申请
常见问题
使用案例
场景化方案
使用教程
点击工作通知跳转到钉钉小程序
点击工作通知跳转到钉钉微应用
工作通知
工作通知
消息通知类型
消息链接说明
发送工作通知
撤回工作通知消息
更新工作通知状态栏
获取工作通知消息的发送进度
获取工作通知消息的发送结果
机器人
概述
权限申请
用户指南
企业内部应用机器人的创建和安装
群模板机器人的创建和安装
自定义机器人的创建和安装
三方工具机器人的创建和安装
GitLab机器人
GitHub机器人
JIRA机器人
阿里云Code机器人
阿里云Codeup机器人
Travis机器人
CODING机器人
Tower群机器人接入
开发指南
机器人发送消息的类型
机器人发送单聊消息
企业内部应用机器人在人与机器人单聊场景中的使用
企业内部应用机器人在人与人单聊场景中的使用
机器人发送群聊消息
企业内部应用机器人在群聊场景中的使用
群模板机器人在群聊场景中的使用
自定义机器人在群聊场景中的使用
API 参考
常见问题
发送DING消息
发送DING消息
撤回已经发送的DING消息
发送普通消息
批量发送人与机器人会话中机器人消息
人与人会话中机器人发送普通消息
机器人发送群聊消息
自定义机器人发送群消息
发送互动卡片消息
机器人发送互动卡片(普通版)
更新机器人发送互动卡片(普通版)
发送钉钉互动卡片(高级版)
更新钉钉互动卡片
注册互动卡片回调地址
人与人会话中机器人发送互动卡片
发送轻量级互动卡片
消息接收
接收消息
下载机器人接收消息的文件内容
消息查询
批量查询人与机器人会话机器人消息是否已读
查询人与人会话中机器人消息已读列表
查询企业机器人群聊消息用户已读状态
消息撤回
批量撤回人与机器人会话中机器人消息
批量撤回人与人会话中机器人消息
企业机器人撤回内部群消息
机器人管理
获取群内机器人列表
快捷入口管理
设置单聊机器人快捷入口
查询单聊机器人的快捷入口
清空单聊机器人快捷入口
钉钉客联
概述
权限申请
使用教程
创建钉钉客联帐号
群会话操作流程
创建钉外两人群与店铺群操作流程
发送消息流程
创建普通群
创建两人群
创建钉外账号
批量查询跨钉两人群列表
获取钉钉客联H5会话地址
查询钉外账号未读消息数
添加互通群成员
移除互通群成员
修改互通群头像
修改互通群名称
更换互通群群主
查询互通群成员列表
解散互通群
互通群机器人发送群消息
钉外账号向钉内账号或互通群发送消息
钉内账号向互通群或钉外账号发送消息
考勤
概述
权限申请
常见问题
操作流程
启用智能统计
使用教程
场景化方案
考勤组管理的操作流程
考勤组的考勤人员管理
获取员工到勤情况
企业自有假勤审批同步到钉钉
考勤补卡操作流程
按天获取员工考勤报表信息
教程:获取考勤打卡结果
考勤组管理
创建考勤组
更新考勤组
删除考勤组
搜索考勤组摘要
获取考勤组详情
根据groupkey查询考勤组信息
groupKey转换为groupId
groupId转换为groupKey
批量获取考勤组摘要
批量获取考勤组详情
获取用户考 勤组
批量新增参与考勤人员
更新参与考勤人员
获取参与考勤人员
获取考勤组员工的userid
批量删除考勤组成员
查询考勤组员工
考勤组成员校验
批量新增wifi信息
批量移除wifi
批量查询wifi
批量新增地点
批量删除地点
批量查询地点
查询考勤写操作权限
考勤打卡
获取打卡结果
获取打卡详情
上传打卡记录
考勤班次
创建班次
删除班次
修改打卡时段设置
查询历史班次
按名称搜索班次
获取班次摘要信息
获取班次详情
考勤排班
配置考勤排班附加信息
查询成员排班信息
批量查询人员排班信息
排班制考勤组排班
查询排班打卡结果
查询企业考勤排班详情
批量查询成员排班概要信息
考勤规则
分页获取加班规则列表
分页获取补卡规则列表
批量获取加班规则设置
考勤统计
查询是否启用智能统计报表
获取用户考勤数据
获取报表假期数据
获取考勤报表列定义
获取考勤报表列值
查询用户某段时间内是否处于封账状态
考勤机管理
根据设备ID获取员工信息
查询考勤机信息
变更智能考勤机员工
查询员工智能考勤机列表
假勤审批
预计算时长(旧版SDK)
预计算时长(新版SDK)
通知审批通过(旧版SDK)
通知审批通过(新版SDK)
通知审批撤销
通知补卡通过
通知换班通过
计算请假时长
查询请假状态
假期管理
添加假期规则
更新假期规则
删除假期规则
初始化假期余额
批量更新假期余额
查询假期类型
查询假 期余额
批量查询员工假期余额变更记录
封账规则
查询指定用户的封账规则
智能人事
概述
权限申请
常见问题
使用教程
获取并补全员工的民族信息
职位管理
获取企业职位列表
获取企业职级列表
获取企业职务列表
花名册
花名册自定义字段业务code
获取花名册元数据
获取花名册字段组详情
获取员工花名册字段信息
更新员工花名册信息
新增或删除花名册选项类型字段的选项
员工管理