更新时间:2023-08-08 GMT+08:00
分享

钉钉(企业内部应用)

提供创建部门群、发送信息等服务,包含“删除部门”、“发送消息到企业群”和“获取部门用户userid列表”等执行动作。

连接参数

钉钉(企业内部应用)连接器使用APIkey认证,创建钉钉(企业内部应用)连接时连接参数说明如表1所示。

表1 连接参数说明

名称

必填

说明

示例值/默认值

连接名称

设置连接名称。

钉钉(企业内部应用)的连接。

描述

对于连接的信息描述说明。

description

应用标识Key

应用标识Key。

可在[钉钉开发者后台](https://open-dev.dingtalk.com/)的应用详情页面获取。

应用的密钥

应用的密钥。

可在[钉钉开发者后台](https://open-dev.dingtalk.com/)的应用详情页面获取。

删除部门

删除钉钉内已创建的部门。

  • 输入参数

    用户配置删除部门执行动作,相关参数说明如表2所示。

    表2 删除部门输入参数说明

    参数

    必填

    说明

    部门ID

    部门ID。

  • 输出参数

    该执行动作无输出参数。

创建部门

在钉钉内创建部门。

  • 输入参数

    用户配置创建部门执行动作,相关参数说明如表3所示。

    表3 创建部门输入参数说明

    参数

    必填

    说明

    部门名称

    部门名称。

    父部门ID

    父部门ID,根部门ID为1。

  • 输出参数

    该执行动作无输出参数。

删除用户

删除钉钉内已存在的用户。

  • 输入参数

    用户配置删除用户执行动作,相关参数说明如表4所示。

    表4 删除用户输入参数说明

    参数

    必填

    说明

    员工ID

    员工的userid。

  • 输出参数

    该执行动作无输出参数。

创建用户

在钉钉内创建新用户。

  • 输入参数

    用户配置创建用户执行动作,相关参数说明如表5所示。

    表5 创建用户输入参数说明

    参数

    必填

    说明

    员工名称

    员工名称,长度最大80个字符。

    手机号码

    手机号码,企业内必须唯一。

    所属部门id列表

    所属部门ID列表。

  • 输出参数

    该执行动作无输出参数。

创建群会话

在钉钉内创建群会话。

  • 输入参数

    用户配置创建群会话执行动作,相关参数说明如表6所示。

    表6 创建群会话输入参数说明

    参数

    必填

    说明

    access_token

    access_token。

    群名称

    群名称。

    群主

    群主的userid。

    群成员列表

    群成员的userid数组。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表7

    表7 创建群会话输出参数说明

    参数

    说明

    errcode

    错误码。

    errmsg

    错误信息。

    chatid

    群会话的ID。

    openConversationId

    openConversationId。

    conversationTag

    conversationTag。

发送消息到企业群

发送消息到企业群。

  • 输入参数

    用户配置发送消息到企业群执行动作,相关参数说明如表8所示。

    表8 发送消息到企业群输入参数说明

    参数

    必填

    说明

    群会话的ID

    群会话的ID。

    消息内容

    消息内容。

  • 输出参数

    该执行动作无输出参数。

获取部门用户基础信息

获取部门用户的基础信息。

  • 输入参数

    用户配置获取部门用户基础信息执行动作,相关参数说明如表9所示。

    表9 获取部门用户基础信息输入参数说明

    参数

    必填

    说明

    分页数

    分页查询的游标,最开始传0。

    分页长度

    分页长度,最大值100。

    部门ID

    部门ID。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表10

    表10 获取部门用户基础信息输出参数说明

    参数

    说明

    errcode

    错误码。

    errmsg

    错误信息。

    has_more

    has_more。

    list

    部门用户基础信息列表。

    name

    用户名。

    userid

    用户ID。

    request_id

    request_id。

获取部门列表

获取部门列表。

  • 输入参数

    用户配置获取部门列表执行动作,相关参数说明如表11所示。

    表11 获取部门列表输入参数说明

    参数

    必填

    说明

    部门ID

    部门ID。如果不传,默认部门为根部门,根部门ID为1。

    通讯录语言

    通讯录语言:zh_CN(默认):中文,en_US:英文。

  • 输出参数

    该执行动作无输出参数。

获取部门用户userid列表

获取部门用户userid列表。

  • 输入参数

    用户配置获取部门用户userid列表执行动作,相关参数说明如表12所示。

    表12 获取部门用户userid列表输入参数说明

    参数

    必填

    说明

    部门ID

    部门ID,根部门ID为1。

    access_token

    access_token。

  • 输出参数

    该执行动作无输出参数。

相关文档