主要使用场景:
根据id获取机构或学校的基本表信息。
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/baseInfo/org/getOrgInfo?accessToken=ACCESS_TOKEN |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
orgId |
必选 |
Body(json) |
String |
64.0 |
机构id |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
必选 |
String |
6.0 |
返回码 |
2 |
retDesc |
可选 |
String |
100.0 |
返回码描述 |
3 |
orgInfo |
可选 |
Json对象 |
- |
机构信息对象 |
3.1 |
createTime |
可选 |
String |
32.0 |
创建时间 |
3.2 |
orgCode |
可选 |
String |
64.0 |
机构代码 |
3.3 |
orgId |
可选 |
String |
64.0 |
机构Id |
3.4 |
orgPic |
可选 |
String |
512.0 |
机构图片 |
3.5 |
orgName |
可选 |
String |
300.0 |
机构名称 |
3.6 |
orgCage |
可选 |
String |
2.0 |
机构属性:机构类别 0:小学 1:初中 2:高中 3:完中 4:机构 5:教学点 6:九年一贯制 7: 十二年一贯制 |
3.7 |
provinceCode |
可选 |
String |
10.0 |
省编码 |
3.8 |
cityCode |
可选 |
String |
10.0 |
市编码 |
3.9 |
areaCode |
可选 |
String |
10.0 |
区编码 |
3.10 |
orgType |
可选 |
String |
2.0 |
机构类型: 1:国家 2:区域 3:市 4:区 |
请求报文: { "orgId": "AF5C6A7A49124B20B8A******" } 应答报文: { "retCode": "000000", "retDesc": "success", "orgInfo": { "areaCode": "420100", "cityCode": "420112", "createTime": "2013-09-29 15:19:09", "orgCage": "0", "orgCode": "F6C68AAFA3BA437CE040007F01001D3D", "orgId": "F6C68AAFA3B9437CE040007F01001D3D", "orgName": "凌云小学", "orgPic": "/uploads/avatar/data/F6C68AAFA3B9437CE040007F01001D3D_180x180.jpg", "orgType": "3", "provinceCode": "420000" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
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 |
消息体的关键字对应的值 |