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

dingtalk.oapi.edu.course.join (加入课程)

加入课程，一般由前端学生点击上课加入课堂，返回相应课堂交互信息，例如直播场景下返回加入url等信息

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
course_code	String	必须	nRFRa5001	需要加入的课程编码
op_user_id	String	必须	manager7078	操作用户id
join_role	String	可选	student	用户角色

响应参数

名称	类型	示例值	描述
result	JoinCourseResponse		result
└ join_url String https://h5.dingtalk.com/live/video_lesson.htm?feedId=d5ff4f29-01bf-441b-a384-81b9d532b6b9&mcnId=1709073120201407324&feedProperty=1&itemId=d5ff4f29-01bf-441b-a384-81b9d532b6b9&dd_nav_bgcolor=FF2C2D2F#/live 加入链接 └ joinable Boolean true 是否可加入 └ join_target_id String ff5f8e55-4a1a-4624-a7bf-fc44477e7c88 加入的目标id
success	Boolean	true	success
errcode	Number	0	dingOpenErrcode
errmsg	String	成功	errorMsg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/course/join");
OapiEduCourseJoinRequest req = new OapiEduCourseJoinRequest();
req.setCourseCode("nRFRa5001");
req.setOpUserId("manager7078");
req.setJoinRole("student");
OapiEduCourseJoinResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/course/join");
OapiEduCourseJoinRequest req = new OapiEduCourseJoinRequest();
req.CourseCode = "nRFRa5001";
req.OpUserId = "manager7078";
req.JoinRole = "student";
OapiEduCourseJoinResponse 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 OapiEduCourseJoinRequest;
$req->setCourseCode("nRFRa5001");
$req->setOpUserId("manager7078");
$req->setJoinRole("student");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/course/join");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/course/join" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=117384e7-e086-4367-b0aa-656d184b0e5f' \
-d 'course_code=nRFRa5001' \
-d 'join_role=student' \
-d 'op_user_id=manager7078'

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

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

req.course_code="nRFRa5001"
req.op_user_id="manager7078"
req.join_role="student"
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.join");
add_param(pRequest,"course_code","nRFRa5001");
add_param(pRequest,"op_user_id","manager7078");
add_param(pRequest,"join_role","student");
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.join', {
	'course_code':'nRFRa5001',
	'op_user_id':'manager7078',
	'join_role':'student'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "join_url":"https:\/\/h5.dingtalk.com\/live\/video_lesson.htm?feedId=d5ff4f29-01bf-441b-a384-81b9d532b6b9&mcnId=1709073120201407324&feedProperty=1&itemId=d5ff4f29-01bf-441b-a384-81b9d532b6b9&dd_nav_bgcolor=FF2C2D2F#\/live",
        "joinable":true,
        "join_target_id":"ff5f8e55-4a1a-4624-a7bf-fc44477e7c88"
    },
    "success":true,
    "errcode":0,
    "errmsg":"成功"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

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

联系方式

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

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

提交反馈

用户反馈

感谢您的反馈！

用户反馈

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

钉钉API

dingtalk.oapi.edu.course.join (加入课程)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈