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

dingtalk.oapi.edu.course.participant.batchadd (批量添加课程参与方)

批量添加课程参与方

公共参数

环境	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	必须	manager1		当前用户ID
course_participants	CourseParticipantBaseDTO []	必须		最大列表长度：100	参与方列表
└ role String 必须 student 参与方角色。student：学生、guardian: 监护人、teacher：老师（注意：授课老师只支持通过课程创建和修改接口，进行添加和修改） └ participant_id String 必须 user01 参与方ID。participant_type=1时，participant_id表示用户ID；participant_type=2时，participant_id表示部门ID；participant_type=3时，participant_id表示组织ID； └ participant_type Number 必须 1 参与方类型。1：用户、2：部门（对应家校通讯录中的班级、年级。详情请参考https://ding-doc.dingtalk.com/doc#/serverapi3/gga05a/z3y0h）、3：组织 option CourseParticipantOption 可选参与方选项信息 └ groupType String 可选 teacherStudentGroup 群类型：teacherStudentGroup（师生群）、officialClassGroup（家校群）
participant_corpid	String	必须	ding4220d8e5128d0edd		参与方的组织CropId
course_codes	String []	必须	GJKI49001,GJKI49002	最大列表长度：10	课程编码集合

响应参数

名称	类型	示例值	描述
result	Boolean	true	操作是否成功
success	Boolean	true	请求是否成功
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/participant/batchadd");
OapiEduCourseParticipantBatchaddRequest req = new OapiEduCourseParticipantBatchaddRequest();
req.setOpUserid("manager1");
List<CourseParticipantBaseDTO> list2 = new ArrayList<CourseParticipantBaseDTO>();
CourseParticipantBaseDTO obj3 = new CourseParticipantBaseDTO();
list2.add(obj3);
obj3.setRole("student");
obj3.setParticipantId("user01");
obj3.setParticipantType(1L);
CourseParticipantOption obj5 = new CourseParticipantOption();
obj5.setGroupType("teacherStudentGroup");
list4.setOption(obj5);
req.setCourseParticipants(list2);
req.setParticipantCorpid("ding4220d8e5128d0edd");
req.setCourseCodes("GJKI49001,GJKI49002");
OapiEduCourseParticipantBatchaddResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/course/participant/batchadd");
OapiEduCourseParticipantBatchaddRequest req = new OapiEduCourseParticipantBatchaddRequest();
req.OpUserid = "manager1";
List<OapiEduCourseParticipantBatchaddRequest.CourseParticipantBaseDTODomain> list2 = new List<OapiEduCourseParticipantBatchaddRequest.CourseParticipantBaseDTODomain>();
OapiEduCourseParticipantBatchaddRequest.CourseParticipantBaseDTODomain obj3 = new OapiEduCourseParticipantBatchaddRequest.CourseParticipantBaseDTODomain();
list2.Add(obj3);
obj3.Role = "student";
obj3.ParticipantId = "user01";
obj3.ParticipantType = 1L;
OapiEduCourseParticipantBatchaddRequest.CourseParticipantOptionDomain obj4 = new OapiEduCourseParticipantBatchaddRequest.CourseParticipantOptionDomain();
obj4.GroupType = "teacherStudentGroup";
obj3.Option= obj4;
req.CourseParticipants_ = list2;
req.ParticipantCorpid = "ding4220d8e5128d0edd";
req.CourseCodes = "GJKI49001,GJKI49002";
OapiEduCourseParticipantBatchaddResponse 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 OapiEduCourseParticipantBatchaddRequest;
$req->setOpUserid("manager1");
$course_participants = new CourseParticipantBaseDTO;
$course_participants->role="student";
$course_participants->participant_id="user01";
$course_participants->participant_type="1";
$option = new CourseParticipantOption;
$option->groupType="teacherStudentGroup";
$course_participants->option = $option;
$req->setCourseParticipants(array($course_participants));
$req->setParticipantCorpid("ding4220d8e5128d0edd");
$req->setCourseCodes("GJKI49001,GJKI49002");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/course/participant/batchadd");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/course/participant/batchadd" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=1d718147-7988-4470-9f61-89dcc68083d5' \
-d 'course_codes=GJKI49001%2CGJKI49002' \
-d 'course_participants=null' \
-d 'op_userid=manager1' \
-d 'participant_corpid=ding4220d8e5128d0edd'

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

req=dingtalk.api.OapiEduCourseParticipantBatchaddRequest("https://oapi.dingtalk.com/topapi/edu/course/participant/batchadd")

req.op_userid="manager1"
req.course_participants=""
req.participant_corpid="ding4220d8e5128d0edd"
req.course_codes="GJKI49001,GJKI49002"
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.participant.batchadd");
add_param(pRequest,"op_userid","manager1");
add_param(pRequest,"course_participants","数据结构JSON示例");
add_param(pRequest,"participant_corpid","ding4220d8e5128d0edd");
add_param(pRequest,"course_codes","GJKI49001,GJKI49002");
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.participant.batchadd', {
	'op_userid':'manager1',
	'course_participants':'数据结构JSON示例',
	'participant_corpid':'ding4220d8e5128d0edd',
	'course_codes':'GJKI49001,GJKI49002'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":true,
    "success":true,
    "errcode":0,
    "errmsg":"成功"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.course.participant.batchadd (批量添加课程参与方)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ