企业内部开发 服务端API 家校沟通 基础接口 管理「班级群创建方式」
管理「班级群创建方式」
最后更新:2023/11/30
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
管理「班级群创建方式」
最后更新:2023/11/30

目录

  • 获取创建方式
  • 设置创建方式

  • 企业或第三方可通过接口获取或修改家校通讯录配置「班级群创建方式」,目前支持“自动创建”或“手动创建”两种方式。

    获取创建方式

    请求方式:GET(HTTPS)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/get_chat_create_mode?access_token=ACCESS_TOKEN

    参数说明:

    参数必须说明
    access_token调用接口凭证

     

    权限说明:
    调用的应用需要满足如下的权限

    应用类型权限要求
    自建应用配置到「 家校沟通- 读取和编辑家校通讯录的应用」中
    第三方应用需拥有「家校沟通」使用和编辑 权限

    注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok",
        "create_mode": 0
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg错误码描述
    create_mode创建模式
    取值范围:
        0 - 自动创建
        1 - 手动创建

     

    设置创建方式

    请求方式:POST(HTTPS)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/set_chat_create_mode?access_token=ACCESS_TOKEN

    请求示例

    {
        "create_mode": 0
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    create_mode创建模式
    取值范围:
        0 - 自动创建
        1 - 手动创建

     

    权限说明:
    调用的应用需要满足如下的权限

    应用类型权限要求
    自建应用配置到「 家校沟通- 读取和编辑家校通讯录的应用」中
    第三方应用需拥有「家校沟通」使用和编辑 权限

    注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg错误码描述
    上一篇
    发送「学校通知」
    下一篇
    外部联系人openid转换