DingTalk API

🔍 钉钉官方SDK · 企业通讯录自动化

基于钉钉官方SDK的企业通讯录管理工具,支持用户搜索、部门管理,需配置环境变量认证,适合自动化办公场景。

收藏
16.8k
安装
3.6k
版本
1.0.1
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

DingTalk API Skill 是面向钉钉开放平台的企业级集成工具,主要提供以下功能:

1. 用户搜索 (searchUser): 根据姓名关键词搜索企业通讯录用户,返回匹配的 UserId 列表
2. Token 自动管理: 自动从环境变量读取 DINGTALK_APP_KEYDINGTALK_APP_SECRET,调用 oauth2_1_0.getAccessToken 获取访问凭证

3. 开发辅助: 内置 npm run update-skill 命令,自动解析代码变更并同步更新 SKILL.md 文档

使用流程:配置环境变量 → 执行搜索命令 → 获取 JSON 格式结果(含 userIds 列表、匹配数量、分页信息)。

显著优点

  • 官方 SDK 背书: 基于 @alicloud/dingtalk 官方 SDK 开发,API 兼容性和稳定性有保障
  • 零配置快速启动: 仅需设置两个环境变量即可运行,无需复杂配置
  • 自动化文档维护: Git Hooks 机制实现代码与文档自动同步,降低维护成本
  • TypeScript 类型安全: 全量 TS 支持,开发体验友好
  • 企业场景聚焦: 精准覆盖「按姓名找人」这一高频办公需求

潜在缺点与局限性

  • 权限门槛: 需预先开通 qyapi_addresslist_search 权限,且仅限企业内部应用使用
  • 搜索维度单一: 当前仅支持姓名搜索,不支持手机号、邮箱、部门等多维度检索
  • 环境变量依赖: 凭证管理完全依赖本地环境变量,不适合多租户或云端部署场景
  • 返回信息有限: API 仅返回 userId 列表,如需完整用户信息需二次调用
  • 功能覆盖较窄: 目前仅实现用户搜索,部门管理、消息推送等能力尚未覆盖

适合人群

  • 企业内部开发者,需快速集成钉钉通讯录到内部系统
  • 需要自动化「找人」流程的运维/HR 团队
  • 使用 TypeScript/Node.js 技术栈的钉钉应用开发者
  • 追求「最小可用」方案的轻量级用户

常规风险

| 风险类型 | 说明 |
|---------|------|
| **凭证泄露** | AppSecret 硬编码或环境变量暴露可能导致企业数据泄露 |
| **权限越界** | 需严格控制 `qyapi_addresslist_search` 权限范围,避免过度授权 |
| **API 限流** | 高频调用可能触发钉钉平台频率限制,需实现重试机制 |
| **隐私合规** | 用户搜索涉及员工个人信息,需符合《个人信息保护法》要求 |

DingTalk API 内容

暂无文件树

手动下载zip · 16.5 kB
contentapplication/octet-stream
请选择文件