获取部门成员详情

GET

/cgi-bin/school/user/list

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

权限说明：

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

第三方应用需拥有「家校沟通」使用权限。

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

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

请求参数

Query 参数

department_id

获取的部门id

必需

示例值:

fetch_child

可选

1/0：是否递归获取子部门下面的成员

示例值:

access_token

调用接口凭证

必需

示例值:

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

可选

对返回码的文本描述内容

students

array [object {4}]

学生列表

可选

student_userid

string

学生UserID

可选

name

string

学生名字

可选

department

array[integer <int32>]

可选

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

parents

array [object {5}]

学生家长列表

可选

修改于 2022-12-07 03:07:11

读取学生或家长

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