查询学校信息
使用场景: 查询学校详细信息
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 租户管理员角色 + 机构管理员角色 |
机构凭证 | 支持 | - |
请求方式:[GET, POST] (HTTPS)
请求地址:https://oapi.epaas.qq.com/school/get?access_token=ACCESS_TOKEN
请求包体:
{
"corpid": 123,
"need_qywx_corpid": true,
"extend_fields": ["FieldA","FieldB"]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
corpid | 否 | 机构ID,机构管理员或者机构票据请求时从票据信息中取机构Id |
need_qywx_corpid | 否 | 是否返回企业微信ID,默认否 |
extend_fields | 否 | 应用托管资料字段 |
返回结果:
{
"errcode": 0,
"errmsg": "",
"corpid": 123,
"name": "腾讯",
"full_name": "测试的学校全称aaa",
"code": "机构编码",
"address": {
"country_id": 1,
"province_id": 10,
"province_name": "湖南省",
"city_id": 10,
"city_name": "长沙市",
"area_id": 10,
"area_name": "岳麓区",
"detail_address": "",
"province_code": 123,
"city_code": 123,
"area_code": 123
},
"use_type": 1,
"school_type": 1,
"manage_style": 1,
"school_categories": "1,2,3",
"qywx_corpid": "xxxxxxxxxx",
"creator_info": {
"name": "xx",
"duty": "校长",
"mobile": "18692234433",
"email": "xxx@tencent.com"
},
"extend_profile": "{\"FieldA\": 01,\"FieldB\": 02}",
"start_date": "2020-01-01",
"end_date": "2020-01-01",
"created_at": "2020-01-01 01:01:01",
"updated_at": "2020-01-01 01:01:01",
"logo":""
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
corpid | 机构ID |
name | 机构名字 |
full_name | 机构全称 |
code | 机构编码 |
address.country_id | 国家ID |
address.province_id | 省份ID |
address.province_name | 省份名字 |
address.city_id | 城市ID |
address.city_name | 城市名字 |
address.area_id | 区/县ID |
address.area_name | 地区名字 |
address.detail_address | 机构详细地址 |
address.province_code | 省份行政区代码,参数值通过接口《批量查询地区详情》 查询 |
address.city_code | 市行政区代码,参数值通过接口《批量查询地区详情》 查询 |
address.area_code | 区县行政区代码,参数值通过接口《批量查询地区详情》 查询 |
use_type | 使用类型 1 正式,2 试用,3测试 |
school_type | 1 公办 2 民办 |
manage_style | 数据管理方式 2 企业微信管理(企业微信同步给教育号),5 教育号后台管理(教育号同步给企业微信),3 双写(默认值),100 新双向同步,110 1:N根节点,111 1:N子节点 |
school_categories | 学校类型,参数值含义参考《学校类型对照表》,逗号分隔 |
qywx_corpid | 企业微信ID |
creator_info.name | 创建人 |
creator_info.duty | 创建人职务 |
creator_info.mobile | 创建人联系电话 |
creator_info.email | 创建人邮箱 |
extend_profile | 应用托管资料 |
start_date | 开始使用时间 |
end_date | 服务到期时间 |
created_at | 创建时间 |
updated_at | 更新时间 |
logo | logo |
批量查询学校信息
使用场景: 批量查询学校详细信息
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 学校,教育局或租户票据,必须是管理员角色 |
机构凭证 | 未支持 | - |
请求方式:[POST] (HTTPS)
请求地址:https://oapi.epaas.qq.com/school/batch_get?access_token=ACCESS_TOKEN
请求包体:
{
"corpids": [1,2],
"need_app_status": true,
"need_qywx_corpid": true,
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
corpids | 是 | 机构ID列表 |
need_app_status | 否 | 是否返回app授权状态,默认否 |
need_qywx_corpid | 否 | 是否返回企业微信ID,默认否 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"data_list": [
{
"corpid": 1217416,
"name": "jimmy测试sssss",
"code": "sdfsfsf",
"address": {
"country_id": 312829,
"province_id": 1,
"province_name": "北京市",
"city_id": 3118,
"city_name": "北京市",
"area_id": 102,
"area_name": "西城区",
"detail_address": "sdfsf",
"province_code": 123,
"city_code": 123,
"area_code": 123
},
"use_type": 1,
"school_type": 2,
"start_date": "2022-02-17",
"end_date": "2024-02-29",
"manage_style": 100,
"school_categories": "6",
"qywx_corpid": "",
"creator_info": {
"name": "jimmy",
"email": "",
"duty": "sdfsfa",
"mobile": "17311112222"
},
"created_at": "2022-02-17 15:55:39",
"updated_at": "2022-02-17 15:55:39",
"extend_profile": "",
"corp_inner_secret": "",
"corp_secret": "",
"inner_sync_mode": 2,
"external_sync_mode": 2,
"inner_sync_type": 2,
"external_sync_type": 2,
"full_name": "",
"logo":""
}
]
}
参数说明:
参数 | 说明 |
---|---|
data_list | 学校列表 |
corpid | 机构ID |
name | 机构名字 |
full_name | 机构全称 |
code | 机构编码 |
address.country_id | 国家ID |
address.province_id | 省份ID |
address.province_name | 省份名字 |
address.city_id | 城市ID |
address.city_name | 城市名字 |
address.area_id | 区/县ID |
address.area_name | 地区名字 |
address.detail_address | 机构详细地址 |
address.province_code | 省份行政区代码,参数值通过接口《批量查询地区详情》 查询 |
address.city_code | 市行政区代码,参数值通过接口《批量查询地区详情》 查询 |
address.area_code | 区县行政区代码,参数值通过接口《批量查询地区详情》 查询 |
use_type | 使用类型 1 正式,2 试用,3测试 |
school_type | 1 公办 2 民办 |
start_date | 开始使用时间 |
end_date | 服务到期时间 |
manage_style | 数据管理方式 2 企业微信管理(企业微信同步给教育号),5 教育号后台管理(教育号同步给企业微信),3 双写(默认值),100 新双向同步,110 1:N根节点,111 1:N子节点 |
school_categories | 学校类型,参数值含义参考《学校类型对照表》,逗号分隔 |
qywx_corpid | 企业微信ID |
creator_info.name | 创建人 |
creator_info.duty | 创建人职务 |
creator_info.mobile | 创建人联系电话 |
creator_info.email | 创建人邮箱 |
extend_profile | 应用托管资料 |
created_at | 创建时间 |
updated_at | 更新时间 |
corp_inner_secret | 内部通讯录获取token的秘钥 |
corp_secret | 家校通讯录获取token的秘钥 |
inner_sync_mode | 内部通讯录同步模式 1: Corpid + CorpInnerSecret, 2:内部通讯录(默认2) |
external_sync_mode | 家校通讯录同步模式 1:Corpid + CorpExternalSecret, 2:家校通讯录 (默认2) |
inner_sync_type | 内部通讯录的同步类型 0不同步 1双向 2正向 3反向 |
external_sync_type | 家校通讯录同步类型 0不同步 1双向 2正向 3反向 |
logo | logo |
查询学校列表
使用场景: 查询学校详细列表
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
应用凭证 | 支持 | - |
用户凭证 | 支持 | 租户管理员角色 + 机构管理员角色 |
机构凭证 | 不支持 | - |
请求方式:[GET] (HTTPS)
请求地址:https://oapi.epaas.qq.com/corp/school/list_by_suite?access_token=ACCESS_TOKEN
参数说明:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
name | string | 否 | 学校名称 |
is_name_fuzzy | bool | 否 | 是否名称模糊搜索 |
need_superior | bool | 否 | 是否返回上级单位 |
need_qywx_corpid | bool | 否 | 是否返回企业微信id |
school_property | string | 否 | 学校类型,支持多个学校类型查询 逗号","分割,参数值含义参考《学校类型对照表》 |
school_type | int | 否 | 1 公办 2 民办 |
province_id | int | 否 | 省id |
city_id | int | 否 | 市id |
area_id | int | 否 | 区县id |
page_index | int | 否 | 第几页,默认:1 |
page_size | int | 否 | 每页数量,默认:10 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"data_list": [
{
"corpid": 1501549,
"name": "test",
"address": {
"location": "",
"country_id": 0,
"province_id": 22,
"province_name": "湖南省",
"city_id": 2201,
"city_name": "长沙市",
"area_id": 220100,
"area_name": "岳麓区",
"detail_address": ""
},
"qywx_corpid": "",
"superior_corpid": 0,
"superior_name": "",
"school_property": "13",
"code": "52008935",
"user_scale": 1,
"school_type": 2
}
],
"total": 1
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
total | 总数 |
data_list.corpid | 机构ID |
data_list.name | 机构名称 |
data_list.address.country_id | 国家ID |
data_list.address.province_id | 省份ID |
data_list.address.province_name | 省份名字 |
data_list.address.city_id | 城市ID |
data_list.address.city_name | 城市名字 |
data_list.address.area_id | 区/县ID |
data_list.address.area_name | 地区名字 |
data_list.address.detail_address | 机构详细地址 |
data_list.qywx_corpid | 企业微信id |
data_list.superior_corpid | 上级单位id |
data_list.superior_name | 上级单位名称 |
data_list.school_property | 学校类型,参数值含义参考《学校类型对照表》 |
data_list.code | 机构代码 |
data_list.user_scale | 人数规模 0:不限制 1:1-300 2:301~1000 3:1001~3000 4:3001~5000 5:5001以上 |
data_list.school_type | 1 公办 2 民办 |
扩展资料检索学校
使用场景: 扩展资料检索学校列表
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:[POST] (HTTPS)
请求地址:https://oapi.epaas.qq.com/school/profile/search?access_token=ACCESS_TOKEN
请求包体:
{
"search_keys": [
{
"key": "search_key1",
"value": "xxxxxx"
}
],
"page_index": 1,
"page_size": 10
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
search_keys | 是 | 搜索关键字列表 |
search_keys.key | 是 | 关键字名 |
search_keys.value | 是 | 搜索值 |
page_index | 是 | 分页参数、页数 |
page_size | 是 | 分页参数、单页大小 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"data_list": [
{
"corpid": "111",
"name": "机构名"
}
],
"total": 1
}
参数说明:
参数 | 说明 |
---|---|
data_list | 学校列表 |
data_list.corpid | 机构ID |
data_list.name | 机构名字 |
total | 结果总数 |
创建学校
使用场景: 创建学校
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://oapi.epaas.qq.com/school/create?access_token=ACCESS_TOKEN
{
"name": "腾讯",
"full_name": "腾讯学校全称",
"code": "xxxx",
"address": {
"country_id": 312829,
"province_id": 1,
"city_id": 3118,
"area_id": 311413,
"detail_address": "湖南省长沙市岳麓区梅西湖路"
},
"use_type": 1,
"school_type": 1,
"creator_info": {
"name": "腾讯",
"email": "xxx@tencent.com",
"duty": "校长",
"mobile": "18692234433"
},
"manage_style": 3,
"school_categories": "1,2,3",
"qywx_corpid": "xxxxxxxxxx",
"extend_profile": "{\"FieldA\": 1,\"FieldB\": 2,\"FieldC\": 99}"
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
name | 是 | 机构名字 |
full_name | 否 | 机构全称 |
code | 是 | 机构编码 |
address.country_id | 是 | 国家ID |
address.province_id | 是 | 省份ID |
address.city_id | 是 | 城市ID |
address.area_id | 是 | 区/县Id |
address.detail_address | 是 | 机构详细地址 |
school_categories | 是 | 学校类型,参数值含义参考《学校类型对照表》,逗号分隔 |
use_type | 否 | 使用类型 1 正式,2 试用,3测试; 默认正式 |
school_type | 否 | 1 公办 2 民办;默认公办 |
creator_info.name | 是 | 联系人名字 |
creator_info.mobile | 是 | 创建人联系电话 |
creator_info.duty | 否 | 创建人职务 |
creator_info.email | 否 | 创建人邮箱 |
manage_style | 否 | 数据管理方式 2 企业微信管理(企业微信同步给教育号),5 教育号后台管理(教育号同步给企业微信),3 双写(默认值),100 新双向同步,110 1:N根节点,111 1:N子节点 |
qywx_corpid | 否 | 企业微信ID,不传为简洁版 |
extend_profile | 否 | 应用托管资料 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"corpid": 1
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
corpid | 机构ID |
更新学校信息
使用场景: 更新学校信息
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://oapi.epaas.qq.com/school/update?access_token=ACCESS_TOKEN
{
"corpid": 1,
"name": "腾讯",
"full_name": "腾讯学校全称",
"code": "xxxx",
"address": {
"country_id": 312829,
"province_id": 1,
"city_id": 3118,
"area_id": 311413,
"detail_address": "湖南省长沙市岳麓区梅西湖路"
},
"school_type": 1,
"creator_info": {
"name": "腾讯",
"email": "xxx@tencent.com",
"duty": "校长",
"mobile": "18692234433"
},
"school_categories": "1,2,3",
"extend_profile": "{\"FieldA\": 01,\"FieldB\": 02,\"FieldC\": 99}"
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
corpid | 是 | 机构ID |
name | 否 | 机构名字 |
full_name | 否 | 机构全称 |
code | 否 | 机构编码 |
address.country_id | 否 | 国家ID |
address.province_id | 否 | 省份ID |
address.city_id | 否 | 城市ID |
address.area_id | 否 | 区/县ID |
address.detail_address | 否 | 机构详细地址 |
school_type | 否 | 1 公办 2 民办 |
creator_info.name | 否 | 联系人名字 |
creator_info.email | 否 | 创建人邮箱 |
creator_info.duty | 否 | 创建人职务 |
creator_info.mobile | 否 | 创建人联系电话 |
school_categories | 否 | 学校类型,参数值含义参考《学校类型对照表》,逗号分隔 |
extend_profile | 否 | 应用托管资料 |
返回结果:
{
"errmsg": "ok",
"errcode": 0
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
删除学校(暂不支持)
使用场景: 删除学校
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 | - |
请求方式:POST (HTTPS)
请求地址:https://oapi.epaas.qq.com/school/delete?access_token=ACCESS_TOKEN
请求包体:
{
"corpid": 3
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
corpid | 否 | 机构ID |
返回结果:
{
"errcode": 0,
"errmsg": ""
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |