第三方应用开发 服务端API 家校沟通 学生与家长管理 获取部门学生详情
获取部门学生详情
最后更新:2023/12/01
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取部门学生详情
最后更新:2023/12/01

请求方式:GET(HTTPS
请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID

参数说明:

参数必须说明
access_token调用接口凭证
department_id获取的部门id
如需获取该部门及其子部门的所有学生,需先获取该部门下的子部门,然后再获取子部门下的学生,逐层递归获取。

 

权限说明:

调用的应用需要满足如下的权限

应用类型权限要求
自建应用配置到「 家校沟通- 读取和编辑家校通讯录的应用」或「 家校沟通- 读取家校通讯录的应用」或“家长可使用应用”列表中
代开发应用具有 「家校沟通」权限
第三方应用具有 「家校沟通」使用权限

注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

返回结果:

{
	"errcode": 0,
	"errmsg": "ok",
	"students":[
		{
			"student_userid": "zhangsan",
			"name": "张三",
			"department": [1, 2],
			"parents": [
				{
					"parent_userid": "zhangsan_parent1",
					"relation": "爸爸",
					"mobile": "18000000001",
					"is_subscribe": 1,
					"external_userid":"xxx"
				},
				{
					"parent_userid": "zhangsan_parent2",
					"relation": "妈妈",
					"mobile": "18000000002",
					"is_subscribe": 0
				}
			]
		},
		{
			"student_userid": "lisi",
			"name": "李四",
			"department": [4, 5],
			"parents": [
				{
					"parent_userid": "lisi_parent1",
					"relation": "爷爷",
					"mobile": "18000000003",
					"is_subscribe": 1,
					"external_userid":"xxx"
				},
				{
					"parent_userid": "lisi_parent2",
					"relation": "妈妈",
					"mobile": "18000000004",
					"is_subscribe": 1,
					"external_userid":"xxx"
				}
			]
		}
	]
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
students学生列表
students.student_userid学生UserID
students.name学生名字
students.department学生所在的班级id列表,不超过20个
students.parents学生家长列表
students.parents.parent_userid家长的userid
students.parents.relation学生与家长的关系
students.parents.mobile家长手机号,第三方不可获取
students.parent.is_subscribe家长是否关注了“学校通知”,0-未关注,1-已关注
students.parent.external_userid家长的external_userid,仅当家长已关注才返回。
上一篇
读取学生或家长
下一篇
设置家校通讯录自动同步模式