主要使用場景：主要開放了教學資源編目的基礎(chǔ)信息API
根據(jù)教材數(shù)據(jù)關(guān)聯(lián)查詢冊別信息。
獲取接口訪問憑證：accessToken
| url | https://api.tze.cn/rescBase/queryVolumes?accessToken=ACCESS_TOKEN |
| 請求方式 | post |
| 是否需要鑒權(quán) | 是 |
| 請求數(shù)限制 | 是 |
| 接口方向 | 第三方應(yīng)用->開放平臺 |
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
periodId |
可選 |
String |
64 |
學段ID |
2 |
subjectId |
可選 |
String |
64 |
學科ID |
3 |
editionId |
可選 |
String |
64 |
教材版本ID |
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
retCode |
必選 |
String |
6 |
返回碼 |
2 |
retDesc |
必選 |
String |
100 |
返回碼描述 |
3 |
volumeList |
必選 |
Json對象 |
- |
版本列表 |
3.1 |
volumeId |
可選 |
String |
- |
版本ID |
3.2 |
volumeName |
可選 |
String |
- |
版本名稱 |
3.3 |
sortNum |
可選 |
Int |
- |
排序字段 |
請求報文：
{
"periodId": "PERL******",
"subjectId": "SUBL******",
"editionId": "XCDD******"
}
應(yīng)答報文：
{
"retCode": "000000",
"retDesc": "success",
"volumeList": [
{
"volumeId": "VOL0002",
"volumeName": "第二冊"
},
{
"volumeId": "VOL0004",
"volumeName": "選修一"
}
]
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型，此時固定為：text |
1.1 |
text |
必選 |
Json |
- |
text消息體 |
1.1.1 |
content |
必選 |
String |
消息內(nèi)容 |
{
"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 |
移動客戶端點擊消息時跳轉(zhuǎn)到的H5地址 |
|
2.3 |
title |
必選 |
String |
消息標題 |
|
2.4 |
busiId |
必選 |
String |
對應(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"
}
}
| 序號 | 字段名 | 約束 | 類型 | 長度 | 說明 |
|---|---|---|---|---|---|
1 |
msgType |
必選 |
String |
10 |
消息類型，此時固定為：oa |
2 |
busiId |
必選 |
String |
- |
該條oa消息在業(yè)務(wù)系統(tǒng)對應(yīng)的id |
3 |
pcUrl |
必選 |
String |
消息點擊鏈接地址 |
|
4 |
appUrl |
必選 |
String |
移動客戶端點擊消息時跳轉(zhuǎn)到的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 |
自定義的附件數(shù)目。此數(shù)字僅供顯示，不作驗證 |
|
5.2.5 |
author |
可選 |
String |
自定義的作者名字 |
|
5.2.6 |
form |
可選 |
Json數(shù)組 |
消息體的表單，最多6個 |
|
5.2.7 |
key |
可選 |
String |
消息體的關(guān)鍵字 |
|
5.2.8 |
value |
可選 |
String |
消息體的關(guān)鍵字對應(yīng)的值 |