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

dingtalk.oapi.department.list (获取部门列表)

获取部门列表

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	描述
lang	String	可选	1	通讯录语言(默认zh_CN，未来会支持en_US)
fetch_child	Boolean	可选	true	是否递归部门的全部子部门，ISV微应用固定传递false。
id	String	可选	1	父部门id(如果不传，默认部门为根部门，根部门ID为1)

响应参数

名称	类型	示例值	描述
errcode	Number	0	errcode
errmsg	String	ok	errmsg
department	Department []		department
└ id Number id └ name String name └ parentid Number parentid └ sourceIdentifier String sourceIdentifier └ createDeptGroup Boolean createDeptGroup └ autoAddUser Boolean autoAddUser └ isFromUnionOrg Boolean isFromUnionOrg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/department/list");
OapiDepartmentListRequest req = new OapiDepartmentListRequest();
req.setLang("1");
req.setFetchChild(true);
req.setId("1");
req.setHttpMethod("GET");
OapiDepartmentListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/department/list");
OapiDepartmentListRequest req = new OapiDepartmentListRequest();
req.Lang = "1";
req.FetchChild = true;
req.Id = "1";
req.SetHttpMethod("GET");
OapiDepartmentListResponse 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 OapiDepartmentListRequest;
$req->setLang("1");
$req->setFetchChild("true");
$req->setId("1");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/department/list");

curl -X GET "https://oapi.dingtalk.com/department/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=bda96dda-5f91-4eca-b7de-9e22c85e8709' \
-d 'fetch_child=true' \
-d 'id=1' \
-d 'lang=1'

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

req=dingtalk.api.OapiDepartmentListRequest("https://oapi.dingtalk.com/department/list")

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

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "department":[
        {
                "id":,
                "name":"",
                "parentid":,
                "sourceIdentifier":"",
                "createDeptGroup":,
                "autoAddUser":,
                "isFromUnionOrg":
        }
    ]
}

异常示例

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.list (获取部门列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ