获取可使用的家长范围

GET

/cgi-bin/school/agent/get_allow_scope

服务端API第三方应用开发企业内部开发

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

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

文档ID: 32243
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/94895
https://open.work.weixin.qq.com/api/doc/90001/90143/94960

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

{
  "errcode": 0,
  "errmsg": "ok",
  "allow_scope": {
    "students": [
      {
        "userid": "student1"
      },
      {
        "userid": "student2"
      }
    ],
    "departments": [
      1,
      2
    ]
  }
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

agentid

应用id

必需

示例值:

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

可选

出错返回码，为0表示成功，非0表示调用失败

allow_scope

object

可选

可在微信「学校通知-学校应用」使用该应用的家长范围

students

array [object {1}]

可选

家长可在微信「学校通知-学校应用」使用该应用的学生列表

departments

array[integer <int32>]

可选

家长可在微信「学校通知-学校应用」使用该应用的部门列表

errmsg

string

返回码提示语

可选

修改于 2022-12-02 02:26:47

外部联系人openid转换

开始开发