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

dingtalk.oapi.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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
id	String	可选	123		部门id
lang	String	可选	zh_CN		通讯录语言(默认zh_CN，未来会支持en_US)

响应参数

名称	类型	示例值	描述
errcode	Number	0	errcode
errmsg	String	ok	errmsg
id	Number	1	部门id
name	String	部门名称	部门名称
order	Number	1	在父部门中的次序值
parentid	Number	1	父部门id，根部门为1
sourceIdentifier	String	1	部门标识字段，开发者可用该字段来唯一标识一个部门，并与钉钉外部通讯录里的部门做映射
createDeptGroup	Boolean	false	是否同步创建一个关联此部门的企业群, true表示是, false表示不是
autoAddUser	Boolean	false	当群已经创建后，是否有新人加入部门会自动加入该群, true表示是, false表示不是
groupContainSubDept	Boolean	false	部门群是否包含子部门
orgDeptOwner	String	1	企业群群主
deptManagerUseridList	String	1	部门的主管列表,取值为由主管的userid组成的字符串，不同的userid使用\|符号进行分割
outerPermitUsers	String	1	本部门的员工仅可见员工自己为true时，可以配置额外可见人员，值为userid组成的的字符串，使用\| 符号进行分割
outerPermitDepts	String	1	本部门的员工仅可见员工自己为true时，可以配置额外可见部门，值为部门id组成的的字符串，使用\|符号进行分割
outerDept	Boolean	false	是否本部门的员工仅可见员工自己, 为true时，本部门员工默认只能看到员工自己
userPerimits	String	1	可以查看指定隐藏部门的其他人员列表，如果部门隐藏，则此值生效，取值为其他的人员userid组成的的字符串，使用\|符号进行分割
deptPerimits	String	1	可以查看指定隐藏部门的其他部门列表，如果部门隐藏，则此值生效，取值为其他的部门id组成的的字符串，使用\|符号进行分割
deptHiding	Boolean	false	是否隐藏部门, true表示隐藏, false表示显示
deptPermits	String	1	可以查看指定隐藏部门的其他人员列表，如果部门隐藏，则此值生效，取值为其他的人员userid组成的的字符串，使用\|符号进行分割
userPermits	String	2	可以查看指定隐藏部门的其他部门列表，如果部门隐藏，则此值生效，取值为其他的部门id组成的的字符串，使用\|符号进行分割
isFromUnionOrg	Boolean	true	部门是否来自关联组织

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/department/get");
OapiDepartmentGetRequest req = new OapiDepartmentGetRequest();
req.setId("123");
req.setLang("zh_CN");
req.setHttpMethod("GET");
OapiDepartmentGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/department/get");
OapiDepartmentGetRequest req = new OapiDepartmentGetRequest();
req.Id = "123";
req.Lang = "zh_CN";
req.SetHttpMethod("GET");
OapiDepartmentGetResponse 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_GET , DingTalkConstant::$FORMAT_JSON);
$req = new OapiDepartmentGetRequest;
$req->setId("123");
$req->setLang("zh_CN");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/department/get");

curl -X GET "https://oapi.dingtalk.com/department/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a02fc01c-9390-43a0-b132-bbf0494d4141' \
-d 'id=123' \
-d 'lang=zh_CN'

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

req=dingtalk.api.OapiDepartmentGetRequest("https://oapi.dingtalk.com/department/get")

req.id="123"
req.lang="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.department.get");
add_param(pRequest,"id","123");
add_param(pRequest,"lang","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.department.get', {
	'id':'123',
	'lang':'zh_CN'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "id":1,
    "name":"部门名称",
    "order":1,
    "parentid":1,
    "sourceIdentifier":"1",
    "createDeptGroup":false,
    "autoAddUser":false,
    "groupContainSubDept":false,
    "orgDeptOwner":"1",
    "deptManagerUseridList":"1",
    "outerPermitUsers":"1",
    "outerPermitDepts":"1",
    "outerDept":false,
    "userPerimits":"1",
    "deptPerimits":"1",
    "deptHiding":false,
    "deptPermits":"1",
    "userPermits":"2",
    "isFromUnionOrg":true
}

异常示例

JSON示例

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

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

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ