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

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

 

参数说明:

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

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

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

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

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
    "parents": [
        {
            "parent_userid": "zhangsan_parent",
            "mobile": "18900000000",
            "is_subscribe": 1,
			"external_userid":"xxx",
            "children": [
                {
                    "student_userid": "zhangsan",
                    "relation": "爸爸",
                    "name": "张三"
                }
            ]
        },
		{
            "parent_userid": "lisi_parent",
            "mobile": "18900000001",
            "is_subscribe": 0,
            "children": [
                {
                    "student_userid": "lisi",
                    "relation": "妈妈",
                    "name": "李四"
                }
            ]
        }
    ]
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
parents.parent_userid家长的userid
parents.mobile家长手机号,第三方不可获取;代开发应用需要管理员授权该权限才返回
parents.is_subscribe家长是否关注了“学校通知”,0-未关注,1-已关注
parents.children家长孩子列表
parents.children.student_userid学生的userid
parents.children.relation家长与学生关系
parents.children.name学生姓名
parents.external_userid家长的external_userid,仅当家长已关注才返回。对同一个服务商来说,同一个家长微信在不同学校下返回的家长的external_userid是一样的
上一篇
设置家校通讯录自动同步模式
下一篇
创建部门