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

dingtalk.oapi.edu.class.studentinfo.get (根据班级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。

请求参数

名称	类型	是否必须	示例值	描述
class_id	Number	可选	123	班级id
app_id	Number	可选	321	isv应用id
userid	String	可选	12321	学生id

响应参数

名称	类型	描述
result	OpenStudentSelectDto	返回结果
└ userid String 学生id └ student_num String 学号 └ name String 姓名 └ class_id Number 班级id └ avatar String 头像 guardians OpenPatriarchSelectDto [] 家长列表 └ userid String 家长id └ relation String 关系key └ relation_name String 关系名称 └ name String 家长姓名 └ is_active Boolean 是否激活钉钉 └ avatar String 头像
success	Boolean	成功标识
errcode	Number	错误码
errmsg	String	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/class/studentinfo/get");
OapiEduClassStudentinfoGetRequest req = new OapiEduClassStudentinfoGetRequest();
req.setClassId(123L);
req.setAppId(321L);
req.setUserid("12321");
OapiEduClassStudentinfoGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/class/studentinfo/get");
OapiEduClassStudentinfoGetRequest req = new OapiEduClassStudentinfoGetRequest();
req.ClassId = 123L;
req.AppId = 321L;
req.Userid = "12321";
OapiEduClassStudentinfoGetResponse 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 OapiEduClassStudentinfoGetRequest;
$req->setClassId("123");
$req->setAppId("321");
$req->setUserid("12321");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/class/studentinfo/get");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/class/studentinfo/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ceac9e32-ee00-4194-a21b-582ddaffc477' \
-d 'app_id=321' \
-d 'class_id=123' \
-d 'userid=12321'

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

req=dingtalk.api.OapiEduClassStudentinfoGetRequest("https://oapi.dingtalk.com/topapi/edu/class/studentinfo/get")

req.class_id=123
req.app_id=321
req.userid="12321"
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.studentinfo.get");
add_param(pRequest,"class_id","123");
add_param(pRequest,"app_id","321");
add_param(pRequest,"userid","12321");
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.studentinfo.get', {
	'class_id':'123',
	'app_id':'321',
	'userid':'12321'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "userid":"",
        "student_num":"",
        "name":"",
        "class_id":,
        "avatar":"",
        "guardians":[
            {
                    "userid":"",
                    "relation":"",
                    "relation_name":"",
                    "name":"",
                    "is_active":,
                    "avatar":""
            }
        ]
    },
    "success":,
    "errcode":,
    "errmsg":""
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.class.studentinfo.get (根据班级id和学生id获取学生信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ