第三方应用开发 服务端API 家校沟通 基础接口 获取可使用的家长范围
获取可使用的家长范围
最后更新:2023/12/01
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取可使用的家长范围
最后更新:2023/12/01

获取可在微信「学校通知-学校应用」使用该应用的家长范围,以学生或部门列表的形式返回。应用只能给该列表下的家长发送「学校通知」。注意该范围只能由学校的系统管理员在「管理端-家校沟通-配置」配置。

请求方式: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家长可在微信「学校通知-学校应用」使用该应用的部门列表
上一篇
管理「老师可查看班级」模式
下一篇
开始开发