DingTalk API

🏢 企业钉钉API一站式自动化方案

企业级钉钉开放平台API集成方案,覆盖组织架构查询、机器人消息推送、OA审批全流程管理,需配置App Key/Secret认证

收藏
9.1k
安装
3.6k
版本
1.4.0
CLS 安全性认证2026-05-08
点击查看完整报告 >

使用说明

核心用法

本 Skill 提供钉钉开放平台 30+ 个 API 的封装调用,分为四大功能模块:

组织架构管理:支持用户搜索(姓名/手机号/unionid)、用户详情查询、部门树遍历(父部门/子部门/部门用户列表)、员工人数统计、未登录用户查询、离职记录查询。根部门 deptId 固定为 1,支持自动分页获取全量数据。

消息推送能力:通过机器人实现单聊消息发送(需 userId + robotCode)和群聊消息发送(需 openConversationId),支持查询群内机器人列表获取可用 robotCode。

OA 审批全生命周期:覆盖审批实例查询(ID列表/详情)、用户视角审批管理(发起/抄送/待办/已办/数量统计)、审批操作(发起/终止/同意/拒绝/转交/评论)。支持表单数据 JSON 构造和时间戳范围查询。

技术实现:基于 TypeScript 命令行脚本,统一错误处理格式(success + error 对象),支持 --debug 参数输出详细日志。

显著优点

  • 功能全面:覆盖钉钉最核心的通讯录、消息、审批三大 API 体系,单 Skill 解决企业自动化多数场景
  • 企业级设计:支持离职人员、未登录用户等管理场景,符合 HR/IT 部门实际需求
  • 统一封装:标准化的 JSON 输入输出,降低钉钉 API 的学习成本
  • 审批自动化完整:少有的支持审批"发起-流转-终止-评论"全流程的开源封装

潜在缺点与局限性

  • 认证门槛:必须预先创建钉钉应用并获取 App Key/Secret,个人开发者难以体验
  • 权限依赖:部分接口(如手机号查用户、离职记录)仅限企业内部应用,第三方应用无法调用
  • 无实时能力:纯轮询式 API 调用,不支持钉钉回调推送(如审批状态变更 webhook)
  • 机器人限制:消息发送依赖预先配置的机器人,不支持主动创建群或邀请成员
  • 时间限制:未登录用户查询只能查 1 个月内数据,且需次日 9 点后才能获取前一天数据

适合人群

  • 企业 IT 管理员:自动化员工信息同步、离职审计
  • HR 系统开发者:集成钉钉审批流,实现请假/报销等流程自动化
  • 运维/行政人员:批量发送通知消息、统计组织架构数据
  • 低代码平台集成者:通过命令行封装快速对接钉钉能力

常规风险

数据隐私合规:直接处理员工手机号、邮箱、部门架构等敏感信息,需确保符合《个人信息保护法》和企业内部数据规范。

权限越界风险:审批操作(同意/拒绝/终止)具有业务法律效力,自动化脚本需配合严格的审批策略和日志审计。

Token 安全管理:App Secret 泄露将导致全量 API 权限被盗用,环境变量方式在生产环境需配合密钥管理系统(KMS)。

频率限制风险:钉钉 API 存在调用频次限制(如获取 access_token 每日 2000 次),大规模分页查询需实现指数退避重试。

安全解读

核心功能

dingtalk-api 是一套完整的企业钉钉开放平台 API 调用工具集,基于阿里云官方 SDK 构建,提供 30+ 项核心功能:

1. 用户管理

  • 用户搜索(支持姓名关键词)
  • 用户详情查询(手机号、邮箱、部门归属)
  • 多维度用户查询(手机号、unionid)
  • 未登录用户统计、员工人数统计
  • 离职记录查询

2. 部门管理

  • 部门搜索与详情获取
  • 子部门/父部门层级遍历
  • 部门用户列表获取(支持分页与全量)
  • 部门与用户关联关系查询

3. 消息通知

  • 机器人单聊消息发送
  • 机器人群聊消息发送
  • 群内机器人列表查询

4. OA 审批管理(完整工作流)

  • 审批实例查询(ID列表、详情、发起人/抄送/待办/已办视角)
  • 审批发起与终止
  • 审批任务执行(同意/拒绝)
  • 审批转交与评论
  • 待审批数量统计

显著优点

1. 官方 SDK 保障:使用 @alicloud/dingtalk 官方 SDK,非直接 HTTP 封装,协议兼容性与安全性更有保障
2. TypeScript 类型安全:完整的类型定义,IDE 智能提示友好

3. 功能覆盖全面:涵盖钉钉通讯录、消息、审批三大核心场景,满足 90% 以上企业自动化需求

4. CLI 即用即走:无需编写代码,命令行直接调用,适合脚本集成与运维场景

5. 统一错误格式:所有接口返回标准化 JSON,便于程序化解析

6. 无代码注入风险:无 eval/exec/system 等危险函数,静态扫描通过

局限性与注意事项

1. 网络依赖:所有功能依赖钉钉开放平台 API(oapi.dingtalk.com),内网隔离环境需开通白名单
2. 权限前置:需预先在钉钉开放平台创建应用并配置 API 权限,部分接口仅限企业内部应用

3. 数据出境:用户数据、审批数据将传输至钉钉服务器,需评估是否符合组织合规要求

4. 无本地缓存:每次调用均实时请求 API,高频场景需注意钉钉接口频率限制

5. 消息机器人限制:机器人消息发送受钉钉平台频次与内容审核策略约束

适合人群

  • 企业 IT 管理员:批量用户/部门数据导出、离职人员审计
  • HR/行政团队:自动化审批流程查询与统计
  • 运维工程师:基于钉钉的告警通知、值班机器人
  • 开发者:快速原型验证、企业系统集成

常规风险提示

| 风险类型 | 等级 | 说明 |
|---------|------|------|
| 凭证泄露 | 中 | 依赖 `DINGTALK_APP_KEY`/`SECRET` 环境变量,需避免提交至代码仓库 |
| API 频率限制 | 低 | 钉钉平台存在调用频次限制,大批量操作需分页控制 |
| 数据隐私 | 中 | 涉及员工敏感信息(手机号、邮箱),需符合组织数据安全策略 |
| 服务可用性 | 低 | 钉钉 API 服务异常时将完全不可用,建议关键场景添加降级方案 |

DingTalk API 内容

scripts文件夹
types文件夹
手动下载zip · 79.3 kB
add-approval-comment.tstext/plain
请选择文件