钉钉 API copy
配置RDS推送
复制页面
钉钉 API copy
应用开发平台简介(新版)
应用类型介绍
应用能力介绍
基础概念
历史文档(不推荐)
钉钉云
接入必读
钉钉云介绍
钉钉云介绍
钉钉云的安全限制
申请钉钉云账号
申请钉钉云账号
阿里云账号托管为钉钉云账号
开通/购买云产品
钉钉云解决方案
开通云产品
应用部署
申请钉钉云安全组白名单
钉钉云数据推送
钉钉云推送概述
设置RDS实例接收钉钉推送
查看RDS中钉钉推送的数据
钉钉云数据推送格式
钉钉云推送数据格式
数据格式
应用试用记录回调信息说明
家校通讯录2.0数据推送
释放云产品
释放钉钉云产品
常见问题
接入常见问题
钉钉云产品的价格
充值/退款等财务问题
资源的购买
迁移方案
钉钉云迁移聚石塔方案
带EBS数据盘ECS迁移
SLS数据迁移
HTTP回调
HTTP回调概述
开发小程序(HTTP回调)
事件列表
回调接口
接收回调消息
注册回调事件
获取推送失败的事件列表
更新事件接口
查询订阅事件
删除事件回调接口
事件列表
测试回调URL事件
推送suite_ticket事件
验证和更新回调URL事件
应用回调地址更新
企业授权开通应用事件
解除授权事件
启用和停用应用事件
通讯录授权范围变更事件
审批事件
用户购买下单事件
通用回调事件
测试回调URL事件
推送suite_ticket事件
验证和更新回调URL事件
应用回调地址更新
企业内部应用回调事件
审批事件
群会话事件
签到事件
考勤事件
会议室事件
家校通讯录事件
第三方企业应用回调事件
企业授权开通应用事件
解除授权事件
启用和停用应用事件
通讯录授权范围变更事件
审批事件
用户购买下单事件
审批待办
使用案例
权限申请
项目任务
迁移任务信息
查询任务详情
新增任务信息
根据任务ID删除任务
更新任务基础信息
根据项目批量删除任务信息
批量移除指定用户的所有任务
批量移除指定用户的项目任务
将用户参与的所有任务添加到任务列表
将用户新参与的任务添加到任务列表
清理历史任务数据
获取任务详情
新增钉钉待办任务
查询企业下用户待办列表
更新钉钉待办任务
查询企业个人待办数量
旧版宜搭API参考
概述
流程实例
单据实例
任务中心
其他
通讯录管理
用户管理1.0(不推荐)
创建用户
更新用户信息
删除用户
根据userid获取用户详情
获取部门用户基础信息
获取部门用户userid列表
获取部门用户详情
获取员工人数
获取未登录钉钉的员工列表
根据手机号获取userid
根据unionid获取userid
获取管理员列表
部门管理1.0(不推荐)
创建部门
删除部门
更新部门
获取部门详情
获取部门列表
获取子部门ID列表
获取指定部门的所有父部门列表
获取指定用户的所有父部门列表
钉钉红包
概述
权限申请
发送企业红包
查询红包详情
身份验证(免登)
通过免登码获取用户信息(不推荐)
花名册
获取员工花名册字段信息
更新员工花名册
行业连接
创建部门
注册单个设备
批量注册设备
日程
使用案例
权限申请
创建日程
修改日程
修改日程参与者
取消日程
开发前必读
应用类型介绍
成为钉钉开发者
基础概念
开发须知
事件订阅
开发钉钉应用
企业内部应用开发
开发流程介绍
授权服务商开发
创建应用
开发管理
人员管理(仅限小程序)
权限管理
监控中心
安全中心(仅限小程序)
版本管理与发布
事件订阅
配置事件订阅
事件列表
测试回调URL事件
通讯录事件
家校通讯录事件
审批事件
群会话事件
签到事件
考勤事件
会议室事件
智能人事事件
圈子回调事件
客户动态事件
日程事件
获取推送失败的事件列表
入门教程
开发小程序
开发H5微应用
创建快捷链接
第三方企业应用开发
第三方企业应用说明
创建应用
人员管理
权限管理
监控中心
版本管理与发布
钉钉安全域名
应用自检
定向应用分发
开发管理
开发概述
接入服务端能力
基础配置
数据推送
概述
授权应用开通
数据格式
配置数据推送
配置SyncHTTP推送
RDS数据推送(推荐)
RDS推送概述
配置RDS数据推送
部署应用
部署概述
聚石塔
聚石塔概述
入驻聚石塔
应用部署
RDS推送
RDS推送概述
查看钉钉推送的数据
数据格式
配置RDS推送
使用聚石塔RDS数据库
使用自有MySQL
最佳实践
架构最佳实践
监控及报警最佳实践
创建服务群
应用内接入服务群
入门教程
开发小程序(RDS推送)
第三方个人应用开发
开发流程介绍
快速入门
创建和配置应用
发布应用
开发应用
免登接入
发送消息
第三方个人应用发布规范
第三方个人应用发布规范
产品设计规范
产品发布流程
服务端接口
获取第三方个人应用的access_token
根据sns临时授权码获取用户信息
发送消息
获取用户授权的持久授权码
H5微应用
开发前必读
JSAPI总览
JSAPI鉴权
免登流程
统一跳转协议
页面事件监听
图片缩放
错误码说明
JSAPI参考
免登
获取微应用免登授权码
获取微应用反馈式操作的临时授权码
设备
获取手机基础信息
获取uuid
获取热点接入信息
获取wifi状态
获取网络类型
读取NFC芯片内容
NFC数据写入
日期和月历
日期选择器
时间选择器
日期及时间选择器
月历组件:选择某时间
月历组件:选择某天
月历组件:选择半天
月历组件:选择日期区间
通讯录选人
选择部门和人
选择部门信息
创建企业聊天
设定规则选人
选取手机通讯录
PC端选择企业内部的人
业务
分享
下拉控件
复制到粘贴板
打开应用
导航栏
设置导航栏颜色
微应用页面支持横屏
隐藏导航栏右侧按钮,禁止导航栏右侧分享按钮
设置导航栏标题
标题栏添加问号图标
设置左侧导航按钮文本
关闭当前页面
关闭页面
返回上一级页面
设置导航栏右侧单个按钮
设置导航栏右侧多个按钮
自定义下拉菜单按钮的图片
替换页面
弹窗
alert
confirm
prompt
手机震动
显示加载
隐藏加载
toast
actionsheet
modal弹浮层
extendModal
多选组件
会话
获取会话信息
根据corpid选择会话
根据chatId跳转到对应会话
打开与某个用户的单聊会话
电话
拨打钉钉电话
通用电话拨打
检查某企业的办公电话开通状态
拨打单人电话选项(可定制)
DING
DING 2.0 发钉
DING 1.0 发钉
文件
批量检测本地文件是否存在
打开本地文件
下载文件
存储
设置存储信息
获取存储信息
删除存储信息
钉盘
保存文件到钉盘
上传附件到钉盘/从钉盘选择文件
预览钉盘文件
选取钉盘目录
图片
图片预览
地图
获取当前地理位置信息(单次定位)
连续获取当前地理位置信息(持续定位)
停止连续定位
批量连续定位状态
地图定位
地图页面支持搜索
展示位置
音频
开 始录音
停止录音
监听录音自动停止
下载音频
播放语音
暂停播放语音
恢复暂停播放的语音
停止播放音频
监听播放自动停止
语音转文字
摇一摇
启动摇一摇
停止摇一摇
UI控件
输入框
设置顶部进度条颜色
启用下拉刷新
收起下拉刷新
禁用下拉刷新
启用iOS Webview弹性效果
禁用iOS Webview弹性效果
扫码
扫条形码、二维码
扫名片
支付
支付接口
转屏横屏
微应用页面支持转屏
微应用页面支持横屏
微应用页面全屏展示
微应用页面导航栏透明
旋转屏幕
重置旋转屏幕
外部联系人
选择外部联系人
编辑外部联系人
自定义联系人
单选自定义联系人
多选自定义联系人
打开新页面
打开应用内页面
打开目标页面
打开模态框
打开侧边面板
数据加解密
数据加密
数据解密
视频会议
发起视频会议
办公电话
查询企业是否已开办公电话
发起办公电话呼叫
查询话单列表
在线课堂
发起在线课堂
授权
审批
授权获取审批实例数据
服务窗
获取用户授权
发单聊消息授权
专属钉钉
获取用户信息
服务端API
如何调用服务端API
服务端SDK下载
添加接口调用权限
调用频率限制
获取凭证(access_token)
获取企业内部应用的access_token
服务商获取第三方应用授权企业的access_token
获取第三方企业应用的suite_access_token
获取jsapi_ticket
获取微应用后台免登的access_token
身份验证(免登)
概述
企业内部应用免登
第三方企业应用免登
应用管理后台免登
钉钉内免登第三方网站
扫码登录第三方网站
使用钉钉账号登录第三方网站
免登常见问题
接口
应用授权
应用授权
激活应用
获取授权应用的基本信息
获取企业授权信息
获取授权企业的永久授权码
获取应用未激活的企业列表
重新授权未激活应用的企业
通讯录管理
权限申请
通讯录事件
常见错误
获取企业全员信息
互联平台
互联平台概述
群会话管理
申请权限
场景群
场景群概述
创建群会话
获取群会话信息
修改群会话
设置群管理员
设置禁止群成员私聊
获取入群二维码链接
设置群成员昵称
消息通知
消息通知概述
消息类型与数据格式
消息链接说明
使用模版发送工作通知
消息模板概述
管理消息模板
使用模板发送工作通知消息
企业群消息
概述
发送消息到企业群
查询群消息已读人员列表
普通消息
发送普通消息
智能填表
概述
获取用户创建的填表模板
获取填表实例数据
获取实例详情
群机器人
群机器人概述
开发企业内部机器人
自定义机器人接入
钉钉运动
权限申请
查询用户是否开启了钉钉运动
获取个人或部门钉钉运动数据
批量获取钉钉运动数据
应用管理
权限申请
获取应用列表
获取员工可见的应用列表
设置应用的可见范围
获取应用可见范围
创建H5微应用
删除H5微应用
文件存储
媒体管理
钉盘
权限申请和基础概念
使用案例
钉盘接口接入流程
文件上传
概述
单步文件上传
开启分块上传事务
上传文件块
提交文件上传事务
发送钉盘文件给指定用户
保存文件到自定义或审批钉盘空间
获取企业下的自定义空间
获取应用自定义空间使用详情
授权用户访问企业的自定义空间
新教育
钉钉教育组织内部应用SI接入解决方案
钉钉教育应用服务商接入解决方案
局校关联
通用基础
权限申请和基础概念
学段
获取学段元数据列表
学科
获取学科元数据列表
创建学科实例
更新学科实例
删除学科实例
获取学科实例详情
获取学科实例列表
查询教育组织类型
在线课堂
概述
权限申请
排课
创建课程
修改课程
删除课程
获取课程详情
获取课程列表
添加课程参与方
获取课程参与方列表
移除课程参与方
授课
开始课程
加入课程
结束课程
回放课程
课堂数据
课堂数据概述
课堂数据推送
获取课堂概要数据
获取课堂明细数据
家庭
权限申请
家庭Feed同步
查询家庭孩子信息
学习推荐数据回流
静态推荐数据同步
专属钉钉
权限申请
数据统计
视频直播统计
获取视频直播明细列表
获取视频直播观看人员列表
获取企业视频直播统计列表(部门维度)
获取企业视频直播统计数据
视频会议统计
获取企业某天的视频会议统计数据
获取企业某天的所有部门视频会议统计数据
获取企业视频会议明细列表
电话会议统计
获取企业某天的所有部门电话会议统计列表
获取企业电话会议明细列表
获取企业某天的电话会议数据
企业其他数据统计
获取企业各类群组创建情况
获取企业聊天数据
获取企业部门聊天数据(部门维度)
获取企业应用访问情况
统计企业活跃用户
企业活跃用户统计列表(部门维度)
查询企业通讯录未激活用户列表
获取企业DING使用数据
获取企业DING使用数据(部门维度)
获取年报数据
获取年报数据
智能办公电话
权限申请
向授权开通第三方应用的管理员发起智能办公电话
查询可发起智能办公电话的员工
删除可发起智能办公电话的员工
设置可发起智能办公电话的员工
应用市场
应用内购
应用内购概述
接入流程
创建内购商品
获取内购商品SKU页面地址
内购商品订单处理完成
获取内购订单信息
应用内购商品核销
获取未处理的已支付订单
项目管理
查询项目中文件操作日志
客户管理(官方CRM)
概述
权限申请
客户管理标准对象
客户管理
创建CRM客户数据
更新CRM客户数据
删除CRM客户数据
批量获取客户数据
按照ID列表批量获取客户数据
获取客户对象的元数据
联系人管理
创建CRM联系人数据
更新CRM联系人数据
客户管理自定义对象
批量获取自定义对象数据
按照ID列表批量获取CRM自定义表单数据
回调事件
元数据回调事件
主数据回调事件
培训
概述
权限申请
直播类课程
获取培训观看数据
查询直播课程的可观看白名单
修改直播课程的可观看白名单
剪辑直播课程回放
创建培训课程
删除培训课程
修改培训课程
获取培训课程的基本信息
智能硬件
权限申请
智能硬件设备数据推送
附录
回调事件消息体加解密
签名计算方法
第三方访问接口的签名计算方法
个人免登场景的签名计算方法
RSA私钥对参数进行签名
通用能力
钉钉统一授权套件
概述
接入流程
常见问题
常见问题
钉钉聊天中链接转卡片
新版服务端API(DingTalk OpenAPI)
API总览
使用DingTalk OpenAPI
添加接口调用权限
分页
调用频率限制
错误码
服务端SDK下载
获取访问凭证
概述
获取用户个人身份访问凭证
获取登录用户的访问凭证
获取用户token
获取应用身份相关访问凭证
获取应用的API访问凭证
获取API访问凭证
获取企业内部应用的accessToken
获取第三方应用授权企业的accessToken
获取第三方企业应用的suiteAccessToken
身份验证(免登)
教程:实现登录第三方网站
统一授权登录第三 方网站
通讯录
权限申请
专属账号
根据迁移后的dingId查询原dingId
根据迁移后的unionId查询原unionId
根据原dingId查询迁移后的dingId
根据原unionId查询迁移后的unionId
设置部门可见性优先级
应用市场
续费变配接入
应用内授权开通接入
流程概述
接入方案总览
测试
验收
上线流程
应用内授权开通FAQ
个人版接入
接入须知
个人版接入方案
验收
上线流程
个人版接入FAQ
查询应用市场订单详情
考勤
权限申请
查询考勤写操作权限
查询用户某段时间内是否处于封账状态
根据设备ID获取员工信息
查询考勤机信息
钉盘
概述
文件管理
查询文件(夹)列表
查询文件(夹)信息
添加文件(夹)
删除文件(夹)
移动文件(夹)
修改文件(夹)名
文件传输
文件上传流程
文件下载流程
获取文件下载信息
获取文件上传信息
专属钉钉
数据统计
视频会议数据
获取视频会议详情
企业日程数据
获取累计创建日程人数
企业日志数据
获得企业创建日志相关信息(部门维度)
钉钉文档数据
获取企业创建钉钉文档数(部门维度)
获取企业创建钉钉文档数(组织维度)
互动服务窗数据
获取互动服务窗相关数据
企业其他数据
获取用户月活跃数据
获取用户版本分布情况
数据目录
概述
获取企业用户激活状态统计数据
获取数字区县组织信息
获取企业全员圈统计数据
获取企业DING接收及评论统计数据
获取企业群聊统计数据
获取企业用户在线统计数据
获取企业单聊统计数据
获取企业电话会议统计数据
获取企业视频会议统计数据
获取企业钉盘统计数据
获取企业日程统计数据
获取企业待办统计数据
获取企业日志统计数据
获取企业接收红包统计数据
获取企业邮箱统计数据
获取企业钉钉运动统计数据
获取企业文档统计数据
获取企业签到统计数据
获取企业公告统计数据
获取企业考勤统计数据
获取企业审批统计数据
获取企业DING发送统计数据
获取企业员工类型统计数据
获取企业群直播统计数据
获取企业发红包统计数据
制造业
制造业开放API概述
数字化管理师
概述
检查用户是否完成所有任务
文档
钉钉文档说明
创建团队空间文档
添加团队空间文档成员
添加团队空间成员
新建团队空间
删除团队空间文档成员
删除团队空间成员
查询团队空间信息
修改团队空间文档成员
更新团队空间成员
生态伙伴API
概述
安装SDK
小程序
钉钉小程序介绍
小程序开发工具
小程序运行/更新机制
小程序运行机制
小程序更新机制
框架
小程序目录结构
小程序框架概述
文件结构
小程序全局配置
全局配置介绍
app.js注册小程序
app.json全局配置
getApp()方法
多语言配置
小程序页面配置
小程序页面介绍
注册小程序页面
页面样式
getCurrentPages 方法
AXML视图层
视图层概述
数据绑定
条件渲染
列表渲染
引用
模板
基础组件
小程序JSAPI
JSAPI总览
免登授权码
地图
创建地图对象MapContex
MapContext
MapContext 概览
计算地图路径(calculateDistance)
添加/删除/更新指定标记(changeMarkers)
清除步行导航路线(clearRoute)
设置所有手势是否可用(gestureEnable)
获取当前地图中心位置(getCenterLocation)
获取地图属性(getMapProperties)
获取地图整体的视野范围(getRegion)
移动视野到定位点(moveToLocation)
规划默认步行路线(showRoute)
设置指南针是否可见(showsCompass)
设置比例尺控件是否可见(showsScale)
指定标记进行动画(smoothMoveMarker)
轨迹动画(smoothMovePolyline)
平移点标记(translateMarker)
增量更新地图(updateComponents)
点标记(Marker)图鉴
开放接口
扫码
分享
DING
支付
通讯录选人
选人与部门
选择部门信息
创建企业群聊天
选取手机通讯录
选择外部联系人
编辑外部联系人
单选自定义联系人
电话
拨打钉钉电话
唤起拨打电话菜单
检查某企业办公电话开通状态
钉盘
转存文件到钉盘
钉盘文件预览
上传附件到钉盘/从钉盘选择文件
选取钉盘目录
会话
获取会话信息
选择会话
根据chatId跳转到对应会话
打开与某个用户的聊天页面(单聊会话)
授权
审批
授权获取审批实例数据
服务窗
获取用户授权
基础
dd.canIUse
dd.corpId
获取基础库版本号
更新管理小程序
使用UpdateManager更新小程序
网络
发网络请求
上传文件
下载文件
WebSocket
创建WebSocket连接
监听WebSocket连接打开事件
取消监听WebSocket连接打开事件
监听WebSocket错误
取消监听WebSocket错误。
发送数据
监听接收到的消息事件
取消监听接收消息事件
关闭WebSocket连接
监听WebSocket关闭
取消监听WebSocket关闭事件
多媒体
图片
选择图片
预览图片
保存图片到手机相册
压缩图片
获取图片信息
编辑图片
录音管理
获取录音管理器
背景音频管理
获取背景音频管理
视频
选择视频
创建video对象
界面
显示模式
导航栏
页面跳转(保留当前页)
页面跳转(关闭当前页)
页面跳转(关闭所有页面)
返回上一级或多级页面
设置导航栏
TabBar
跳转到指定tabBar页面
添加tabBar文本
移除tabBar文本
显示tabBar红点
隐藏tabBar红点
添加tabBar页面
移除tabBar页面
交互反馈
显示警告框
显示确认框
显示弱提示
隐藏弱提示
显示加载提示
隐藏加载提示
显示操作菜单
离开页面二次确认
离开二次确认配置
取消当前页面的离开二次确认
下拉刷新
停止下拉刷新
下拉刷新
选择日期
打开日期选择列表
动画
创建动画实例
画布
创建canvas
CanvasContext
CanvasContext概览
把画布内容导出成图片(toTempFilePath)
文本对齐方式(setTextAlign)
文本基线(setTextBaseline)
设置填充色(setFillStyle)
设置边框颜色(setStrokeStyle)
设置阴影样式(setShadow)
创建线性的渐变色(createLinearGradient)
创建圆形的渐变色(createCircularGradient)
创建渐变点(addColorStop)
设置线条宽度(setLineWidth)
设置线条的端点样式(setLineCap)
设置线条的交点样式(setLineJoin)
设置最大斜接长度(setMiterLimit)
创建矩形(rect)
填充矩形(fillRect)
画一个矩形(strokeRect)
清除画布上矩形区域内的内容(clearRect)
填充内容(fill)
画出当前路径的边框(stroke)
创建路径(beginPath)
关闭一个路径(closePath)
移动路径(moveTo)
增加一个新点(lineTo)
画一条弧线(arc)
创建三次方贝塞尔曲线路径(bezierCurveTo)
设置为剪切路径(clip)
创建二次贝塞尔曲线路径(quadraticCurveTo)
缩放(scale)
顺时针旋转(rotate)
变换原点坐标(translate)
设置字体大小(setFontSize)
绘制被填充的文本(fillText)
绘制图像(drawImage)
设置全局画笔透明度(setGlobalAlpha)
保存当前绘图上下文(save)
恢复绘图上下文(restore)
将描述画到画布中(draw)
获取canvas区域隐含的像素数据(getImageData)
将像素数据绘制到画布(putImageData)
键盘
监听键盘弹起事件
监听键盘收起事件
隐藏键盘
滚动
滚动到页面的目标位置
节点查询
创建IntersectionObserver对象实例
创建SelectorQuery节点查询对象
SelectorQuery节点查询对象
IntersectionObserver
IntersectionObserver概览
停止监听
监听相交状态变化
指定一个节点作为参照区域之一
指定页面显示区域作为参照区域之一
位置
获取用户当前的地理位置信息
使用内置地图查看位置
缓存
缓存概览
将数据存储在本地缓存
同步将数据存储
获取缓存数据
同步获取缓存数据
删除缓存数据
同步删除缓存数据
设备
振动
使用振动功能
使用短振动
使用长振动
蓝牙
蓝牙概览
蓝牙 API 错误码对照表
常见问题
低耗电蓝牙
查找设备并连接
断开蓝牙链接
获取蓝牙设备所有特征值
获取蓝牙设备所有服务
设置读特征通知模式
监听特征值变化事件
移除监听特征值变化事件
移除监听连接状态变化事件
监听蓝牙连接状态事件
读取蓝牙设备特征值数据
向蓝牙设备特征值中写入数据
传统蓝牙
初始化蓝牙接口
关闭蓝牙适配器
获取本机蓝牙模块状态
搜寻附近蓝牙设备
停止搜寻附近的蓝牙设备
获取所有已发现的蓝牙设备
获取已连接设备
开启监听蓝牙状态变化事件
移除监听蓝牙状态变化事件
监听发现新设备事件
移除发现新设备事件
系统信息
获取手机系统信息
获取手机系统信息的同步接口
网络状态
获取当前网络状态
剪切板
获取系统剪贴板的内容
设置剪切板数据
拉群11
e签宝
e签宝开放能力概述
e签宝开放API概览
通知回调
e签宝1.0
鉴权
ISV服务商数据初始化
获取授权的页面地址
取消企业授权
获取企业e签宝微应用状态
套餐
套餐转售(分润模式)
套餐转售(底价结算模式)
获取套餐余量
用户
查询企业是否实名
查询用户是否实名
获取企业控制台地址
获取企业实名地址
获取用户实名地址
文件
上传文件
获取文件上传地址
获取文件详情
签署流程
获取发起签署任务地址
获取签署人签署地址
获取流程任务详情
获取流程任务用印审批列表
获取流程任务合同列表
获取流程签署详细信息
e签宝2.0
鉴权
套餐
用户
拉取
客户管理
获取服务窗联系人信息
释放客户
合作空间
概述
互动服务窗
事件回调
服务号管理
宜搭应用开发
概述
表单
删除序列
更新状态
获取流程定义
任务
执行宜搭的审批任务
更新流程实例
获取流程设计的节点信息
获取流程节点按钮列表
应用
获取平台资源
批量发起回调
列出插件信息
查询插件信息列表
批量获取应用信息
新购宜搭产品
查询应用信息列表
权益
应用授权校验
新购授权订单
校验变配
校验订单
通过调用者unionId获取激活码
通知授权结果
变配租户信息
查询商品列表
注册账号
验证激活结果
校验订单的升级状态
续费服务订单
终止阿里云授权
移除租户资源
续费租户
变更账号租户信息
附件
其他接口
获取平台服务资源
获取应用下的页面列表
多渠道新购校验
执行自定义API
查询激活码
查询销售用户信息
查询企业级别
校验订单的升级
发布商品
使商品过期
退还商品
会议
权限申请
钉工牌
钉工牌简介
如何调用钉工牌API
使用AccessToken调用
使用SuiteAccessToken调用
创建钉工牌电子码
更新钉工牌电子码
解析钉工牌电子码