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

dingtalk.oapi.industry.studentpool.batchadd (批量添加学员到学员池)

钉钉教培,提供给isv向学员池中批量写入学员的接口

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
biz_code	String	必须	1003		业务code
student_list	TrainingStudentDto []	可选		最大列表长度：20	学员列表
└ mobile String 可选 18511111111 学员手机号 └ package_ids Number [] 可选 [12,34] 课包ID列表 └ number String 可选 123456 学员编号 patriarchs PatriarchDto [] 可选学员联系人列表 └ relation String 可选 F 联系人与学员的关系 └ mobile String 可选 18511111111 联系人手机号 └ name String 可选丁明联系人名字 └ name String 可选丁小明学员名字

响应参数

名称	类型	示例值	描述
result	String []	["丁小明"]	校验重名,返回重名人列表
success	Boolean	true	是否调用成功
errcode	Number	0	错误码
errmsg	String	"成功"	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/industry/studentpool/batchadd");
OapiIndustryStudentpoolBatchaddRequest req = new OapiIndustryStudentpoolBatchaddRequest();
req.setBizCode("1003");
List<TrainingStudentDto> list2 = new ArrayList<TrainingStudentDto>();
TrainingStudentDto obj3 = new TrainingStudentDto();
list2.add(obj3);
obj3.setMobile("18511111111");
obj3.setPackageIds(new Long[] { 12,34 };
);
obj3.setNumber("123456");
List<PatriarchDto> list6 = new ArrayList<PatriarchDto>();
PatriarchDto obj7 = new PatriarchDto();
list6.add(obj7);
obj7.setRelation("F");
obj7.setMobile("18511111111");
obj7.setName("丁明");
list4.setPatriarchs(list6);
obj3.setName("丁小明");
req.setStudentList(list2);
OapiIndustryStudentpoolBatchaddResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/industry/studentpool/batchadd");
OapiIndustryStudentpoolBatchaddRequest req = new OapiIndustryStudentpoolBatchaddRequest();
req.BizCode = "1003";
List<OapiIndustryStudentpoolBatchaddRequest.TrainingStudentDtoDomain> list2 = new List<OapiIndustryStudentpoolBatchaddRequest.TrainingStudentDtoDomain>();
OapiIndustryStudentpoolBatchaddRequest.TrainingStudentDtoDomain obj3 = new OapiIndustryStudentpoolBatchaddRequest.TrainingStudentDtoDomain();
list2.Add(obj3);
obj3.Mobile = "18511111111";
obj3.PackageIds = new long[] { 12,34 };
;
obj3.Number = "123456";
List<OapiIndustryStudentpoolBatchaddRequest.PatriarchDtoDomain> list5 = new List<OapiIndustryStudentpoolBatchaddRequest.PatriarchDtoDomain>();
OapiIndustryStudentpoolBatchaddRequest.PatriarchDtoDomain obj6 = new OapiIndustryStudentpoolBatchaddRequest.PatriarchDtoDomain();
list5.Add(obj6);
obj6.Relation = "F";
obj6.Mobile = "18511111111";
obj6.Name = "丁明";
obj3.Patriarchs= list5;
obj3.Name = "丁小明";
req.StudentList_ = list2;
OapiIndustryStudentpoolBatchaddResponse 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 OapiIndustryStudentpoolBatchaddRequest;
$req->setBizCode("1003");
$student_list = new TrainingStudentDto;
$student_list->mobile="18511111111";
$student_list->package_ids="[12,34]";
$student_list->number="123456";
$patriarchs = new PatriarchDto;
$patriarchs->relation="F";
$patriarchs->mobile="18511111111";
$patriarchs->name="丁明";
$student_list->patriarchs = array($patriarchs);
$student_list->name="丁小明";
$req->setStudentList(array($student_list));
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/industry/studentpool/batchadd");

curl -X POST "https://oapi.dingtalk.com/topapi/industry/studentpool/batchadd" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2d26d6c7-cf1d-4703-9b16-c4043305e72a' \
-d 'biz_code=1003' \
-d 'student_list=null'

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

req=dingtalk.api.OapiIndustryStudentpoolBatchaddRequest("https://oapi.dingtalk.com/topapi/industry/studentpool/batchadd")

req.biz_code="1003"
req.student_list=""
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.industry.studentpool.batchadd");
add_param(pRequest,"biz_code","1003");
add_param(pRequest,"student_list","数据结构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.industry.studentpool.batchadd', {
	'biz_code':'1003',
	'student_list':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "string":[
            "[\"丁小明\"]"
        ]
    },
    "success":true,
    "errcode":0,
    "errmsg":"\"成功\""
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.industry.studentpool.batchadd (批量添加学员到学员池)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ