获取可在微信「学校通知-学校应用」使用该应用的家长范围,以学生或部门列表的形式返回。应用只能给该列表下的家长发送「学校通知」。注意该范围只能由学校的系统管理员在「管理端-家校沟通-配置」配置。
请求方式:GET(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
agentid | 是 | 应用id |
权限说明:
调用的应用需要满足如下的权限
应用类型 | 权限要求 | |
---|---|---|
自建应用 | 配置到「 家校沟通- 读取和编辑家校通讯录的应用」或「 家校沟通- 读取家校通讯录的应用」或“家长可使用应用”列表中 | |
代开发应用 | 具有「家校沟通->家校通讯录读取权限”」权限 | 无 |
第三方应用 | 具有 「家校沟通」使用权限 |
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"allow_scope": {
"students": {
"userid": ["student1", "student2"]
},
"departments": {
"partyid": [1, 2]
}
}
}
参数说明:
参数 | 说明 |
---|---|
errcode | 出错返回码,为0表示成功,非0表示调用失败 |
errmsg | 返回码提示语 |
allow_scope | 可在微信「学校通知-学校应用」使用该应用的家长范围 |
allow_scope.students.userid | 家长可在微信「学校通知-学校应用」使用该应用的学生列表 |
allow_scope.departments.partyid | 家长可在微信「学校通知-学校应用」使用该应用的部门列表 |