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

dingtalk.oapi.edu.class.list (班级列表信息)

班级列表信息，通过orgid、班级id查询班级名称、所在学段id、校区id

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
grade_id	Number	必须	654321	年级ID
page_no	Number	必须	1	分页页数
page_size	Number	必须	10	分页每页大小

响应参数

名称	类型	示例值	描述
result	PageResult	{ "result":[ { "campus_id":123, "class_level":1, "grade_level":1, "class_id":123, "grade_id":123, "period_id":123, "nick":"nick", "name":"name" } ], "errcode":"0", "errmsg":"msg", "success":"true" }	result
list ClassResponse [] list 列表 └ class_id Number 111 班级ID └ grade_id Number 123 年级ID └ period_id Number 123 学段ID └ campus_id Number 123 校区ID └ nick String nick 别名 └ name String 一年级1班班级名称 └ grade_level Number 1 年级级数（一年级为1，二年级为2） └ class_level Number 1 每个年级下班级级数（1班为1,2班为2） └ has_more Boolean true 是否有分页 └ next_cursor Number 10 分页游标
errcode	Number	0	错误码
errmsg	String	msg	错误信息
success	Boolean	true	成功状态

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/class/list");
OapiEduClassListRequest req = new OapiEduClassListRequest();
req.setGradeId(654321L);
req.setPageNo(1L);
req.setPageSize(10L);
OapiEduClassListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/class/list");
OapiEduClassListRequest req = new OapiEduClassListRequest();
req.GradeId = 654321L;
req.PageNo = 1L;
req.PageSize = 10L;
OapiEduClassListResponse 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 OapiEduClassListRequest;
$req->setGradeId("654321");
$req->setPageNo("1");
$req->setPageSize("10");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/class/list");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/class/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=fde0dfab-0b53-46d8-9206-6bac114dc6dd' \
-d 'grade_id=654321' \
-d 'page_no=1' \
-d 'page_size=10'

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

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

req.grade_id=654321
req.page_no=1
req.page_size=10
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.class.list");
add_param(pRequest,"grade_id","654321");
add_param(pRequest,"page_no","1");
add_param(pRequest,"page_size","10");
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.class.list', {
	'grade_id':'654321',
	'page_no':'1',
	'page_size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "list":[
            {
                    "class_id":111,
                    "grade_id":123,
                    "period_id":123,
                    "campus_id":123,
                    "nick":"nick",
                    "name":"一年级1班",
                    "grade_level":1,
                    "class_level":1
            }
        ],
        "has_more":true,
        "next_cursor":10
    },
    "errcode":0,
    "errmsg":"msg",
    "success":true
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.edu.class.list (班级列表信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ