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

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
op_userid	String	必须	manager		当前操作人的用户ID
cursor	Number	必须	0	最小值：0	表示分页游标，从0开始
size	Number	必须	10	最小值：1 最大值：100	表示分页大小
start_time	Number	可选	1618294458		时间查询开始区间
end_time	Number	可选	1618396458		时间查询结束区间
statuses	Number []	可选	0,1	最大列表长度：5	课程状态值
option	QueryCourseOption	可选			查询选项
└ b_fetch_classrooms Boolean 可选 false 默认值：false 是否连带查询课堂信息
scene	String	可选	lecture	默认值：manage	查询的场景：当前有：manage(管理视角)，lecture(授课视角)
participant_condition	QueryCourseParticipantCondition	可选			参与方查询条件
└ role String 可选 teacher 参与方角色选项
suite_keys	String []	可选	[suitejc7o7gseko92digf,suitejc7o7gseko92digf2]	最大列表长度：5	按应用唯一标识列表查询
course_codes	String []	可选	[EKKKe4580002,EKKKe4580003]	最大列表长度：100	按课程编码列表查询
name	String	可选	测试课程		按课程名称查询
teacher_conditions	QueryTeacherCondition []	可选		最大列表长度：30	授课老师查询条件
└ corpid String 可选 ding4220d8e5128d0edd 授课老师组织CorpId └ userid String 可选 teacher1 老师用户id

响应参数

名称	类型	示例值	描述
success	Boolean	true	请求是否成功
errcode	Number	0	错误编码
errmsg	String	error	错误信息
result	ListCourseResponse		result
└ has_more Boolean ture 是否还有更多数据 list CourseVO [] list └ biz_key String uk_1 业务唯一键 └ teacher_userid String teacher1 老师的用户ID └ teacher_corpid String ding4220d8e5128d0edd 老的的组织CorpId └ end_time Number 1596506200000 结束时间，Unix毫秒时间戳 └ start_time Number 1596506100000 开始时间，Unix毫秒时间戳 └ introduce String 课程介绍课程介绍 └ name String 课程名称课程名称 └ code String 12312 课程编码 └ teacher_username String 小五老师的用户名 classrooms Classrooms [] list └ target_id String 5fsd4dd8db81a25a44200643 课堂唯一标识id └ interact_info String {'duration': '20:30', 'cover':'...'} 课堂交互信息 └ platform Number 2 新版在线课堂 └ ext_info String {‘onlineMode’:1, 'recordAvatar':true} 课程扩展信息 └ status Number 1 课程状态 -1取消，0未开始，1进行中，2已结束 └ creator_corpid String ding4220d8e5128d0edd 创建者的组织CorpId └ creator_userid String creator1 创建者的用户ID └ creator_username String 小六创建者的用户名 └ next_cursor Number 10 表示下一次分页的游标，如果next_corsor为null或者has_more为false，表示没有更多的分页数据 └ total_count Number 100 数量总计100

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/course/list");
OapiEduCourseListRequest req = new OapiEduCourseListRequest();
req.setOpUserid("manager");
req.setCursor(0L);
req.setSize(10L);
req.setStartTime(1618294458L);
req.setEndTime(1618396458L);
req.setStatuses("0,1");
QueryCourseOption obj1 = new QueryCourseOption();
obj1.setBFetchClassrooms(false);
req.setOption(obj1);
req.setScene("lecture");
QueryCourseParticipantCondition obj2 = new QueryCourseParticipantCondition();
obj2.setRole("teacher");
req.setParticipantCondition(obj2);
req.setSuiteKeys("suitejc7o7gseko92digf,suitejc7o7gseko92digf2");
req.setCourseCodes("EKKKe4580002,EKKKe4580003");
req.setName("测试课程");
List<QueryTeacherCondition> list4 = new ArrayList<QueryTeacherCondition>();
QueryTeacherCondition obj5 = new QueryTeacherCondition();
list4.add(obj5);
obj5.setCorpid("ding4220d8e5128d0edd");
obj5.setUserid("teacher1");
req.setTeacherConditions(list4);
OapiEduCourseListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/course/list");
OapiEduCourseListRequest req = new OapiEduCourseListRequest();
req.OpUserid = "manager";
req.Cursor = 0L;
req.Size = 10L;
req.StartTime = 1618294458L;
req.EndTime = 1618396458L;
req.Statuses = "0,1";
OapiEduCourseListRequest.QueryCourseOptionDomain obj1 = new OapiEduCourseListRequest.QueryCourseOptionDomain();
obj1.BFetchClassrooms = false;
req.Option_ = obj1;
req.Scene = "lecture";
OapiEduCourseListRequest.QueryCourseParticipantConditionDomain obj2 = new OapiEduCourseListRequest.QueryCourseParticipantConditionDomain();
obj2.Role = "teacher";
req.ParticipantCondition_ = obj2;
req.SuiteKeys = "suitejc7o7gseko92digf,suitejc7o7gseko92digf2";
req.CourseCodes = "EKKKe4580002,EKKKe4580003";
req.Name = "测试课程";
List<OapiEduCourseListRequest.QueryTeacherConditionDomain> list4 = new List<OapiEduCourseListRequest.QueryTeacherConditionDomain>();
OapiEduCourseListRequest.QueryTeacherConditionDomain obj5 = new OapiEduCourseListRequest.QueryTeacherConditionDomain();
list4.Add(obj5);
obj5.Corpid = "ding4220d8e5128d0edd";
obj5.Userid = "teacher1";
req.TeacherConditions_ = list4;
OapiEduCourseListResponse 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 OapiEduCourseListRequest;
$req->setOpUserid("manager");
$req->setCursor("0");
$req->setSize("10");
$req->setStartTime("1618294458");
$req->setEndTime("1618396458");
$req->setStatuses("0,1");
$option = new QueryCourseOption;
$option->b_fetch_classrooms="false";
$req->setOption($option);
$req->setScene("lecture");
$participant_condition = new QueryCourseParticipantCondition;
$participant_condition->role="teacher";
$req->setParticipantCondition($participant_condition);
$req->setSuiteKeys("[suitejc7o7gseko92digf,suitejc7o7gseko92digf2]");
$req->setCourseCodes("[EKKKe4580002,EKKKe4580003]");
$req->setName("测试课程");
$teacher_conditions = new QueryTeacherCondition;
$teacher_conditions->corpid="ding4220d8e5128d0edd";
$teacher_conditions->userid="teacher1";
$req->setTeacherConditions(array($teacher_conditions));
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/course/list");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/course/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ca7a785f-9e0c-450a-a47e-3a4d3c711df9' \
-d 'course_codes=EKKKe4580002%2CEKKKe4580003' \
-d 'cursor=0' \
-d 'end_time=1618396458' \
-d 'name=%E6%B5%8B%E8%AF%95%E8%AF%BE%E7%A8%8B' \
-d 'op_userid=manager' \
-d 'option=null' \
-d 'participant_condition=null' \
-d 'scene=lecture' \
-d 'size=10' \
-d 'start_time=1618294458' \
-d 'statuses=0%2C1' \
-d 'suite_keys=suitejc7o7gseko92digf%2Csuitejc7o7gseko92digf2' \
-d 'teacher_conditions=null'

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

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

req.op_userid="manager"
req.cursor=0
req.size=10
req.start_time=1618294458
req.end_time=1618396458
req.statuses="0,1"
req.option=""
req.scene="lecture"
req.participant_condition=""
req.suite_keys="[suitejc7o7gseko92digf,suitejc7o7gseko92digf2]"
req.course_codes="[EKKKe4580002,EKKKe4580003]"
req.name="测试课程"
req.teacher_conditions=""
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.course.list");
add_param(pRequest,"op_userid","manager");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","10");
add_param(pRequest,"start_time","1618294458");
add_param(pRequest,"end_time","1618396458");
add_param(pRequest,"statuses","0,1");
add_param(pRequest,"option","数据结构JSON示例");
add_param(pRequest,"scene","lecture");
add_param(pRequest,"participant_condition","数据结构JSON示例");
add_param(pRequest,"suite_keys","suitejc7o7gseko92digf,suitejc7o7gseko92digf2");
add_param(pRequest,"course_codes","EKKKe4580002,EKKKe4580003");
add_param(pRequest,"name","测试课程");
add_param(pRequest,"teacher_conditions","数据结构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.course.list', {
	'op_userid':'manager',
	'cursor':'0',
	'size':'10',
	'start_time':'1618294458',
	'end_time':'1618396458',
	'statuses':'0,1',
	'option':'数据结构JSON示例',
	'scene':'lecture',
	'participant_condition':'数据结构JSON示例',
	'suite_keys':'suitejc7o7gseko92digf,suitejc7o7gseko92digf2',
	'course_codes':'EKKKe4580002,EKKKe4580003',
	'name':'测试课程',
	'teacher_conditions':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "success":true,
    "errcode":0,
    "errmsg":"error",
    "result":{
        "has_more":ture,
        "list":[
            {
                    "biz_key":"uk_1",
                    "teacher_userid":"teacher1",
                    "teacher_corpid":"ding4220d8e5128d0edd",
                    "end_time":1596506200000,
                    "start_time":1596506100000,
                    "introduce":"课程介绍",
                    "name":"课程名称",
                    "code":"12312",
                    "teacher_username":"小五",
                    "classrooms":[
                        {
                                "target_id":"5fsd4dd8db81a25a44200643",
                                "interact_info":"{'duration': '20:30', 'cover':'...'}"
                        }
                    ],
                    "platform":2,
                    "ext_info":"{‘onlineMode’:1, 'recordAvatar':true}",
                    "status":1,
                    "creator_corpid":"ding4220d8e5128d0edd",
                    "creator_userid":"creator1",
                    "creator_username":"小六"
            }
        ],
        "next_cursor":10,
        "total_count":100
    }
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

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

联系方式

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

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

提交反馈

用户反馈

感谢您的反馈！

用户反馈

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

钉钉API

dingtalk.oapi.edu.course.list (获取课程列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈