创建学生

POST

/cgi-bin/school/user/create_student

服务端API第三方应用开发企业内部开发

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

权限说明：

学校需要使用“家校沟通”secret所获取的accesstoken来调用（accesstoken如何获取？

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/school/user/create_student?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
	"student_userid": "zhangsan",
	"mobile": "10000000000",
	"to_invite": false,
	"name": "张三",
	"department": [1, 2]
}'

响应示例

{
  "errcode": 0,
  "errmsg": "created"
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

student_userid

string

必需

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

name

string

必需

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

to_invite

string

可选

是否发起邀请，默认为true，仅验证的学校才能发起邀请。

mobile

string

学生手机号

可选

department

array[integer <int32>]

必需

学生所在的班级id列表,不超过20个

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

可选

对返回码的文本描述内容

修改于 2022-12-07 02:40:44

获取访问用户身份

删除学生