钉钉 API
  1. 开发前必读
钉钉 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
        • 获取定制应用的accessToken
        • 获取企业内部应用的accessToken
        • 获取微应用后台免登的accessToken
    • 通讯录管理
      • 概述
      • 权限申请
      • 常见问题
      • 使用教程
        • 企业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
        • 获取花名册元数据
        • 获取花名册字段组详情
        • 获取员工花名册字段信息
        • 更新员工花名册信息
        • 新增或删除花名册选项类型字段的选项
      • 员工管理
        • 获取待入职员工列表
        • 添加待入职员工
        • 获取在职员工列表
        • 获取离职员工列表
        • 修改已离职员工信息
        • 批量获取员工离职信息
      • 员工关系
        • 智能人事员工调岗
        • 添加企业待入职员工
        • 智能人事员工转正
    • OA 审批
      • 概述
      • 权限申请
      • 使用教程
        • 发起及撤销审批流
        • 评论及撤销审批流
        • 同意或拒绝审批流程
        • 审批附件的操作流程
        • 审批实现及发送通知
        • 创建及删除自有审批模版
        • OA审批流程中心操作流程
        • 用户表单及审批单查询操作
        • 发起审批待办的自有OA审批
        • 服务端API发起带有附件的审批流并下载附件
      • 官方OA审批
        • 审批表单
          • 创建或更新审批表单模板
          • 获取表单 schema
          • 获取审批单流程中的节点信息
          • 获取指定用户可见的审批表单列表
          • 获取当前企业所有可管理的表单
        • 审批实例
          • 发起审批实例
          • 获取单个审批实例详情
          • 撤销审批实例
          • 添加审批评论
          • 获取审批实例ID列表
        • 审批钉盘空间&附件
          • 获取审批钉盘空间信息
          • 授权预览审批附件
          • 授权下载审批钉盘文
          • 下载审批附件
        • 审批任务
          • 同意或拒绝审批任务
          • 转交OA审批任务
          • 获取用户待审批数量
      • 自有OA审批
        • 概述
        • 审批表单
          • 创建或更新审批模板
          • 获取模板code
          • 删除模板
        • 审批实例
          • 创建实例
          • 更新实例状态
          • 批量更新实例状态
        • 流程中心任务
          • 创建流程中心待处理任务
          • 查询通过流程中心集成的OA审批任务
          • 更新流程中心任务状态
          • 批量取消流程中心待处理任务
        • 常见问题
          • 官方OA审批
          • 自有OA审批
    • 智能填表
      • 概述
      • 使用教程
      • 权限申请
      • 获取用户创建的填表模板列表
      • 获取填表实例列表
      • 获取单条填表实例详情
    • 日程
      • 概述
      • 权限申请
      • 常见问题
      • 使用教程
        • 创建及删除日程
        • 日程参与者操作流程
      • 用户访问控制
        • 创建访问控制
        • 删除访问控制
        • 获取访问控制列表
      • 日程
        • 创建日程
        • 删除日程
        • 修改日程
        • 查询单个日程详情
        • 查询日程列表
        • 查询日程视图
      • 日程参与者
        • 添加日程参与者
        • 删除日程参与者
        • 设置日程响应邀请状态
        • 获取日程参与者
      • 忙闲
        • 获取用户忙闲信息
      • 日历
        • 查询日历
        • 订阅公共日历
        • 取消订阅公共日历
        • 创建订阅日历
        • 查询单个订阅日历详情
        • 更新订阅日历
        • 删除订阅日历
      • 签到
        • 查看单个日程的签到详情
        • 针对单个日程进行签到
        • 查看单个日程的签退详情
        • 针对单个日程进行签退
      • 会议室
        • 获取会议室忙闲信息
        • 预定会议室
        • 取消预定会议室
    • 待办任务
      • 概述
      • 权限申请
      • 常见问题
      • 使用教程
        • 新增待办及删除待办
        • 多人新增待办及删除待办
        • 待办通知场景
        • 创建钉钉个人待办任务
      • 创建钉钉待办任务
      • 删除钉钉待办任务
      • 更新钉钉待办任务
      • 更新钉钉待办执行者状态
      • 查询企业下用户待办列表
    • Teambition 项目管理
      • 概述
      • 权限申请
      • 任务筛选TQL说明
      • 常见问题
      • 使用教程
        • 获取项目管理日志操作信息
        • Teambition自由任务操作流程
        • Teambition企业项目任务操作流程
      • 项目
        • 创建项目
        • 查询项目
        • 归档项目
        • 恢复项目归档
        • 获取项目成员
        • 查询项目状态
        • 添加项目成员
        • 删除项目成员
        • 项目放入回收站
        • 获取用户加入的项目
        • 搜索企业项目模板
        • 根据项目模板创建项目
        • 查询员工可见的项目分组
        • 更新项目所在的分组
        • 查询项目中文件操作日志
        • 创建或更新项目概览中自定义字段值
      • 任务
        • 项目任务
          • 创建项目任务
          • 删除任务
          • 获取任务详情
          • 查询任务分组
          • 获取任务列表
          • 查询任务工作流
          • 查询用户任务信息列表
          • 查询项目中的任务
          • 添加任务的关联内容
          • 任务迁移至回收站
          • 搜索任务工作流状态
          • 更新任务工作流状态
          • 更新任务备注
          • 更新任务标题
          • 更新任务执行者
          • 更新任务优先级
          • 更新任务参与者
          • 更新任务截止时间
          • 更新任务开始时间
          • 更新项目任务的自定义字段值
        • 自由任务
          • 创建自由任务
          • 获取自由任务详情
          • 查询优先级列表
          • 批量获取自由任务详情
          • 更新自由任务标题
          • 更新自由任务状态
          • 更新自由任务备注
          • 更新自由任务执行者
          • 更新自由任务的优先级
          • 更新自由任务截止时间
          • 增加或删除自由任务的参与者
      • 工时
        • 创建计划工时
        • 创建实际工时
      • 企业和用户
        • 获取Teambition项目企业ID
        • 根据userId获取Teambition项目用户ID
    • 日志
      • 概述
      • 使用教程
      • 权限申请
      • 创建日志
      • 保存日志内容
      • 获取模板详情
      • 获取用户发出的日志列表
      • 获取用户发送日志的概要信息
      • 获取日志相关人员列表
      • 获取日志接收人员列表
      • 获取日志评论详情
      • 获取用户日志未读数
      • 获取用户可见的日志模板
    • 签到
      • 概述
      • 使用教程:获取签到信息
      • 权限申请
      • 获取用户签到记录
      • 获取部门用户签到记录
    • 文档/文件
      • 知识库
        • 知识库概述
        • 权限申请
        • 常见问题
        • 知识库管理
          • 新建知识库
          • 获取知识库
          • 获取知识库列表
          • 批量获取知识库
          • 获取我的文档知识库信息
        • 知识库目录树管理
          • 创建知识库文档
          • 获取节点
          • 获取节点列表
          • 通过链接获取节点
          • 批量获取节点
        • 知识库通用数据结构说明
          • 通用数据结构
      • 钉盘
        • 概述
        • 权限申请
        • 空间管理
          • 新建空间
          • 删除空间
          • 获取空间列表
      • 群文件
        • 获取群存储空间信息
        • 以应用身份发送文件给指定用户
        • 发送文件到指定会话
        • 发送文件链接到指定会话
      • 媒体文件
        • 概述
        • 使用教程:媒体文件的使用流程
        • 权限申请
        • 上传媒体文件
      • 文档
        • 概述
        • 权限申请
        • 表格
          • 工作表
            • 获取所有工作表
            • 获取工作表
            • 创建工作表
            • 删除工作表
          • 行列
            • 指定行上方插入若干行
            • 指定列左侧插入若干列
            • 删除行
            • 删除列
            • 设置行隐藏或显示
            • 设置列隐藏或显示
          • 单元格区域
            • 获取单元格区域
            • 更新单元格区域
            • 清除单元格区域内数据
            • 清除单元格区域内所有内容
      • 搜索
        • 搜索文件
        • 搜索知识库
      • 储存管理
        • 概述
        • 权限申请
        • 企业管理
          • 获取企业信息
        • 应用管理
          • 获取应用信息
        • 空间管理
          • 添加空间
          • 获取空间信息
        • 文件管理
          • 添加文件夹
          • 复制文件或文件夹
          • 批量复制文件或文件夹
          • 移动文件或文件夹
          • 批量移动文件或文件夹
          • 重命名文件或文件夹
          • 删除文件或文件夹
          • 批量删除文件或文件夹
          • 恢复文件历史版本
          • 获取文件版本列表
          • 获取文件或文件夹信息
          • 批量获取文件或文件夹信息
          • 获取文件或文件夹列表
          • 获取空间下所有文件或文件夹列表
          • 删除文件或文件夹的应用属性
          • 获取文件预览或编辑信息
          • 批量获取文件缩略图
        • 文件传输
          • 通过指定Range下载部分内容
          • 文件上传问题自查手册
          • 分片上传
            • 初始化文件分片上传
            • 获取文件分片上传信息
          • 获取文件上传信息
          • 提交文件
          • 获取文件下载信息
        • 权限管理
          • 添加权限
          • 删除权限
          • 修改权限
          • 获取权限列表
          • 设置权限继承模式
          • 获取权限继承模式
        • 回收站管理
          • 获取回收站信息
          • 获取回收项列表
          • 获取回收项信息
          • 还原回收项
          • 批量还原回收项
          • 删除回收项
          • 批量删除回收项
          • 清空回收站
        • 任务管理
          • 获取存储中异步任务信息
        • 事件订阅
          • 订阅文件变更事件
          • 取消订阅文件变更事件
    • 公告
      • 概述
      • 使用教程:创建及删除公告
      • 权限申请
      • 创建公告
      • 删除公告
      • 更新公告
      • 获取公告详情
      • 获取公告ID列表
      • 获取公告分类列表
      • 获取用户可查看的公告
      • 获取公告钉盘空间信息
    • 钉工牌
      • 概述
      • 权限申请
      • 使用教程
        • 场景化方案
        • 钉工牌实现用户访客码创建
      • 创建钉工牌电子码
      • 配置企业钉工牌
      • 更新钉工牌电子码
      • 解码钉工牌电子码
      • 通知支付结果
      • 通知退款结果
      • 钉工牌通知消息
      • 同步钉工牌码验证结果
    • 音视频
      • 会议
        • 概述
        • 使用教程:创建及关闭视频会议
        • 权限申请
        • 创建视频会议
        • 关闭视频会议
        • 批量查询视频会议信息
        • 查询视频会议成员
        • 批量查询视频会议信息
        • 查询用户进行中会议列表
        • 邀请用户入会
        • 踢出会议成员
        • 设置全员看他
        • 设置联席主持人
        • 开启视频会议直播推流
        • 停止视频会议直播推流
        • 指定人员静音或取消静音
        • 全员静音或全员取消静音
        • 创建预约会议
        • 更新预约会议
        • 取消预约会议
        • 查询预约会议
        • 查询预约会议历史会议信息
        • 开启视频会议云录制
        • 停止视频会议云录制
        • 查询会议录制的详情信息
        • 查询会议录制中的视频信息
        • 查询会议录制中的文本信息
      • 直播
        • 概述
        • 使用教程:发起及删除直播
        • 权限申请
        • 创建直播
        • 删除直播
        • 查询直播信息
        • 修改直播属性信息
        • 查询直播观看人员信息
      • 智能会议室
        • 概述
        • 权限申请
        • 使用教程
          • 会议室操作流程
          • 会议室分组操作流程
        • 会议室
          • 创建会议室
          • 删除会议室
          • 更新会议室信息
          • 查询会议室列表
          • 查询会议室详情
          • 查询视频会议设备信息
          • 查询视频会议设备属性信息
        • 会议室分组
          • 创建会议室分组
          • 删除会议室分组
          • 更新会议室分组信息
          • 查询会议室分组列表
          • 查询会议室分组信息
        • 自定义屏幕模板
          • 创建自定义屏幕模板
          • 删除自定义屏幕模板
          • 更新自定义屏幕模板
          • 查询自定义屏幕信息
          • 查询自定义屏幕模板列表
    • 工作台
      • 批量添加最近使用应用
    • 互动卡片
      • 概述
      • 快速入门
      • 使用教程:消息卡片发送及更新
      • 权限申请
      • 操作流程
        • 卡片模板搭建
          • 普通卡片模板
          • AI 卡片模板
        • 卡片创建
          • 卡片平台创建卡片实例
          • 开放接口创建卡片实例
        • 卡片投放
          • 卡片平台投放卡片实例
          • 开放接口投放卡片实例
        • 卡片互动
          • 事件回调
          • 动态数据源
          • 卡片更新
      • 卡片模板搭建器
        • 概述
        • 面板介绍
          • 大纲树面板
          • 组件库面板
          • 区块组件库面板
          • 预设模板面板
          • 数据源面板
          • 版本更新日志面板
          • 模拟器
          • 组件属性设置面板
          • 顶部操作栏
        • 绑定卡片变量
          • 变量与卡片的关系
          • 绑定变量
          • 变量类型
          • 公有数据、私有数据和本地数据
          • 条件渲染
          • 循环渲染
        • 添加卡片交互
          • 交互方式
          • 交互组件
      • 附录
        • 钉钉表情列表
        • API 卡片数据的填写说明
        • 常见问题
        • 卡片规范
          • 设计规范
          • 链接跳转规范
          • 变量规范
            • Markdown 变量
            • 图表变量
            • 用户信息变量
            • 表格变量
      • 创建卡片
      • 投放卡片
      • 更新卡片
      • 创建并投放卡片
      • 注册卡片回调地址
      • 新增或者更新卡片的场域信息
    • 企业文化
      • 荣誉
        • 概述
        • 权限申请
        • 给员工颁发荣誉
        • 查询员工已获得的组织荣誉
        • 查询当前企业下可颁发的荣誉列表
        • 创建荣誉勋章模板
        • 撤销员工获得的荣誉勋章
      • 钉钉运动
        • 概述
        • 使用教程:获取部门下员工运动步数记录
        • 权限申请
        • 查询用户是否参与企业步数排行榜
      • 企业百科
        • 概述
        • 权限申请
        • 新增词条
        • 审核词条
        • 查询词条详情
        • 根据词条ID查询详情
        • 更新词条
        • 删除词条
        • 分页获取企业词条信息
        • 匹配文本中的词条
    • 宜搭应用开发
      • 概述
      • 权限申请
      • 创建或更新表单数据格式说明
      • 宜搭表单筛选的组件格式说明
      • 宜搭表单实例FormData结构说明
      • 根据表单组件ID和宜搭内置字段对搜索结果排序
      • 常见问题
      • 使用教程
        • 场景化方案
        • 宜搭流程审批单操作流程
      • 流程
        • 发起宜搭审批流程
        • 删除流程实例
        • 终止流程实例
        • 获取实例ID列表
        • 批量获取流程实例列表
        • 获取流程实例
        • 根据流程实例ID获取流程实例
      • 表单
        • 获取指定应用下的表单列表
        • 获取表单内的组件信息
        • 查询表单实例数据
        • 保存表单数据
        • 更新表单数据
        • 查询表单数据
        • 获取员工组件的值
        • 获取表单组件定义列表
        • 获取子表组件数据
        • 删除表单数据
        • 获取多个表单实例ID
        • 批量获取表单实例数据
        • 批量删除表单实例
        • 批量创建表单实例
        • 批量更新表单实例内的组件值
        • 新增或更新表单实例
        • 通过高级查询条件获取表单实例数据(包括子表单组件数据)新版SDK
        • 通过高级查询条件获取表单实例数据(不包括子表单组件数据)
        • 通过表单实例数据批量更新表单实例
        • 查询表单的变更记录
      • 任务
        • 获取审批记录
        • 同意或拒绝宜搭审批任务
        • 获取组织内某人提交的任务
        • 获取组织内已完成的审批任务
        • 转交任务
        • 查询流程运行任务(VPC)
        • 获取任务列表(组织维度)
        • 获取发送给用户的通知
        • 查询抄送我的任务列表(应用维度)
        • 批量执行宜搭审批任务
        • 提交评论
        • 批量查询宜搭表单实例的评论
      • 附件
        • 获取宜搭附件临时免登地址
      • 应用
        • 查询宜搭应用列表
      • 服务调用
        • 查询宜搭表单服务调用执行记录
    • 专属开放
      • 专属钉钉
        • 概述
        • 使用教程:互动服务窗群发文章
        • 权限申请
        • 审计
          • 获取审计协议签署人员信息
        • 可信设备
          • 批量新增可信设备
          • 查询公共设备
          • 新增可信设备信息
          • 查询可信设备详细信息
        • 互动服务窗
          • 服务号管理
            • 新增服务号
            • 更新服务号
            • 查询服务号列表
            • 查询服务号详情
          • 文章管理
            • 新增文章
            • 删除文章
            • 更新文章
            • 查询文章列表
            • 获取文章详情
            • 发布文章
          • 图文卡片管理
            • 新增图文卡片
            • 删除图文卡片
            • 获取图文卡片详情
            • 更新图文卡片
            • 查询图文卡片列表
          • 消息群发
            • 消息撤回
            • 消息群发
          • 菜单管理
            • 服务号菜单更新
            • 查询服务号菜单
        • 产业互联
          • 概述
          • 获取可打标部门列表
          • 获取子标签列表
          • 设置部门伙伴类型和伙伴编码
          • 修改伙伴类型可见性
          • 查询伙伴角色列表
          • 修改角色可见性
          • 发送邀请函
          • 根据userId查询人员的标签信息
        • DING服务
        • 发送电话DING
        • 获取文件操作记录
        • 发送文件更改的评论
        • 获取群活跃明细列表
        • 查询企业内部群信息
        • 企业内部群禁言或解除禁言
        • 根据会议逻辑ID查询会议基本信息
        • 获取防截屏操作记录
        • 查询实人认证状态
        • 查询人脸录入状态
        • 获取实人认证接口调用记录
        • 获取人脸对比接口调用记录
    • 客户管理(官方CRM)
      • 概述
      • 权限申请
      • 使用教程
        • CRM客户数据操作流程
        • CRM联系人数据操作流程
        • CRM跟进记录数据操作流程
        • CRM自定义对象数据操作流程
        • CRM客户群操作流程
        • 根据unionId获取客户信息流程
      • 客户
        • 获取个人或企业客户的元数据
        • 创建个人或企业客户数据
        • 更新个人或企业客户数据
        • 删除个人或企业客户数据
        • 批量新增个人或企业客户数据
        • 批量更新个人或企业客户数据
        • 批量获取个人或企业客户数据
        • 获取全量个人或企业客户数据
        • 根据指定条件查询个人或企业客户数据
        • 获取个人或企业客户查重字段
        • 获取客户管理全局信息
        • 查询客户数据
      • 联系人
        • 删除联系人数据
        • 批量新增联系人数据
        • 批量修改联系人数据
        • 获取联系人对象的元数据
        • 根据指定条件查询联系人数据
        • 按照ID列表批量获取联系人数据
      • 跟进记录
        • 获取跟进记录对象的元数据
        • 批量新增跟进记录数据
        • 批量更新跟进记录数据
        • 批量删除跟进记录数据
        • 根据指定条件查询跟进记录数据
        • 根据ID列表批量获取跟进记录数据
      • 自定义对象
        • 创建CRM自定义对象数据
        • 删除CRM自定义对象数据
        • 更新自定义对象数据
        • 获取自定义对象的元数据
        • 根据指定条件查询自定义对象数据
        • 按照ID列表批量获取CRM自定义表单数据
      • 客户群
        • 创建客户群
        • 查询客户群列表
        • 获取单个客户群详情
        • 批量查询客户群
        • 创建客户群组
        • 获取单个客户群组详情
        • 更新客户群组
        • 查询客户群组列表
      • 控件格式
        • 自定义控件字段格式说明V1
        • 自定义控件字段格式说明V2
        • 新增和更新客户字段格式说明V1
        • 新增和更新客户字段格式说明V2
        • 新增和更新联系人字段格式说明V1
        • 新增和更新联系人字段格式说明V2
        • 查询DSL说明
        • 客户群查询DSL语法说明
    • 行业开放
      • 数字乡村
        • 概述
        • 权限申请
        • 居民积分
          • 增加或减少居民积分
          • 查询组织维度配置的所有积分规则
          • 分页查询居民积分流水
        • 地产行业
          • 概述
          • 权限申请
          • 创建项目组
          • 删除项目组
          • 创建园区项目
          • 查询项目组信息
          • 查询园区项目信息
        • 医疗
          • 概述
          • 权限申请
          • 保存人员扩展属性
        • 制造业
          • 概述
          • 使用教程:计件报工基本使用流程
          • 权限申请
          • 生产管理
            • 计件报工
            • 查询计件报工数据
        • 设备上钉
          • 概述
          • 权限申请
          • 注册设备到钉钉
          • 批量注册与激活设备
          • 查询已经注册的设备信息
          • 获取报修记录
          • 获取巡检或保养记录
        • 服务群
          • 概述
          • 使用教程:实现服务群发送消息
          • 权限申请
          • 群发任务
          • 发送服务群消息
          • 创建场景服务群
          • 添加服务群成员
          • 查询服务群活跃用户
          • 更换服务群所在的群分组
          • 升级普通群为服务群
          • 升级云客服服务群为钉钉智能服务群
        • 新教育
          • 概述
          • 权限申请
          • 操作流程:钉钉教育组织内部应用SI接入解决方案
          • 局校关联
          • 家校通讯录2.0
            • feature字段
            • 初始化家校架构
            • 创建自定义校区或部门
            • 创建学段
            • 删除家校部门
            • 创建年级
            • 创建班级
            • 创建自定义部门下的班级
            • 添加学生
            • 删除学生
            • 添加家长
            • 删除家长关系
            • 添加老师
            • 删除老师
            • 学生调班
            • 获取部门详情
            • 获取部门列表
            • 获取人员列表
            • 获取人员详情
            • 获取班级内学生的关系列表
            • 获取学生监护人详情
          • 班级圈
            • 获取班级圈话题列表
            • 获取班级圈动态列表
          • 数字化证书
            • 获取数字化证书
          • 行业角色管理
            • 获取用户所在的行业角色信息
            • 获取行业角色下的用户列表
    • 生态开放
      • 智能客服
        • 概述
        • 权限申请
        • 创建自助单
        • 执行工单活动
        • 查询动作记录
        • 分页查询工单
      • 小蜜客服
        • 使用教程:小蜜客服推送单聊信息
        • 概述
        • 权限申请
        • 消息类型说明
        • 智能问答
        • 获取用户登录凭证
        • 推送小蜜机器人单聊O2O消息
        • 小蜜客服机器人消息回复
        • 查询机器人基础指标数据
      • AI
        • 概述
        • 使用教程:实现文本内容翻译
        • 权限申请
        • 钉钉文本翻译
        • OCR文字识别
        • ASR 一句话语音识别
      • 员工服务台
        • 概述
        • 使用教程:使用员工服务台机器人推送信息
        • 消息类型与数据格式
        • 消息链接说明
        • 使用服务助手推送消息
      • 阿里商旅
        • 概述
        • 操作流程
        • 权限申请
        • 城市基本数据
          • 机票城市搜索
          • 火车票城市搜索
        • 维护成本中心和发票抬头
          • 新建成本中心
          • 修改成本中心
          • 删除成本中心
          • 查询成本中心
          • 设置成本中心人员信息
          • 删除成本中心人员信息
          • 商旅成本中心转换为外部成本中心
        • 项目管理
          • 添加项目
          • 修改项目
          • 删除项目
        • 出差申请
          • 新建审批单
          • 获取申请单列表
          • 获取申请单详情
          • 修改申请单
          • 更新申请单状态
          • 搜索第三方酒店超标审批单
          • 搜索第三方火车票超标审批单
          • 回传第三方超标审批结果
          • 搜索第三方机票超标审批单
        • 订单管理
          • 获取企业机票订单数据
          • 获取企业商旅酒店订单数据
          • 获取企业火车票订单数据
          • 获取用车订单数据
          • 关联单号查询相关订单信息列表
        • 阿里商旅跳转链接
          • 获取商旅访问地址
        • 发票管理
          • 新增发票配置
          • 配置发票适用人群
          • 查询可用发票列表
          • 修改发票配置
          • 删除发票信息
        • 市内用车申请
          • 同步市内用车申请单
          • 审批市内用车申请单
          • 查询市内用车申请单
        • 账单管理
          • 查询用车结算记账记录
          • 查询商旅火车票结算记账数据
          • 查询酒店结算记账数据
          • 查询机票结算记账数据
          • 获取月对账结算数据
        • 查询预估价
      • 金智CRM
        • 使用教程:制造业订单交付全过程管理
        • 权限申请
        • 概述
        • 客户
          • 客户资料
          • 客户公共池
        • 联系人
          • 联系人
        • 合同
          • 合同订单
          • 发货单
          • 销售换货单
        • 销售
          • 销售机会
          • 报价记录
        • 采购
          • 采购单
        • 生产
          • 生产单
        • 产品
          • 产品信息
        • 库存
          • 入库单
          • 出库单
        • 数据
          • 获取数据详情
        • 获取数据列表
      • 氚云
        • 概述
        • 权限申请
        • 应用
          • 获取应用列表
          • 获取应用功能节点
        • 组织和用户
          • 获取组织数据
          • 获取用户数据
          • 获取角色数据
          • 获取角色用户数据
        • 表单
          • 获取表单对象结构
          • 创建表单业务数据
          • 查询表单业务数据列表
          • 修改表单业务对象数据
          • 批量新增表单业务数据
          • 删除业务对象
          • 获取业务实例信息
        • 流程
          • 创建流程实例
          • 删除流程实例数据
          • 取消流程实例
          • 查询流程实例
          • 查询流程实例节点工作项
        • 文件管理
          • 获取附件临时免登地址
          • 获取文件上传地址
      • e 签宝
        • 概述
        • 权限申请
        • 鉴权
          • e签宝数据初始化
          • 获取授权的页面地址
          • 取消企业授权
        • 套餐
          • 套餐转售—分润模式
          • 套餐转售—底价结算模式
          • 查询套餐余量
        • 用户
          • 获取企业的e签宝微应用状态
          • 查询企业信息
          • 获取企业控制台地址
          • 查询个人信息
          • 获取个人实名的地址
          • 获取跳转到企业实名的地址
        • 文件
          • 上传文件
          • 获取文件上传地址
          • 获取文件详情
        • 签署流程
          • 获取发起签署任务的地址
          • 创建签署流程
          • 获取签署人签署地址
          • 获取流程的签署详情
          • 获取流程任务用印审批列表
          • 获取流程详细信息及操作记录
          • 获取流程任务的所有合同列表
    • 应用管理
      • 概述
      • 使用教程:应用管理操作流程
      • 权限申请
      • 创建企业内部应用
      • 更新企业内部应用
      • 删除企业内部应用
      • 获取企业所有应用列表
      • 发布企业内部小程序版本
      • 回滚企业内部小程序版本
      • 获取企业内部所有应用列表
      • 获取用户可见的企业应用列表
      • 获取企业内部小程序的版本列表
      • 获取企业内部小程序历史版本列表
      • 更新企业内部应用微应用的可使用范围
      • 获取企业内部应用微应用的可使用范围
    • 智能硬件
      • 智能硬件概述
      • 权限申请
      • 设备管理
      • 设备管理
        • 绑定设备
        • 解绑设备
        • 修改设备昵称
        • 查询设备列表
        • 查询设备详情
        • 根据设备ID查询设备
    • 附录
      • 签名计算方法
        • RSA私钥对参数进行签名
  • 事件订阅
    • 概述
    • 操作指南
      • 配置 Stream 推送(推荐)
      • 配置 HTTP 推送
    • 开发指南
      • 开发 Stream 模式推送服务端(推荐)
      • 开发 HTTP 推送服务端
    • 开发参考
      • 获取推送失败的事件列表
    • 协同
      • 文档
        • 文档知识库中创建小组
        • 文档知识库中小组变更
        • 文档知识库中小组成员变更
      • 签到
        • 用户签到
      • 项目管理
        • Teambiton工时变更事件
        • Teambiton项目变更事件
        • Teambition成员变更事件
        • Teambition应用变更事件
        • Teambition项目任务变更事件
        • Teambition任务更新事件
        • Teambition项目更新事件
      • 储存
        • 文件更新
        • 文件或文件夹删除
        • 文件或文件夹添加
      • 日程
        • 日程变更
    • 办公
      • OA审批
        • 审批实例开始、结束、终止
        • 审批任务开始、结束、取消
      • 待办
        • 待办任务新增
        • 待办任务更新
        • 待办任务删除
    • 音视频
      • 直播
        • 直播状态变更
        • 直播信息修改
        • 直播回放观看数据推送
        • 直播结束数据处理完成事件
      • 视频/音频会议
        • 设备属性变更
        • 设备告警事件
        • 钉钉投屏事件
        • 视频会议状态变更
        • 设备绑定会议室变更
        • 视频会议成员状态变更
        • 视频会议状态变更App定向推送
        • 视频会议成员状态变更App定向推送
      • 智能会议室
        • 会议室事件
    • 服务群
      • 服务群群信息变更
      • 服务群联系人关联客户
      • 服务群入群表单保存
      • 服务群自定义表单删除实例
      • 服务群自定义表单更新实例
      • 服务群自定义表单创建实例
      • 服务群工单处理反馈
      • 服务群工单添加备注
      • 弹内服务群话题变更事件
      • 服务群工单已读
      • 服务群工单创建
      • 服务群工单申领
      • 服务群工单催办
    • 组织关系
      • 通讯录
        • 企业增加员工事件
        • 通讯录用户更改
        • 通讯录用户离职
        • 加入企业后用户激活
        • 通讯录用户被设为管理员
        • 通讯录用户被取消设置管理员
        • 通讯录企业部门创建
        • 通讯录企业部门修改
        • 通讯录企业部门删除
        • 员工角色信息发生变更
        • 增加角色或者角色组
        • 修改角色或者角色组
        • 删除角色或者角色组
        • 企业信息发生变更
        • 企业删除
      • 服务窗
        • 服务窗关注事件
        • 服务窗取关事件
        • 用户信息授权结果
        • 服务号接收用户交互
    • 即时通讯IM
      • 会话管理
        • 群会话解散群
        • 群会话添加人员
        • 群会话删除人员
        • 群会话更换群主
        • 群会话更换群名称
        • 群会话用户主动退群
        • 群模板被启用或停用
        • 单聊安装酷应用
        • 单聊卸载酷应用
        • 群内安装酷应用事件
        • 群内卸载酷应用事件
      • 机器人
        • 机器人消息撤回事件
        • 机器人消息已读事件
    • 智能人事
      • 考勤
        • 班次变更
        • 考勤组变更
        • 员工打卡事件
        • 员工加班事件
        • 水印打卡签到
        • 考勤结果变更
        • 假期规则变更事件
        • 手动修改假期余额
        • 考勤日统计变更事件
        • 考勤报表字段变更事件
        • 请假、加班、出差、外出状态变更事件
      • 智能招聘
        • 招聘平台职位投递变更事件
      • 智能人事
        • 人事档案变动
        • 人事解决方案变更事件
        • 人事平台员工异动事件v2
    • 客户管理
      • 主数据实例新增事件
      • 主数据实例删除事件
      • 主数据实例更新事件
      • CRM元数据
    • 企业文化
      • 荣誉勋章
        • 荣誉授予
        • 荣誉审核结果
    • 应用管理
      • 小程序版本发布事件
      • 小程序版本回滚事件
    • 专属开放
      • 服务号接收单聊消息
      • 企业员工发送文件的检测事件
      • 专属群扩容审批
      • 专属钉钉数据迁移
    • 行业开放
      • 医疗
        • 医疗行业用户属性变动
        • 医疗行业用户所在科室医疗组变动
        • 医疗行业科室医疗组变动
        • 医疗行业科室医疗组属性变动
        • 医疗通讯录全量同步
      • 教育
        • 教育部门新增
        • 教育部门更新
        • 教育部门删除
        • 新教育人员新增
        • 新教育人员更新
        • 新教育人员删除
        • 新教育人员关系新增
        • 新教育人员关系更新
        • 新教育人员关系删除
        • 支付状态同步
      • 行业通用
        • 门店通用户权益变更事件
  • 参考
    • AppLink协议
      • 沉浸式容器
      • AppLink介绍
        • AppLink的结构
      • 已支持的协议
        • 打开小程序
        • 打开H5微应用
        • 打开普通页面
        • 打开个人详情页
        • 发送邮件
        • 打开扫一扫
        • 客户端Tab切换
        • 打开云盘首页
        • 打开文件动态
        • 打开外链管理
        • 发DING消息
        • 打开服务窗助手
        • 打开我的信息页面
        • 打开帐号与安全
        • 打开特别关注
        • 创建钉钉组织
        • 打开成员申请
        • 打开搜索企业主页
        • 打开团队邀请二维码
        • 打开加入团队
        • 打开设置钉钉号
        • 打开选择联系人发起电话
        • 打开钉钉投屏
        • 打开添加好友
        • 打开看看
        • 会话相关
          • 进入群聊会话
          • 选择员工发送消息
          • 创建群
          • 打开我的群组
    • 专属版客户端插件
      • 概述
      • 操作指南
        • 创建客户端插件
        • 上传并发布插件
        • 构建集成插件
      • 开发指南
        • 开发 Android 插件
          • 流程概览
          • 使用 Dingtalk DevKit 工具
          • 创建插件工程
          • 编写插件功能
          • 编译生成产物(*.deb)
          • 调试插件
          • 开发参考
            • 初始化插件(MainBundle)
            • 配置插件依赖项
            • 开发自定义JSAPI
            • 监听事件
            • 配置混淆规则
            • 权限(Permission)
          • 常见问题
            • 自定义的JsApi不生效
        • 开发 iOS 插件
          • 流程概览
          • 准备开发环境
          • 创建插件工程
          • 编写插件功能
          • 编译生成产物
          • 其他说明
          • 常见问题
          • 开发参考
            • 开发自定义JSAPI
            • 监听事件
            • App Extension接入
            • RepalyKit扩展
            • 常用服务(Service)
              • 打印日志
              • UI服务
              • APP基础信息
      • 使用扩展点
        • 登录流程扩展:登录流程扩展(Android)
        • 首页生命周期扩展:首页生命周期扩展(Android)
        • 网络异常提醒扩展:网络异常提醒扩展(Android)
        • 设置项扩展点
          • 设置项扩展点(iOS)
          • 设置项扩展点(Android)
        • 登录认证扩展(认证多因子)
          • 登录认证扩展(Android)
      • 使用开放 API
        • 获取设备唯一ID
        • 获取账号登录状态
        • 获取员工信息
        • 获取专属配置
        • 获取专属安全配置
        • 获取钉钉屏幕分享状态
      • 解决方案
        • VPN网络连接
          • VPN网络连接(Android)
  • 常见问题
    • 开发流程和权限相关
    • 事件订阅与数据推送
    • 服务端常见问题
      • 服务端接口
      • 酷应用
      • 互动卡片
    • 客户端常见问题
      • 小程序
      • h5微应用
      • 统一跳转协议
      • 分享与登录
      • 链接转卡片
  • 历史文档(不推荐)
    • 钉钉云
      • 接入必读
      • 钉钉云介绍
        • 钉钉云介绍
        • 钉钉云的安全限制
      • 申请钉钉云账号
        • 申请钉钉云账号
        • 阿里云账号托管为钉钉云账号
      • 开通/购买云产品
        • 钉钉云解决方案
        • 开通云产品
      • 应用部署
        • 申请钉钉云安全组白名单
        • 钉钉云数据推送
          • 钉钉云推送概述
          • 设置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调用
          • 创建钉工牌电子码
          • 更新钉工牌电子码
          • 解析钉工牌电子码
          • 通知支付结果
          • 通知退款结果
          • 同步钉工牌码验证结果
          • 配置企业钉工牌
      • 公告
        • 权限申请
      • 签到
      • 空间管理
        • 获取空间信息
      • 日志
        • 使用案例
        • 权限申请
        • AI
          • 权限申请
          • 文本翻译
          • OCR文字识别
          • ASR 一句话语音识别
        • 获取日志统计数据
      • 智能工作流
        • 工作流概述
        • 权限申请
        • 使用案例
          • 发起及撤销审批流
          • 审批附件的操作流程
          • 同意或拒绝审批流
          • 审批事件订阅
        • 官方工作流
          • 官方工作流接入示例
          • 常见错误(官方工作流)
          • 创建或更新审批模板
          • 获取用户待审批数量
          • 查询已设置为条件的表单组件
          • 获取当前企业所有可管理的模版
          • 获取审批钉盘空间信息
          • 授权下载审批钉盘文件
          • 下载审批附件
          • 同意或拒绝审批任务
          • 发起审批实例
          • 获取审批实例详情
          • 撤销审批实例
          • 添加审批评论
          • 获取审批实例ID列表
          • 授权预览审批附件
        • 自有工作流
          • 接入流程
          • 常见错误(自有工作流)
          • 创建或更新审批模板
          • 获取模板code
          • 删除模板
          • 清理工作流数据
          • 创建实例
          • 更新实例状态
          • 批量更新实例状态
          • 创建待办事项
          • 查询待办列表
          • 更新待办状态
          • 批量取消待办
      • 待办任务
        • 概述
        • 权限申请
        • 常见问题
        • 使用案例
          • 新增待办及删除待办
        • 新增钉钉待办任务
        • 获取钉钉待办任务详情
        • 根据sourceId获取钉钉待办任务详情
      • 日程
        • 概述
        • 权限申请
        • 日程资源
      • 考勤
        • 使用案例
        • 权限申请
        • 考勤事件
        • 查询假期消费记录
      • 用户管理
        • 创建用户
        • 获取管理员的应用管理权限
        • 根据userid获取用户详情
      • 员工管理
      • 合作空间
        • 概述
        • 获取加入或申请加入合作空间的组织和个人信息
        • 获取企业已经加入或申请加入的合作空间的信息
        • 创建合作空间
        • 获取合作空间的邀请信息
      • 关联组织
        • 概述
        • 申请权限
        • 获取主干组织列表
        • 获取关联组织分支授权的数据
      • 服务窗
        • 概述
        • 自建服务窗应用
        • 服务窗联系人管理
        • 服务窗关注与取消回调
      • 组织
        • 权限申请
        • 获取部门的扩展字段定义
        • 获取部门扩展信息
        • 更新部门扩展信息
      • 权限管理
        • 获取权限列表
        • 添加权限
        • 删除权限
        • 修改权限
        • 添加自定义空间权限
      • 回收站
        • 查询回收站文件(夹)列表
        • 还原回收站文件(夹)
        • 删除回收站文件(夹)
        • 清空回收站
      • 跟进记录
        • 根据ID列表批量获取跟进记录数据
        • 批量获取跟进记录数据
      • 生产管理
      • 服务群
        • 服务群概述
      • 家校通讯录2.0
        • 调用说明(家校通讯录2.0)
        • feature字段
        • 通讯录信息读取
        • 通讯录信息写入
          • 学生调班
        • 获取学生信息
          • 获取学生信息
          • 获取学生ID列表
      • 智能客服
        • 智能客服简介
      • 删除假期类型
      • 更新假期类型
      • 添加假期类型
      • 添加企业待入职员工
      • 获取离职员工列表
      • 获取员工离职信息
      • 获取企业发布智能填表数(部门维度)
      • 获取企业发布智能填表数(组织维度)
  1. 开发前必读

事件订阅

本文以应用的角度分别介绍HTTP推送、SyncHTTP推送和RDS推送三者的区别。
钉钉可以向你的应用推送订阅的回调事件,例如应用开通、应用授权变更、企业通讯录变更等。通过订阅这些回调事件,开发者可以更好地与钉钉集成。例如,通讯录发生变化时,不需要定时去拉取通讯录对比,而是实时地获取到变化的通讯录结点,进行同步。
第三方企业应用必须要注册事件回调,接收企业授权开通应用事件,用于通知应用哪个组织开通了本应用,第三方应用后台收到此事件后,需要初始化企业信息,完成应用的开通。
钉钉支持以下三种方式接收钉钉推送的回调事件:
RDS数据推送
SyncHTTP推送
HTTP数据推送(不推荐第三方企业应用使用)
三者的对比如下表所示:
SyncHTTP推送RDS推送HTTP推送
简介SyncHTTP推送方式适用于本地部署的情况。与HTTP推送方式比,SyncHTTP推送的是业务数据的最终状态,开发者可以直接使用推送的数据。RDS推送是替换HTTP协议推送的升级版本,是钉钉开放平台结合阿里云独创的一套推送方案。RDS推送在保障数据安全的前提下,极大地简化了推送协议,减少了数据传输次数,提高了数据传输速度,提升了推送的稳定性。RDS推送不但支持钉钉和ISV之间的数据传输,也能够支持钉钉和企业开发者之间的数据传输,并且支持开发者的本地开发调试和线上部署运维,极大地简化了ISV和企业接入钉钉的流程。HTTP推送事件是钉钉开放平台早期的事件推送方式。开发者可以使用HTTP的方式注册钉钉的回调事件,用于接收钉钉推送的消息。例如企业授权开通应用事件、通讯录变更事件等。
适用应用支持第三方企业应用强烈建议第三方企业应用使用RDS推送支持企业内部应用支持第三方企业应用(不推荐)
配置方式参考配置SyncHTTP推送。参考配置RDS数据推送。通过开发者后台订阅只支持企业内部应用,参考配置事件订阅。第三方企业应用,只能在开发者后台选择此种方式,不支持订阅事件。通过API订阅(不推荐)参考HTTP回调概述。
安全性数据通道是公网通道,需要流量花费,安全等级低,效率低。数据通道是内网通道,无流量花费,安全等级高,效率高。数据通道是公网通道,需要流量花费,效率低。
数据同步不支持同步协议。当网络异常或者开发者服务出现问题时候会出现数据丢失。支持同步协议。保证数据可靠写入开发者的RDS。若开发者的RDS出现故障,数据会永久存储在钉钉。不支持同步协议。当网络异常或者开发者服务出现问题时候会出现数据丢失。
数据结果推送的是业务数据的最终状态,开发者可以直接使用推送的数据。同时减少开发者调用钉钉开放平台次数,避免开发者被流控限制。推送的是业务数据的最终状态,开发者可以直接使用钉钉云推送的数据。同时减少开发者调用钉钉开放平台次数,避免开发者被流控限制。推送的数据是业务的ID,开发者收到推送之后,开发者还需要调用钉钉开放平台接口去查询数据的最终状态,容易受到流控限制。
推送报文推送的数据是密文数据,需要开发者自行验签、加解密,实现不同开发语言的验签、加解密逻辑。推送的数据格式请参考数据格式。推送的数据为明文数据。不需要验签、加解密逻辑。推送的数据格式请参考数据格式。推送的数据是密文数据,需要开发者自行验签、加解密,实现不同开发语言的验签、加解密逻辑。推送的数据格式请参考事件列表下事件的数据格式。
限流推送会有瞬间的HTTP请求峰值,可能导致开发者的服务器压力增大宕机。根据开发者接收推送RDS规格能力的不同,按照不同的速率推送数据。推送会有瞬间的HTTP请求峰值,可能导致开发者的服务器压力增大宕机。

相关链接#

事件列表

【钉钉】API开发者 微信交流群

用微信扫右侧二维码,加入【钉钉】API开发者 交流群,互助沟通

扫码加入交流群
修改于 2021-12-30 06:03:42
上一页
开发须知
下一页
开发流程介绍
Built with