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

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
class_id	Number	必须	23234234		班级ID
userid	String	必须	423423423		用户ID
student_param	OpenStudentParam []	可选		最大列表长度：20	学生入参
└ class_id String 可选 23432432 班级ID └ student_ids String [] 可选 234234234 学生列表
corp_id	String	可选	1234124123123		corpId

响应参数

名称	类型	示例值	描述
result	String	{ "students": { "R": [{ "classId": 145113971, "guardians": [{ "avatar": "https://static.dingtalk.com/media/lADPDgQ9rnvKuPfNBADNBAA_1024_1024.jpg", "isActive": true, "name": "然小荻妈妈", "relation": "M", "relationName": "妈妈", "staffId": "1575454775361" }], "name": "然小荻", "staffId": "1576567417384-28615938" }], "C": [{ "classId": 145113971, "guardians": [{ "avatar": "https://static.dingtalk.com/media/lADPD2eDL5TI6wrNAoDNAm0_621_640.jpg", "isActive": true, "name": "程短松爸爸", "relation": "F", "relationName": "爸爸", "staffId": "1578231151884--1828197646" }], "name": "程短松", "staffId": "1578231371903-31002748" }], "H": [{ "classId": 145113971, "name": "哈哈", "staffId": "1583464854381" }], "X": [{ "classId": 145113971, "name": "栩小齐", "staffId": "1577394675306" }] } }	返回结果
success	Boolean	true	成功状态
errcode	Number	0	错误编码
errmsg	String	demo	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/class/student/list");
OapiEduClassStudentListRequest req = new OapiEduClassStudentListRequest();
req.setClassId(23234234L);
req.setUserid("423423423");
List<OpenStudentParam> list2 = new ArrayList<OpenStudentParam>();
OpenStudentParam obj3 = new OpenStudentParam();
list2.add(obj3);
obj3.setClassId("23432432");
obj3.setStudentIds("234234234");
req.setStudentParam(list2);
req.setCorpId("1234124123123");
OapiEduClassStudentListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/class/student/list");
OapiEduClassStudentListRequest req = new OapiEduClassStudentListRequest();
req.ClassId = 23234234L;
req.Userid = "423423423";
List<OapiEduClassStudentListRequest.OpenStudentParamDomain> list2 = new List<OapiEduClassStudentListRequest.OpenStudentParamDomain>();
OapiEduClassStudentListRequest.OpenStudentParamDomain obj3 = new OapiEduClassStudentListRequest.OpenStudentParamDomain();
list2.Add(obj3);
obj3.ClassId = "23432432";
obj3.StudentIds = "234234234";
req.StudentParam_ = list2;
req.CorpId = "1234124123123";
OapiEduClassStudentListResponse 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 OapiEduClassStudentListRequest;
$req->setClassId("23234234");
$req->setUserid("423423423");
$student_param = new OpenStudentParam;
$student_param->class_id="23432432";
$student_param->student_ids="234234234";
$req->setStudentParam(array($student_param));
$req->setCorpId("1234124123123");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/class/student/list");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/class/student/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=88c8a0f8-1d34-4a56-9cac-6a1f7f45a024' \
-d 'class_id=23234234' \
-d 'corp_id=1234124123123' \
-d 'student_param=null' \
-d 'userid=423423423'

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

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

req.class_id=23234234
req.userid="423423423"
req.student_param=""
req.corp_id="1234124123123"
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.student.list");
add_param(pRequest,"class_id","23234234");
add_param(pRequest,"userid","423423423");
add_param(pRequest,"student_param","数据结构JSON示例");
add_param(pRequest,"corp_id","1234124123123");
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.student.list', {
	'class_id':'23234234',
	'userid':'423423423',
	'student_param':'数据结构JSON示例',
	'corp_id':'1234124123123'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":"{ \t\"students\": { \t\t\"R\": [{ \t\t\t\"classId\": 145113971, \t\t\t\"guardians\": [{ \t\t\t\t\"avatar\": \"https:\/\/static.dingtalk.com\/media\/lADPDgQ9rnvKuPfNBADNBAA_1024_1024.jpg\", \t\t\t\t\"isActive\": true, \t\t\t\t\"name\": \"然小荻妈妈\", \t\t\t\t\"relation\": \"M\", \t\t\t\t\"relationName\": \"妈妈\", \t\t\t\t\"staffId\": \"1575454775361\" \t\t\t}], \t\t\t\"name\": \"然小荻\", \t\t\t\"staffId\": \"1576567417384-28615938\" \t\t}], \t\t\"C\": [{ \t\t\t\"classId\": 145113971, \t\t\t\"guardians\": [{ \t\t\t\t\"avatar\": \"https:\/\/static.dingtalk.com\/media\/lADPD2eDL5TI6wrNAoDNAm0_621_640.jpg\", \t\t\t\t\"isActive\": true, \t\t\t\t\"name\": \"程短松爸爸\", \t\t\t\t\"relation\": \"F\", \t\t\t\t\"relationName\": \"爸爸\", \t\t\t\t\"staffId\": \"1578231151884--1828197646\" \t\t\t}], \t\t\t\"name\": \"程短松\", \t\t\t\"staffId\": \"1578231371903-31002748\" \t\t}], \t\t\"H\": [{ \t\t\t\"classId\": 145113971, \t\t\t\"name\": \"哈哈\", \t\t\t\"staffId\": \"1583464854381\" \t\t}], \t\t\"X\": [{ \t\t\t\"classId\": 145113971, \t\t\t\"name\": \"栩小齐\", \t\t\t\"staffId\": \"1577394675306\" \t\t}] \t} }",
    "success":true,
    "errcode":0,
    "errmsg":"demo"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.edu.class.student.list (查询班级下学生列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ