添加学生

调用本接口,在指定的班级下新增学生信息。

调用本接口,可在指定班级内添加学生,接口调用效果与下图操作实现效果一致。image

权限

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

钉钉教育家校通讯录写权限

调试

第三方企业应用

钉钉教育家校通讯录写权限

调试

第三方个人应用

基本信息

请求方式:POST

请求地址https://oapi.dingtalk.com/topapi/edu/student/create

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

6d1bxxxx

调用该接口的应用凭证。

Body参数

名称

类型

是否必填

示例值

描述

class_id

Number

4240018

班级ID。

  • 企业内部应用,调用获取部门列表接口获取dept_type为class时的dept_id参数值。

  • 第三方企业应用,调用获取部门列表接口获取dept_type为class时的dept_id参数值。

name

String

阳xx

学生姓名。

biz_id

String

biz_id

业务的唯一ID,自定义值,每次调用保持唯一。

student_no

String

no12

学生学号。

operator

String

user01

钉钉企业管理员的userId。

mobile

String

152xxxxxxxx

学生手机号。

返回参数

名称

类型

示例值

描述

result

Result

调用结果。

biz_id

String

biz_id

业务的唯一ID。

userid

String

manager01

学生的userId。

success

Boolean

true

请求是否成功。

  • true:成功

  • false:失败

errcode

Number

0

返回码。

errmsg

String

ok

返回码描述。

request_id

String

5bsof0hsgtds

请求ID。

示例

请求示例(HTTP)

POST https://oapi.dingtalk.com/topapi/edu/student/create?access_token=ACCESS_TOKEN

请求正文

{
    "class_id": 4240018,
    "name": "阳xx",
    "student_no": "no12",
    "biz_id": "biz_id",
    "operator": "user01",
     "mobile":"152xxxxxxxx"
}

请求示例(JAVA SDK)

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/edu/student/create");
OapiEduStudentCreateRequest req = new OapiEduStudentCreateRequest();
req.setBizId("biz_id");
req.setClassId(4240018L);
req.setName("阳xx");
req.setOperator("user01");
req.setStudentNo("no12");
req.setMobile("152xxxxxxxx")
OapiEduStudentCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

返回示例

{
    "errcode": 0,
    "errmsg":"ok",
    "result": {
        "biz_id": "biz_id",
        "userid": "manager01"
    },
    "success": true,
    "request_id": "5bsof0hsgtds"
}