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

dingtalk.oapi.edu.guardian.create (添加家长)

在班级下添加家长

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
class_id	Number	必须	1234	班级id
stu_id	String	必须	1234	学生id
mobile	String	必须	13675893456	手机号码
biz_id	String	可选	123	业务id
operator	String	必须	12345	钉钉企业管理员
relation	String	必须	F	关系code；关系枚举如下： F:爸爸 M：妈妈 GF:爷爷 GM:奶奶 GFA:外公 GMA:外婆 U:叔叔 A:阿姨 B：哥哥 S:姐姐 O:其他

响应参数

名称	类型	示例值	描述
result	OpenEduUserCreateResponse	{}	结果
└ biz_id String 123 业务id └ userid String 1603692783914 用户id
success	Boolean	true	是否成功
errcode	Number	0	错误码
errmsg	String	demo	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/guardian/create");
OapiEduGuardianCreateRequest req = new OapiEduGuardianCreateRequest();
req.setClassId(1234L);
req.setStuId("1234");
req.setMobile("13675893456");
req.setBizId("123");
req.setOperator("12345");
req.setRelation("F");
OapiEduGuardianCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/guardian/create");
OapiEduGuardianCreateRequest req = new OapiEduGuardianCreateRequest();
req.ClassId = 1234L;
req.StuId = "1234";
req.Mobile = "13675893456";
req.BizId = "123";
req.Operator = "12345";
req.Relation = "F";
OapiEduGuardianCreateResponse 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 OapiEduGuardianCreateRequest;
$req->setClassId("1234");
$req->setStuId("1234");
$req->setMobile("13675893456");
$req->setBizId("123");
$req->setOperator("12345");
$req->setRelation("F");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/edu/guardian/create");

curl -X POST "https://oapi.dingtalk.com/topapi/edu/guardian/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ada7417d-b571-4594-910e-e57b830fe096' \
-d 'biz_id=123' \
-d 'class_id=1234' \
-d 'mobile=13675893456' \
-d 'operator=12345' \
-d 'relation=F' \
-d 'stu_id=1234'

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

req=dingtalk.api.OapiEduGuardianCreateRequest("https://oapi.dingtalk.com/topapi/edu/guardian/create")

req.class_id=1234
req.stu_id="1234"
req.mobile="13675893456"
req.biz_id="123"
req.operator="12345"
req.relation="F"
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.guardian.create");
add_param(pRequest,"class_id","1234");
add_param(pRequest,"stu_id","1234");
add_param(pRequest,"mobile","13675893456");
add_param(pRequest,"biz_id","123");
add_param(pRequest,"operator","12345");
add_param(pRequest,"relation","F");
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.guardian.create', {
	'class_id':'1234',
	'stu_id':'1234',
	'mobile':'13675893456',
	'biz_id':'123',
	'operator':'12345',
	'relation':'F'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "biz_id":"123",
        "userid":"1603692783914"
    },
    "success":true,
    "errcode":0,
    "errmsg":"demo"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.edu.guardian.create (添加家长)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ