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

dingtalk.oapi.edu.class.listbyteacher (查询老师的班级列表)

查询老师班级列表

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
filter_param	OpenClassParam	可选		过滤入参
└ group_type String 可选 officialClassGroup 群类型 └ role String 可选 all 角色
userid	String	可选	23234324	用户ID
queryFromAllOrgs	Boolean	可选	false	是否跨组织查询
ret_ext_fields	OpenEduSelectClassExtFields	可选		返回的扩展信息设置(不支持跨组织)
└ ret_conversation_list Boolean 可选 true 返回群信息

响应参数

名称	类型	示例值	描述
result	Result []		返回结果
└ nick String demo 昵称 └ class_id Number 145260873 部门ID └ graduate Boolean false 是否毕业班 └ count Number 3 班级学生人数 └ name String 一年级2班班级名称 └ warning String demo 不再过滤群类型 └ super_id Number 145248939 父部门ID └ userid String 1231252123123 用户id └ corp_id String 1231252123123 每个班级的corpId conversation_list ConversationInfo [] 群信息列表 └ title String 一年级1班班级群名称 └ type String officialClassGroup 群类型，officialClassGroup: 家校群; teacherStudentGroup: 师生群
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/listbyteacher");
OapiEduClassListbyteacherRequest req = new OapiEduClassListbyteacherRequest();
OpenClassParam obj1 = new OpenClassParam();
obj1.setGroupType("officialClassGroup");
obj1.setRole("all");
req.setFilterParam(obj1);
req.setUserid("23234324");
req.setQueryFromAllOrgs(false);
OpenEduSelectClassExtFields obj2 = new OpenEduSelectClassExtFields();
obj2.setRetConversationList(true);
req.setRetExtFields(obj2);
OapiEduClassListbyteacherResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/class/listbyteacher");
OapiEduClassListbyteacherRequest req = new OapiEduClassListbyteacherRequest();
OapiEduClassListbyteacherRequest.OpenClassParamDomain obj1 = new OapiEduClassListbyteacherRequest.OpenClassParamDomain();
obj1.GroupType = "officialClassGroup";
obj1.Role = "all";
req.FilterParam_ = obj1;
req.Userid = "23234324";
req.QueryFromAllOrgs = false;
OapiEduClassListbyteacherRequest.OpenEduSelectClassExtFieldsDomain obj2 = new OapiEduClassListbyteacherRequest.OpenEduSelectClassExtFieldsDomain();
obj2.RetConversationList = true;
req.RetExtFields_ = obj2;
OapiEduClassListbyteacherResponse 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 OapiEduClassListbyteacherRequest;
$filter_param = new OpenClassParam;
$filter_param->group_type="officialClassGroup";
$filter_param->role="all";
$req->setFilterParam($filter_param);
$req->setUserid("23234324");
$req->setQueryFromAllOrgs("false");
$ret_ext_fields = new OpenEduSelectClassExtFields;
$ret_ext_fields->ret_conversation_list="true";
$req->setRetExtFields($ret_ext_fields);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/class/listbyteacher");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/class/listbyteacher" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=b575d412-f8be-4576-b4ad-039fbea84654' \
-d 'filter_param=null' \
-d 'queryFromAllOrgs=false' \
-d 'ret_ext_fields=null' \
-d 'userid=23234324'

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

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

req.filter_param=""
req.userid="23234324"
req.queryFromAllOrgs=false
req.ret_ext_fields=""
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.listbyteacher");
add_param(pRequest,"filter_param","数据结构JSON示例");
add_param(pRequest,"userid","23234324");
add_param(pRequest,"queryFromAllOrgs","false");
add_param(pRequest,"ret_ext_fields","数据结构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.listbyteacher', {
	'filter_param':'数据结构JSON示例',
	'userid':'23234324',
	'queryFromAllOrgs':'false',
	'ret_ext_fields':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":[
        {
                "nick":"demo",
                "class_id":145260873,
                "graduate":false,
                "count":3,
                "name":"一年级2班",
                "warning":"demo",
                "super_id":145248939,
                "userid":"1231252123123",
                "corp_id":"1231252123123",
                "conversation_list":[
                    {
                            "title":"一年级1班",
                            "type":"officialClassGroup"
                    }
                ]
        }
    ],
    "success":true,
    "errcode":0,
    "errmsg":"demo"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.edu.class.listbyteacher (查询老师的班级列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈