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

dingtalk.oapi.edu.class.student.batchget (批量根据班级Id和学生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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request_param	OpenEduSelectStudentRequest []	可选		最大列表长度：999	请求体
studentParam OpenStudentParam [] 可选学生入参 └ classId String 可选 12312312 班级id └ studentIds String [] 可选 ["123123123"] 班级列表 └ userId String 可选 13123213 用户id └ classId Number 可选 123123213 班级id └ corpId String 可选 123123213 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	false	是否成功
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/batchget");
OapiEduClassStudentBatchgetRequest req = new OapiEduClassStudentBatchgetRequest();
List<OpenEduSelectStudentRequest> list2 = new ArrayList<OpenEduSelectStudentRequest>();
OpenEduSelectStudentRequest obj3 = new OpenEduSelectStudentRequest();
list2.add(obj3);
List<OpenStudentParam> list6 = new ArrayList<OpenStudentParam>();
OpenStudentParam obj7 = new OpenStudentParam();
list6.add(obj7);
obj7.setClassId("12312312");
obj7.setStudentIds(""123123123"");
list4.setStudentParam(list6);
obj3.setUserId("13123213");
obj3.setClassId(123123213L);
obj3.setCorpId("123123213");
req.setRequestParam(list2);
OapiEduClassStudentBatchgetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/class/student/batchget");
OapiEduClassStudentBatchgetRequest req = new OapiEduClassStudentBatchgetRequest();
List<OapiEduClassStudentBatchgetRequest.OpenEduSelectStudentRequestDomain> list2 = new List<OapiEduClassStudentBatchgetRequest.OpenEduSelectStudentRequestDomain>();
OapiEduClassStudentBatchgetRequest.OpenEduSelectStudentRequestDomain obj3 = new OapiEduClassStudentBatchgetRequest.OpenEduSelectStudentRequestDomain();
list2.Add(obj3);
List<OapiEduClassStudentBatchgetRequest.OpenStudentParamDomain> list5 = new List<OapiEduClassStudentBatchgetRequest.OpenStudentParamDomain>();
OapiEduClassStudentBatchgetRequest.OpenStudentParamDomain obj6 = new OapiEduClassStudentBatchgetRequest.OpenStudentParamDomain();
list5.Add(obj6);
obj6.ClassId = "12312312";
obj6.StudentIds = ""123123123"";
obj3.StudentParam= list5;
obj3.UserId = "13123213";
obj3.ClassId = 123123213L;
obj3.CorpId = "123123213";
req.RequestParam_ = list2;
OapiEduClassStudentBatchgetResponse 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 OapiEduClassStudentBatchgetRequest;
$request_param = new OpenEduSelectStudentRequest;
$studentParam = new OpenStudentParam;
$studentParam->classId="12312312";
$studentParam->studentIds="[\"123123123\"]";
$request_param->studentParam = array($studentParam);
$request_param->userId="13123213";
$request_param->classId="123123213";
$request_param->corpId="123123213";
$req->setRequestParam(array($request_param));
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/class/student/batchget");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/class/student/batchget" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a4edfb0c-4eb7-4c92-b211-dde889d74253' \
-d 'request_param=null'

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

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

req.request_param=""
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.batchget");
add_param(pRequest,"request_param","数据结构JSON示例");
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.batchget', {
	'request_param':'数据结构JSON示例'
}, 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":false,
    "errcode":0,
    "errmsg":"demo"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.class.student.batchget (批量根据班级Id和学生Id获取学生信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ