获取部门家长详情

GET

/cgi-bin/school/user/list_parent

服务端API企业内部开发

如需获取该部门及其子部门的所有家长，需先获取该部门下的子部门，然后再获取子部门下的家长，逐层递归获取。

学校需要使用“家校沟通”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
第三方应用需拥有「家校沟通」使用权限。

文档ID: 19870
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/92446

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token={{access_token}}&department_id={{department_id}}'

响应示例

{
  "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": "李四"
        }
      ]
    }
  ]
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

department_id

获取的部门id

必需

示例值:

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

可选

对返回码的文本描述内容

parents

array [object {4}]

可选

parent_userid

string

家长的userid

可选

children

array [object {3}]

家长孩子列表

可选

mobile

string

可选

家长手机号，第三方不可获取;代开发应用需要管理员授权该权限才返回

is_subscribe

integer <int32>

可选

家长是否关注了“学校通知”，0-未关注，1-已关注

修改于 2022-12-02 03:00:30

设置家校通讯录自动同步模式

标准年级对照表