主要使用场景:
根据机构Id获取下级机构和学校的列表信息
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/baseInfo/org/getOrgList?accessToken=ACCESS_TOKEN |
请求方式 | POST |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
orgId |
必选 |
Body(json) |
string |
- |
机构Id |
2 |
type |
必选 |
Body(json) |
string |
- |
机构类型;0-全部;1-学校;2-机构 |
3 |
start |
必选 |
Body(json) |
string |
- |
获取开始记录下标,从1开始 |
4 |
end |
必选 |
Body(json) |
string |
- |
获取结束记录下标 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
可选 |
string |
- |
返回码 |
2 |
retDesc |
可选 |
string |
- |
返回码描述 |
3 |
orgList |
可选 |
list |
- |
机构信息列表 |
3.1 |
orgId |
可选 |
string |
- |
机构Id |
3.2 |
orgName |
可选 |
string |
- |
机构名称 |
3.3 |
provinceCode |
可选 |
string |
- |
所属省份 |
3.4 |
cityCode |
可选 |
string |
- |
所属城市 |
3.5 |
areaCode |
可选 |
string |
- |
所属区县 |
3.6 |
orgCage |
可选 |
string |
- |
机构类别 0:小学,小学一年级到六年级 1:初中,初中一年级到初中三年级 2:高中,高中一年级到高中三年级 3:完中,初中一年级到高中三年级 4:机构,电教馆或教育局 5:教学点,小学一年级到六年级 6:九年一贯制,小学一年级到初中三年级 7:十二年一贯制,小学一年级到高中三年级 8:高等教育 9:其他教育类学校 10:中职 11:高职 12: 学前教育 |
3.7 |
orgCode |
可选 |
string |
- |
机构唯一代码 |
4 |
start |
可选 |
Integer |
- |
获取开始位置,从1开始 |
5 |
count |
可选 |
Integer |
- |
总记录条数 |
6 |
end |
可选 |
Integer |
- |
获取结束位置 |
请求报文: { "orgId":"0D4A8B0807BDBDA1E050A8C033C83692", "type":"1", "start":"1", "end":"2" } 应答报文: { "retCode": "000000", "start": 1, "end": 2, "count": 24, "retDesc": "success", "orgList": [ { "areaCode": "310100", "cityCode": "310100", "orgCage": "0", "orgCode": "9caa187c84f04c8db50f7123c5408eb6", "orgId": "0d38c686eebd46fa9c1ff02d3f7139fb", "orgName": "test8900", "provinceCode": "310000" } ] }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:link |
2 |
link |
必选 |
Json |
- |
link消息体 |
2.1 |
pcUrl |
必选 |
String |
PC端消息点击链接地址 |
|
2.2 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
2.3 |
title |
必选 |
String |
消息标题 |
|
2.4 |
busiId |
必选 |
String |
对应业务的id |
|
2.5 |
content |
必选 |
String |
消息描述 |
|
2.6 |
picUrl |
必选 |
String |
图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图640*320,小图80*80。如不填,在客户端不显示图片 |
{ "msgtype": "link", "link": { "pcUrl": "http://www.baidu.com", "appUrl": "http://www.baidu.com", "picUrl": "http://xxx.yyy.com/zzz.jpg", "content": "百度一下", "title": "百度", "busiId":"AQWER1234" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:oa |
2 |
busiId |
必选 |
String |
- |
该条oa消息在业务系统对应的id |
3 |
pcUrl |
必选 |
String |
消息点击链接地址 |
|
4 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
5 |
oa |
必选 |
Json |
- |
oa类型消息体 |
5.1 |
head |
必选 |
Json |
255 |
消息头部Json |
5.1.1 |
text |
必选 |
String |
255 |
消息的头部标题 |
5.1.2 |
bgColor |
可选 |
String |
消息头部的背景颜色。长度限制为8个英文字符,其中前2为表示透明度,后6位表示颜色值。不要添加0x。默认值:FFCC0000 |
|
5.2 |
body |
可选 |
Json |
消息体 |
|
5.2.1 |
title |
可选 |
String |
消息体的标题 |
|
5.2.2 |
content |
可选 |
String |
消息体的正文 |
|
5.2.3 |
imageUrl |
可选 |
String |
消息体中的图片url |
|
5.2.4 |
fileCount |
可选 |
String |
自定义的附件数目。此数字仅供显示,不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单,最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |