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

dingtalk.oapi.edu.course.start (开始课程)

开始课程，一般由老师点击上课发起，进行课程交互创建并发起，例如直播上课场景会创建直播内容，返回相关信息供前端唤起直播端

公共参数

环境	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
start_option	StartOption	可选		开始课程的可选属性设定
└ b_allow_join_in_advance Boolean 可选 true 默认值：false 该课堂是否允许提前进入，时效最早为提前30分钟

响应参数

名称	类型	示例值	描述
result	StartCourseResponse		result
└ target_type Number 2 交互目标类型 └ target_id String d5ff4f29-01bf-441b-a384-81b9d532b6b9 交互内容id └ is_reuse Boolean true 交互是否重用
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/start");
OapiEduCourseStartRequest req = new OapiEduCourseStartRequest();
req.setCourseCode("nRFRa5001");
req.setOpUserId("manager7078");
StartOption obj1 = new StartOption();
obj1.setBAllowJoinInAdvance(true);
req.setStartOption(obj1);
OapiEduCourseStartResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/course/start");
OapiEduCourseStartRequest req = new OapiEduCourseStartRequest();
req.CourseCode = "nRFRa5001";
req.OpUserId = "manager7078";
OapiEduCourseStartRequest.StartOptionDomain obj1 = new OapiEduCourseStartRequest.StartOptionDomain();
obj1.BAllowJoinInAdvance = true;
req.StartOption_ = obj1;
OapiEduCourseStartResponse 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 OapiEduCourseStartRequest;
$req->setCourseCode("nRFRa5001");
$req->setOpUserId("manager7078");
$start_option = new StartOption;
$start_option->b_allow_join_in_advance="true";
$req->setStartOption($start_option);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/course/start");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/course/start" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d823dfc3-2c06-403f-af9e-72230bfc254e' \
-d 'course_code=nRFRa5001' \
-d 'op_user_id=manager7078' \
-d 'start_option=null'

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

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

req.course_code="nRFRa5001"
req.op_user_id="manager7078"
req.start_option=""
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.start");
add_param(pRequest,"course_code","nRFRa5001");
add_param(pRequest,"op_user_id","manager7078");
add_param(pRequest,"start_option","数据结构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.start', {
	'course_code':'nRFRa5001',
	'op_user_id':'manager7078',
	'start_option':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "target_type":2,
        "target_id":"d5ff4f29-01bf-441b-a384-81b9d532b6b9",
        "is_reuse":true
    },
    "success":true,
    "errcode":0,
    "errmsg":"成功"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.course.start (开始课程)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ