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

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

请求参数

名称	类型	是否必须	示例值	描述
page_size	Number	必须	30	每页大小，最大30
page_no	Number	必须	1	页码，从1开始
super_id	Number	可选	1234	父部门节点id，如果不填，则默认获取第一层级的部门节点

响应参数

名称	类型	示例值	描述
result	OpenEduDeptListResponse	{}	数据集，不为空。
details OpenEduDeptDetails [] [] 部门节点列表，不空。 └ nick String 苹果班可空 └ chain String [4240016, 4240017] 部门链 └ feature String {"class_level":0,"grade_level":0} 节点特有属性 └ name String 自定义下的班级节点名 └ contact_type String custom 家校通讯录类型。自定义or标准 └ dept_type String class 节点类型 └ dept_id Number 4240018 节点id └ has_more Boolean false 是否有更多数据 └ super_id Number 4240017 父部门id
success	Boolean	true	是否成功
errcode	Number	0	错误码，只有success为false时有效
errmsg	String	ok	错误信息，只有success为false有效

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/dept/list");
OapiEduDeptListRequest req = new OapiEduDeptListRequest();
req.setPageSize(30L);
req.setPageNo(1L);
req.setSuperId(1234L);
OapiEduDeptListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/dept/list");
OapiEduDeptListRequest req = new OapiEduDeptListRequest();
req.PageSize = 30L;
req.PageNo = 1L;
req.SuperId = 1234L;
OapiEduDeptListResponse 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 OapiEduDeptListRequest;
$req->setPageSize("30");
$req->setPageNo("1");
$req->setSuperId("1234");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/dept/list");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/dept/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=1fb82e21-b066-4d83-88da-686bcbc91e2a' \
-d 'page_no=1' \
-d 'page_size=30' \
-d 'super_id=1234'

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

req=dingtalk.api.OapiEduDeptListRequest("https://oapi.dingtalk.com/topapi/edu/dept/list")

req.page_size=30
req.page_no=1
req.super_id=1234
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.edu.dept.list");
add_param(pRequest,"page_size","30");
add_param(pRequest,"page_no","1");
add_param(pRequest,"super_id","1234");
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.edu.dept.list', {
	'page_size':'30',
	'page_no':'1',
	'super_id':'1234'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "details":[
            {
                    "nick":"苹果班",
                    "chain":"[4240016, 4240017]",
                    "feature":"{\"class_level\":0,\"grade_level\":0}",
                    "name":"自定义下的班级",
                    "contact_type":"custom",
                    "dept_type":"class",
                    "dept_id":4240018
            }
        ],
        "has_more":false,
        "super_id":4240017
    },
    "success":true,
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.edu.dept.list (获取部门节点列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ