主要使用场景:
根据区域编码获取区域信息
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/baseInfo/selectAreaInfo?accessToken=ACCESS_TOKEN |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 否 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
areaCode |
必选 |
Body(json) |
String |
32 |
区域编码,多个区域编码之间使用逗号分开,一次最多查询1000个区域信息 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
必选 |
String |
6 |
返回码 |
2 |
retDesc |
必选 |
String |
100 |
返回码描述 |
3 |
count |
必选 |
String |
8 |
总记录条数 |
4 |
list |
必选 |
JSON对象 |
- |
区域信息数组 |
4.1 |
areaCode |
必选 |
String |
32 |
区域编码 |
4.2 |
areaName |
必选 |
String |
32 |
区域名称 |
4.3 |
parentId |
必选 |
String |
32 |
上级区域编码 |
4.4 |
createTime |
可选 |
date |
- |
创建时间 |
4.5 |
createUser |
可选 |
string |
32 |
创建者 |
4.6 |
note |
可选 |
string |
32 |
备注 |
4.7 |
pkid |
必选 |
string |
32 |
区域id |
4.8 |
showIndex |
必选 |
int |
10 |
显示顺序 |
4.9 |
state |
必选 |
string |
2 |
状态 |
4.10 |
updateTime |
可选 |
date |
- |
更新时间 |
4.11 |
updateUser |
可选 |
string |
32 |
更新作者 |
4.12 |
weather |
可选 |
string |
32 |
天气预报编码 |
请求报文: { "areaCode":"420000" } 返回报文: { "result": "000000", "desc": "success", "count": 2, "list": [ { "areaCode": "420000", "areaName": "湖北省", "createTime": null, "createUser": "", "note": "", "parentId": "0", "pkid": "420000", "showIndex": 908, "state": "0", "updateTime": null, "updateUser": "", "weather": "" }, { "areaCode": "420100", "areaName": "武汉市", "createTime": null, "createUser": "", "note": "", "parentId": "420000", "pkid": "420100", "showIndex": 2829, "state": "0", "updateTime": null, "updateUser": "", "weather": "" } ] }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
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 |
消息体的关键字对应的值 |