批量创建学生

POST

http://127.0.0.1/cgi-bin/school/user/batch_create_student

第三方应用开发/家校沟通/学生与家长管理

最后修改时间：2022-08-30 03:03:36

责任人：未设置

当参数字段超过长度限制，那么整个请求会被拦掉。

注意，每个班级下学生总数不能超过3万个。建议保证创建department对应的部门和创建成员是串行化处理。

权限说明：学校需要使用“家校沟通”secret所获取的accesstoken来调用（accesstoken如何获取？）；第三方应用需拥有「家校沟通」使用和编辑权限。

文档ID: 18904
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/92037
https://open.work.weixin.qq.com/api/doc/90000/90135/92328

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

students

array [object {3}]

必需

学生列表，每次最多100个学生

student_userid

string

必需

学生UserID。学校内必须唯一。不区分大小写，长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。

name

string

必需

学生姓名，长度为1~32个字符

department

array[integer <int32>]

必需

示例

{
  "students": [
    {
      "student_userid": "zhangsan",
      "name": "张三",
      "department": [
        1,
        2
      ]
    },
    {
      "student_userid": "lisi",
      "name": "李四",
      "department": [
        3,
        4
      ]
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://127.0.0.1/cgi-bin/school/user/batch_create_student?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "students": [
        {
            "student_userid": "zhangsan",
            "name": "张三",
            "department": [
                1,
                2
            ]
        },
        {
            "student_userid": "lisi",
            "name": "李四",
            "department": [
                3,
                4
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

可选

对返回码的文本描述内容

result_list

array [object {3}]

失败的学生列表

可选

errcode

integer <int32>

返回码

可选

student_userid

string

可选

失败的学生userid

errmsg

string

可选

对返回码的文本描述内容

示例

{
  "errcode": 0,
  "errmsg": "string",
  "result_list": [
    {
      "errcode": 0,
      "student_userid": "string",
      "errmsg": "string"
    }
  ]
}

更新学生

批量删除学生