每日钉钉API探索:chooseDepartments专注于部门维度的选择接口

在企业级应用开发过程中,针对组织架构中的部门进行操作是非常常见的需求。今天我们要介绍的是钉钉的chooseDepartments API,它允许用户以部门为单位进行选择,并返回所选部门的相关信息。


📌 功能概述

chooseDepartments API主要用于选取企业内部的一个或多个部门,并返回这些部门的详细信息,包括部门ID、名称以及该部门下的员工数量等。与以人为维度的选择不同,此API聚焦于部门层级的操作,非常适合用于权限设置、通知发送等场景。


💻 支持平台

平台 版本要求
Android 6.0.0+
iOS 6.0.0+
Harmony 7.0.0+
Mac 6.0.0+
Windows 6.0.0+

注意:网页应用(原H5微应用)和小程序均从6.0.0版本开始支持此功能。


📲 应用类型支持

  • 企业内部应用:支持
  • 第三方企业应用:支持
  • 第三方个人应用:支持

这意味着无论你是为企业内部定制的应用程序,还是面向外部市场的应用程序,都可以利用这个API来增强你的应用功能。


🔒 鉴权规则

  • 在H5应用中,需通过调用dd.config完成鉴权后使用。
  • 对于小程序应用,可以直接调用无需额外鉴权,简化了开发流程。

⚙️ 参数说明

继承通用输入对象,并扩展以下关键参数:

参数名 类型 必填 示例值 描述
title String "标题" 选择页面的标题。
multiple Boolean true 是否允许多选:true - 多选;false - 单选(默认)。
limitTips String "选择数量不能超过20个" 超过限定数量返回的提示内容。
maxDepartments Number 100 最大可选部门数。
pickedDepartments Array ["deptId0","deptId1"] 已选的部门id列表。
disabledDepartments Array ["deptId0","deptId1"] 不可选的部门id列表。
requiredDepartments Array ["deptId0","deptId1"] 必选部门(不可取消选中状态)。
appId String H5应用必填 微应用agentId H5应用必填。
corpId String H5应用必填 企业的corpId H5应用必填。

📤 返回结果

成功调用后,将返回包含选定部门信息的对象,具体字段如下:

字段名 类型 示例值 描述
userCount Number 5 所选部门下所有员工的数量。
departments Array [{ "id": "68094649x", "name": "人事部", "number": 10 }] 包含部门ID、名称及人数的对象数组。
departmentsCount Number 2 所选部门的数量。

🛠 使用示例

以下是调用chooseDepartments的一个简单示例:

复制代码
dd.chooseDepartments({
  appId: 'appId示例值',
  title: '选择部门',
  corpId: 'corpId示例值',
  multiple: true,
  limitTips: '选择数量不能超过20个',
  maxDepartments: 100,
  pickedDepartments: ['deptId0', 'deptId1'],
  disabledDepartments: ['deptId0', 'deptId1'],
  requiredDepartments: ['deptId0', 'deptId1'],
  success: (res) => {
    console.log('选择的部门:', res);
    // 输出格式:
    // {
    //   userCount: 5,
    //   departments: [{ id: '68094649x', name: '人事部', number: 10 }],
    //   departmentsCount: 2
    // }
  },
  fail: () => {},
  complete: () => {},
});

希望今天的介绍能帮助你更好地理解和使用chooseDepartments API。未来我们将继续探讨更多实用的钉钉API,敬请期待!

相关推荐
跟‘码’死磕5 小时前
springboot集成钉钉群内发送消息
java·spring boot·钉钉
岚天start6 小时前
[K8S监控]-K8S容器pod异常状态监控脚本并推送钉钉告警
容器·kubernetes·钉钉·shell·告警
墨着染霜华2 天前
钉钉群机器人 Markdown :颜色渲染 + 链接跳转 + 图片嵌入的正确实现
钉钉
帅哥哥珍藏版2 天前
利用机器人Webhook向群推送告警通知
钉钉·飞书·企业微信
Dark_programmer7 天前
钉钉小程序 - - - - - 小程序内跳转其他小程序
小程序·apache·钉钉
一路向前的月光11 天前
Uniapp实现钉钉小程序前期基础配置
uni-app·钉钉
一念一花一世界13 天前
PostIn零基础学习 - 集成钉钉,使用钉钉扫码登录PostIn
钉钉·postin·接口管理工具
一念一花一世界13 天前
sourcefare零基础学习 - 集成钉钉,使用钉钉扫码登录sourcefare
钉钉·sourcefare·代码扫描工具
一念一花一世界13 天前
Arbess零基础学习 - 集成钉钉,使用钉钉扫码登录Arbess
ci/cd·钉钉·arbess
一念一花一世界14 天前
Arbess V2.1.9版本发布,支持Arm64位系统的安装部署,支持自定义消息模版,支持钉钉消息通知
ci/cd·钉钉·arm·arbess