主要使用場景:系統(tǒng)字典類
獲取區(qū)域信息
獲取接口訪問憑證:accessToken
url | https://api.tze.cn/user/openapi/area/get-area-info?area_code=410000&accessToken={{accessToken}} |
請(qǐng)求方式 | get |
是否需要鑒權(quán) | 是 |
請(qǐng)求數(shù)限制 | 否 |
接口方向 | 第三方應(yīng)用->開放平臺(tái) |
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
area_code |
必選 |
string |
區(qū)域編碼,多個(gè)使用英文逗號(hào),分隔;多個(gè)時(shí)返回的結(jié)構(gòu)體不同,請(qǐng)注意 |
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
code |
必選 |
string |
結(jié)果編碼 | |
2 |
message |
必選 |
string |
結(jié)果描述 | |
3 |
result |
必選 |
json |
json對(duì)象 | |
3.1 |
area_code |
必選 |
string |
區(qū)域編碼 | |
3.2 |
area_name |
必選 |
string |
區(qū)域名稱 | |
3.3 |
area_level |
必選 |
int |
區(qū)域等級(jí) 省:1 市:2 區(qū):3 | |
3.4 |
area_order |
必選 |
int |
區(qū)域排序 | |
3.5 |
parent_code |
必選 |
string |
父級(jí)區(qū)域編號(hào) |
請(qǐng)求示例 http://api.tze.cn/user/openapi/area/get-area-info?area_code=410000&accessToken={{accessToken}} 返回示例1 { "code": "000000", "message": "請(qǐng)求成功", "result": { "area_code": "410000", "area_name": "河南省", "area_level": "1", "area_order": "849", "parent_code": "0" } } 返回示例2 { "code": "000000", "message": "請(qǐng)求成功", "result": { "420000": { "area_code": "420000", "area_name": "湖北省", "area_level": "1", "area_order": "908", "parent_code": "0" }, "420100": { "area_code": "420100", "area_name": "武漢市", "area_level": "2", "area_order": "2829", "parent_code": "420000" } } }
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:text |
1.1 |
text |
必選 |
Json |
- |
text消息體 |
1.1.1 |
content |
必選 |
String |
消息內(nèi)容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:link |
2 |
link |
必選 |
Json |
- |
link消息體 |
2.1 |
pcUrl |
必選 |
String |
PC端消息點(diǎn)擊鏈接地址 |
|
2.2 |
appUrl |
必選 |
String |
移動(dòng)客戶端點(diǎn)擊消息時(shí)跳轉(zhuǎn)到的H5地址 |
|
2.3 |
title |
必選 |
String |
消息標(biāo)題 |
|
2.4 |
busiId |
必選 |
String |
對(duì)應(yīng)業(yè)務(wù)的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" } }
序號(hào) | 字段名 | 約束 | 類型 | 長度 | 說明 |
---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型,此時(shí)固定為:oa |
2 |
busiId |
必選 |
String |
- |
該條oa消息在業(yè)務(wù)系統(tǒng)對(duì)應(yīng)的id |
3 |
pcUrl |
必選 |
String |
消息點(diǎn)擊鏈接地址 |
|
4 |
appUrl |
必選 |
String |
移動(dòng)客戶端點(diǎn)擊消息時(shí)跳轉(zhuǎn)到的H5地址 |
|
5 |
oa |
必選 |
Json |
- |
oa類型消息體 |
5.1 |
head |
必選 |
Json |
255 |
消息頭部Json |
5.1.1 |
text |
必選 |
String |
255 |
消息的頭部標(biāo)題 |
5.1.2 |
bgColor |
可選 |
String |
消息頭部的背景顏色。長度限制為8個(gè)英文字符,其中前2為表示透明度,后6位表示顏色值。不要添加0x。默認(rèn)值:FFCC0000 |
|
5.2 |
body |
可選 |
Json |
消息體 |
|
5.2.1 |
title |
可選 |
String |
消息體的標(biāo)題 |
|
5.2.2 |
content |
可選 |
String |
消息體的正文 |
|
5.2.3 |
imageUrl |
可選 |
String |
消息體中的圖片url |
|
5.2.4 |
fileCount |
可選 |
String |
自定義的附件數(shù)目。此數(shù)字僅供顯示,不作驗(yàn)證 |
|
5.2.5 |
author |
可選 |
String |
自定義的作者名字 |
|
5.2.6 |
form |
可選 |
Json數(shù)組 |
消息體的表單,最多6個(gè) |
|
5.2.7 |
key |
可選 |
String |
消息體的關(guān)鍵字 |
|
5.2.8 |
value |
可選 |
String |
消息體的關(guān)鍵字對(duì)應(yīng)的值 |