获取部门详情

说明

调用本接口根据部门ID获取指定部门详情。
服务地址：https://oapi.dingtalk.com

权限

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

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

请求参数

Query 参数

access_token

必需

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

示例值:

bE74xxxx

Body 参数application/json

dept_id

number

必需

部门ID，根部门ID为1。

language

string

可选

通讯录语言：zh_CN（默认）：中文en_US：英文

示例

{
    "language": "zh_CN",
    "dept_id": 100
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

request_id

string

请求ID。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

result

object

部门详情。

可选

dept_id

number

部门ID。

可选

name

string

部门名称。

可选

parent_id

number

父部门ID。

可选

source_identifier

string

可选

部门标识字段。第三方企业应用不返回该参数。

create_dept_group

boolean

可选

是否同步创建一个关联此部门的企业群：true：创建false：不创建

auto_add_user

boolean

可选

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

auto_approve_apply

boolean

可选

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

from_union_org

boolean

可选

部门是否来自关联组织：true：是false：不是第三方企业应用不返回该参数。

tags

string

可选

教育部门标签：campus：校区period：学段grade：年级class：班级第三方企业应用不返回该参数。

order

number

可选

在父部门中的次序值。

dept_group_chat_id

string

部门群ID。

可选

group_contain_sub_dept

boolean

可选

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

org_dept_owner

string

企业群群主ID。

可选

dept_manager_userid_list

array[string]

部门的主管列表。

可选

outer_dept

boolean

可选

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

outer_permit_depts

array[number]

可选

当限制部门成员的通讯录查看范围时（即outer_dept为true时），配置的部门员工可见部门列表。

outer_permit_users

array[string]

可选

当限制部门成员的通讯录查看范围时（即outer_dept为true时），配置的部门员工可见员工列表。

hide_dept

boolean

可选

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

user_permits

array[string]

可选

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

dept_permits

array[number]

可选

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

示例

{
    "request_id": "string",
    "errcode": 0,
    "errmsg": "string",
    "result": {
        "dept_id": 0,
        "name": "string",
        "parent_id": 0,
        "source_identifier": "string",
        "create_dept_group": true,
        "auto_add_user": true,
        "auto_approve_apply": true,
        "from_union_org": true,
        "tags": "string",
        "order": 0,
        "dept_group_chat_id": "string",
        "group_contain_sub_dept": true,
        "org_dept_owner": "string",
        "dept_manager_userid_list": [
            "string"
        ],
        "outer_dept": true,
        "outer_permit_depts": [
            0
        ],
        "outer_permit_users": [
            "string"
        ],
        "hide_dept": true,
        "user_permits": [
            "string"
        ],
        "dept_permits": [
            0
        ]
    }
}

说明#

权限#

请求参数

示例代码

返回响应

说明

权限