文档中心 > API类目 > 钉钉API

dingtalk.oapi.v2.department.get (获取部门详情)

获取部门详情

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
dept_id	Number	必须	100		部门id，根部门ID为1
language	String	可选	zh_CN	默认值：zh_CN	通讯录语言（默认zh_CN）

响应参数

名称	类型	示例值	描述
errcode	Number	0	返回码
errmsg	String	ok	错误信息
result	DeptGetResponse	{}	部门详情
└ dept_id Number 100 部门ID └ name String HR 部门名称 └ parent_id Number 50 父部门id，根部门为1 └ source_identifier String HR 部门标识字段，开发者可用该字段来唯一标识一个部门，并与钉钉外部通讯录里的部门做映射 └ create_dept_group Boolean true 是否同步创建一个关联此部门的企业群, true表示是, false表示不是 └ auto_add_user Boolean false 当群已经创建后，是否有新人加入部门会自动加入该群 └ tags String campus 教育行业部门类型，包括campus,period,grade,class. └ from_union_org Boolean false 部门是否来自关联组织 └ extention String {} 扩展字段 └ order Number 10 在父部门中的次序值 └ dept_group_chat_id String 123 部门群ID └ group_contain_sub_dept Boolean true 部门群是否包含子部门 └ org_dept_owner String 80 企业群群主ID └ dept_manager_userid_list String [] ["5","6","7","8"] 部门的主管列表 └ outer_dept Boolean true 是否本部门的员工仅可见员工自己, 为true时，本部门员工默认只能看到员工自己 └ outer_permit_depts Number [] [500,600] 本部门的员工仅可见员工自己为true时，可以配置额外可见部门 └ outer_permit_users String [] ["78","79"] 本部门的员工仅可见员工自己为true时，可以配置额外可见人员 └ user_permits String [] ["5","9"] 可以查看指定隐藏部门的其他人员列表，如果部门隐藏，则此值生效，取值为其他的人员userid组成的数组 └ hide_dept Boolean false 是否隐藏部门, true表示隐藏, false表示显示 └ dept_permits Number [] [3,4,5] 可以查看指定隐藏部门的其他人员列表，如果部门隐藏，则此值生效，取值为其他的人员userid组成的数组 └ brief String 这是简介部门简介 └ telephone String 138xxxx0000 联系方式（手机号码或座机号码） └ auto_approve_apply Boolean true 开启后，加入该部门的申请将默认同意 └ emp_apply_join_dept Boolean true 开启后，允许员工加入部门 hide_scene_config SceneConfig 部门隐藏的生效场景配置 └ chatbox_subtitle Boolean true 是否在单聊框生效 └ node_list Boolean true 是否在查看组织架构生效 └ search Boolean true 是否在搜索生效 └ profile Boolean true 是否在个人资料页生效 └ active Boolean true 当前部门是否采用单独的配置。如果设置了false，则采用组织维度的配置 outer_scene_config SceneConfig 部门限制可见的生效场景配置 └ chatbox_subtitle Boolean true 是否在单聊框生效 └ node_list Boolean true 是否在查看组织架构生效 └ search Boolean true 是否在搜索生效 └ profile Boolean true 是否在个人资料页生效 └ active Boolean true 当前部门是否采用单独的配置。如果设置了false，则采用组织维度的配置 └ code String 10000 部门编码 union_dept_ext UnionDeptExt 关联部门信息 └ dept_id Number 1234567 关联部门ID └ corp_id String test 关联部门的企业corpId └ member_count Number 100 部门成员数（包含子部门） └ owning_member_count Number 100 部门成员数（不包含子部门）

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/department/get");
OapiV2DepartmentGetRequest req = new OapiV2DepartmentGetRequest();
req.setDeptId(100L);
req.setLanguage("zh_CN");
OapiV2DepartmentGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/department/get");
OapiV2DepartmentGetRequest req = new OapiV2DepartmentGetRequest();
req.DeptId = 100L;
req.Language = "zh_CN";
OapiV2DepartmentGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2DepartmentGetRequest;
$req->setDeptId("100");
$req->setLanguage("zh_CN");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/v2/department/get");

curl -X POST "https://oapi.dingtalk.com/topapi/v2/department/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=20239326-e60b-4830-9722-e4d7ed33caca' \
-d 'dept_id=100' \
-d 'language=zh_CN'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiV2DepartmentGetRequest("https://oapi.dingtalk.com/topapi/v2/department/get")

req.dept_id=100
req.language="zh_CN"
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.v2.department.get");
add_param(pRequest,"dept_id","100");
add_param(pRequest,"language","zh_CN");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.v2.department.get', {
	'dept_id':'100',
	'language':'zh_CN'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "result":{
        "dept_id":100,
        "name":"HR",
        "parent_id":50,
        "source_identifier":"HR",
        "create_dept_group":true,
        "auto_add_user":false,
        "tags":"campus",
        "from_union_org":false,
        "extention":"{}",
        "order":10,
        "dept_group_chat_id":"123",
        "group_contain_sub_dept":true,
        "org_dept_owner":"80",
        "dept_manager_userid_list":{
            "string":[
                "[\"5\"",
                "\"6\"",
                "\"7\"",
                "\"8\"]"
            ]
        },
        "outer_dept":true,
        "outer_permit_depts":{
            "number":[
                [500,
                600]
            ]
        },
        "outer_permit_users":{
            "string":[
                "[\"78\"",
                "\"79\"]"
            ]
        },
        "user_permits":{
            "string":[
                "[\"5\"",
                "\"9\"]"
            ]
        },
        "hide_dept":false,
        "dept_permits":{
            "number":[
                [3,
                4,
                5]
            ]
        },
        "brief":"这是简介",
        "telephone":"138xxxx0000",
        "auto_approve_apply":true,
        "emp_apply_join_dept":true,
        "hide_scene_config":{
            "chatbox_subtitle":true,
            "node_list":true,
            "search":true,
            "profile":true,
            "active":true
        },
        "outer_scene_config":{
            "chatbox_subtitle":true,
            "node_list":true,
            "search":true,
            "profile":true,
            "active":true
        },
        "code":"10000",
        "union_dept_ext":{
            "dept_id":1234567,
            "corp_id":"test"
        },
        "member_count":100,
        "owning_member_count":100
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案
60020	IP不在白名单中	在开发者后台将发起请求的IP加入白名单中
90018	请求被限流	降低请求次数
isp.-1

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.v2.department.get (获取部门详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ