登录
基础
连接微信
办公请求方式：GET（HTTPS）
请求地址：https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID
参数说明：
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
| userid | 是 | 家校通讯录的userid，家长或者学生的userid。不区分大小写，长度为1~64个字节 |
权限说明：
调用的应用需要满足如下的权限
| 应用类型 | 权限要求 |
|---|---|
| 自建应用 | 配置到「 家校沟通- 读取和编辑家校通讯录的应用」或「 家校沟通- 读取家校通讯录的应用」或“家长可使用应用”列表中 |
| 代开发应用 | 具有 「家校沟通」权限 |
| 第三方应用 | 具有 「家校沟通」使用权限 |
注： 从2023年12月1日0点起，不再支持通过系统应用secret调用接口，存量企业暂不受影响 查看详情
返回结果：
{
"errcode": 0,
"errmsg": "ok",
"user_type": 1,
"student":{
"student_userid": "zhangsan",
"name": "张三",
"department": [1, 2],
"parents":[
{
"parent_userid": "zhangsan_parent1",
"relation": "爸爸",
"mobile":"18000000000",
"is_subscribe": 1,
"external_userid":"xxxxx"
},
{
"parent_userid": "zhangsan_parent2",
"relation": "妈妈",
"mobile": "18000000001",
"is_subscribe": 0
}
]
},
"parent":{
"parent_userid": "zhangsan_parent2",
"mobile": "18000000003",
"is_subscribe": 1,
"external_userid":"xxxxx",
"children":[
{
"student_userid": "zhangsan",
"relation": "妈妈"
},
{
"student_userid": "lisi",
"relation": "伯母"
}
]
}
}参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| user_type | 用户类型:1表示学生，2表示家长 |
| student | 学生字段，user_type为1时返回该字段 |
| student.student_userid | 学生UserID |
| student.name | 学生名字 |
| student.department | 学生所在的班级id列表,不超过20个 |
| student.parents | 学生家长列表 |
| student.parents.parent_userid | 家长的userid |
| student.parents.relation | 与家长的关系 |
| student.parents.mobile | 家长手机号，第三方不可获取；代开发自建应用需管理员授权手机号才返回 |
| student.parents.external_userid | 家长的external_userid,仅当家长已关注才返回。对同一个服务商来说，同一个家长微信在不同学校下返回的家长的external_userid是一样的 |
| parent | 学生家长，user_type为2时返回该字段 |
| parent.parent_userid | 家长的userid |
| parents.relation | 学生与家长的关系 |
| parent.mobile | 家长手机号，第三方不可获取；代开发自建应用需管理员授权手机号才返回 |
| parent.is_subscribe | 家长是否关注了“学校通知”，0-未关注，1-已关注 |
| parent.external_userid | 家长的external_userid,仅当家长已关注才返回。对同一个服务商来说，同一个家长微信在不同学校下返回的家长的external_userid是一样的 |
| parent.children | 家长孩子列表 |
| parent.children.student_userid | 学生的userid |
| parent.children.relation | 家长与孩子关系 |
基础连接微信办公基础连接微信办公基础连接微信办公