获取部门详情

GET

http://127.0.0.1/department/get

历史文档（不推荐）/通讯录管理/部门管理1.0(不推荐)

最后修改时间：2022-08-30 09:19:22

责任人：未设置

说明

调用本接口获取部门详细信息。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	是	开发者后台申请	调试
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。

示例值:

6ed1bxxx

string

必需

部门ID，可通过调用获取部门列表接口获取。

示例值:

lang

string

可选

通讯录语言，默认zh_CN。

示例值:

zh_CN

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://127.0.0.1/department/get?access_token=6ed1bxxx&id=1' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

number

可选

部门ID，1为根部门。

name

string

部门名称。

可选

order

number

可选

在父部门中的次序值，order值小的排序靠前。

parentid

number

可选

父部门ID，1为根部门。第三方企业应用不返回该参数。

sourceIdentifier

string

可选

部门标识字段，开发者可用该字段来唯一标识一个部门，并与钉钉外部通讯录里的部门做映射。

createDeptGroup

boolean

可选

是否创建一个关联此部门的企业群，默认为false。

autoAddUser

boolean

可选

当群已经创建后，是否有新人加入部门时会自动加入该群：true：自动加入群false：不会自动加入群

autoApproveApply

boolean

可选

是否默认同意加入该部门的申请：true：表示加入该部门的申请将默认同意false：表示加入该部门的申请需要有权限的管理员同意

groupContainSubDept

boolean

可选

部门群是否包含子部门：true：包含false：不包含

orgDeptOwner

string

可选

企业群群主的userid。

deptGroupChatId

string

可选

创建部门群自动生成的id。

deptManagerUseridList

string

可选

部门的主管列表，取值为由主管的userid组成的字符串，不同的userid使用"|"符号进行分隔。

outerDept

boolean

可选

是否限制本部门成员查看通讯录：true：开启限制，开启后本部门成员只能看到限定范围内的通讯录false：不限制

outerPermitUsers

string

可选

当outerDept为true时（即开启本部门成员只能看到限定范围内的通讯录），配置的部门员工可见员工列表。

outerPermitDepts

string

可选

当outerDept为true时（即开启本部门成员只能看到限定范围内的通讯录），配置的部门员工可见部门列表。

deptHiding

boolean

可选

是否隐藏部门：true：隐藏，隐藏本部门开启后，本部门将不会显示在公司通讯录中false：显示

deptPermits

string

可选

当deptHiding为true时（即开启隐藏本部门），配置的允许在通讯录中查看本部门的部门列表。

userPermits

string

可选

当deptHiding为true时（即开启隐藏本部门），配置的允许在通讯录中查看本部门的员工列表。

示例

{
  "errcode": 0,
  "errmsg": "string",
  "id": 0,
  "name": "string",
  "order": 0,
  "parentid": 0,
  "sourceIdentifier": "string",
  "createDeptGroup": true,
  "autoAddUser": true,
  "autoApproveApply": true,
  "groupContainSubDept": true,
  "orgDeptOwner": "string",
  "deptGroupChatId": "string",
  "deptManagerUseridList": "string",
  "outerDept": true,
  "outerPermitUsers": "string",
  "outerPermitDepts": "string",
  "deptHiding": true,
  "deptPermits": "string",
  "userPermits": "string"
}

更新部门

获取部门列表

获取部门详情

说明#

权限#

请求参数

示例代码

返回响应

说明

权限