This will delete the page "BI訊息發送". Please be certain.
BI訊息發送
Jeff edited this page 1 month ago
目录
取得學區
- URL：{POST} https://{Domain}/notice/get-areas
| Parameter | Type | Required | Info |
|---|---|---|---|
| areaId | string | 非必須 | 學區ID |
| showList | bool | 非必須 | 是否顯示學校列表 |
| hasMail | bool | 非必須 | 是否取得對象的TMID有Email 預設為false |
- 返回：
{
"state": 200,
"areaInfos": [
{
"id": "02944f32-f534-3397-ea56-e6f1fc6c3714", //學區ID
"name": "醍摩豆智慧学区", //學區名稱
"scCnt": 10, //學校數
"tchCnt": 25, //老師數
"lists": [ //學校列表 ※showList=false時為空
{
"id": "habook", //學校ID
"name": "玉山學校", //學校名稱
"tchCnt": 1 //老師數
}
]
}
]
}
取得地理資訊
- URL：{POST} https://{Domain}/notice/get-geos
| Parameter | Type | Required | Info |
|---|---|---|---|
| countryId | string | 必須 | 國ID |
| provinceId | string | 非必須 | 省ID |
| cityId | string | 非必須 | 市ID |
| showList | bool | 非必須 | 是否顯示列表(lists欄位)資料 預設為false |
| type | string | 非必須 | 類型 tmid、school 預設為"school" |
| hasMail | bool | 非必須 | 是否取得對象的TMID有Email 預設為false |
- 返回：
{
"state": 200,
"dataType": "city", //目前顯示的資料類型 province:省 city:市 school:學校
"data": [
{
"id": "511600", //省市ID 或 學校ID
"name": "广安市", //地理位置名稱 或 學校名稱
"scCnt": 172, //所屬學校數
"tchCnt": 9399, //所屬老師數
"lists": [ //學校列表或TMID列表 ※showList = false 時為空array
{
"id": "aadlzj",
"name": "广安电力职业技术学校",
"tchCnt": 81
},
{
"id": "aaqryy",
"name": "广安启睿第一实验学校",
"tchCnt": 231
}
]
}
]
}
取得教育機構
- URL：{POST} https://{Domain}/notice/get-units
| Parameter | Type | Required | Info |
|---|---|---|---|
| type | string | 非必須 | 教育機構類型 ※無此值時會列出所有教育機構類型 1:基礎教育機構(K-小學) 2:中等教育機構(國中、高中/職) 3:高等教育機構(大學、研究所) 4:其他 |
| showList | bool | 非必須 | 是否顯示學校資料 預設為false |
| hasMail | bool | 非必須 | 是否取得對象的TMID有Email 預設為false |
- 返回：
{
"state": 200,
"data": [
{
"id": "1", //教育機構類型 1:基礎教育機構(K-小學) 2:中等教育機構(國中、高中/職) 3:高等教育機構(大學、研究所) 4:其他
"name": "基礎教育機構(K-小學)", //教育機構名稱
"scCnt": 300, //所屬學校數
"tchCnt": 2957, //所屬老師數
"lists": [ //學校列表 ※showList = false 時為空array
{
"id": "habook",
"name": "玉山學校",
"tchCnt": 35
},
{
"id": "hben",
"name": "Alishan School",
"tchCnt": 13
},
]
}
]
}
個別挑選取得TMID資訊
URL：{POST} https://{Domain}/notice/get-tmidinfo
參數：
{
"creatTime":{ //生成時間 非必須
"start": 1730390400, //起始時間 非必須 unix timestamp (second)
"end": 1732982400 //結束時間 非必須 unix timestamp (second)
},
"geo": { //TMID所屬地理位置 非必須
"countryId":"TW", //國ID 非必須
"provinceId": null, //省ID 非必須
"cityId":"30" //市ID 非必須
},
"product": { //使用產品 非必須
"mode":"or", //and or 必須
"id":[ //產品類型 必須 'hiteach', 'hiteachcc', 'sokapp', 'sokrates', 'webirs'
"hiteach",
"hiteachcc"
]
},
"point": { //積分 非必須
"start": 100, //起始積分 非必須
"end": 2000 //結束積分 非必須
},
"school":[ //學校ID 非必須
"habook"
],
"tmid": [ //TMID 非必須
"1595321354"
],
"mode": "and" //各項目間取聯集或交集 非必須 and:交集 or:聯集 ※預設值為and
}
- 返回：
{
"state": 200,
"data": [
{
"id": "1730138798",
"name": "黃大偉"
},
{
"id": "1730309110",
"name": "劉曉明"
}
]
}
寄發訊息
URL：{POST} https://{Domain}/notice/send-message
參數：
[新建]
{
"mode": "crt" //操作模式 crt:新建 upd:修正 del:刪除 ※預設值為crt，無此欄位則採用預設值
"target": { //寄送對象
"area": [ //學區ID列表 非必須
"02944f32-f534-3397-ea56-e6f1fc6c3714"
],
"geo": [ //地理資訊 非必須
{
"countryId": "TW",
"countryName": "臺灣", //國名稱 ※2025-4-1追加
"provinceId": null,
"provinceName": null, //省名稱
"cityId": "30",
"cityName": "臺北市", //市名稱 ※2025-4-1追加
"type": "school" //類型 tmid、school
}
],
"unit": ["1","2"], //教育機構 非必須 1:基礎教育機構(K-小學) 2:中等教育機構(國中、高中/職) 3:高等教育機構(大學、研究所) 4:其他
"school":["habook","hbgl"], //學校ID 非必須
"tmid":["1522758684", "1595321354"] //TMID 非必須
},
"type":"notify", //發送類型 mail:郵件、notify:端外、sms:簡訊
"method":"multi", //挑選方式 single:個別 multi:批次
"subject": "主題", //主題 Email必須 [20250226追加]
"title":"BI寄送訊息測試", //標題 必須
"body":"這是系統寄送訊息的測試內容，旨在確認訊息傳遞是否正常運作。", //內文 必須
"sender":"IES", //訊息發送來源 必須 [20250226追加]
"hubName":"hita5", //訊息中樞 非必須 無值則預設為"hita5" [20250226追加]
"data": "{\"img\":[\"https://account.teammodel.net/img/teammodel_title_en.c4d8a10b.png\"],\"action\":[{\"type\":\"click\",\"label\":\"醍摩豆\",\"url\":\"https://www.habook.com/?code=\",\"quickLogin\":true,\"quicklogin\":1}]}", //額外資料 非必須 [20250226追加] [原"action"廢除]
"template": "d-f1c5abd8218736783", //模板ID 非必須 Email用 [20250226追加]
"send": 1744279200000 //發送時間 必須 ※unixTimestamp miliseconds 預設值為0，若為0則為「立即發送」
}
- 返回：
{
"state": 200, //API HttpStatus
"result": { //呼叫寄送API結果
"status": 200,
"content": ""
}
}
[修正]
{
"mode": "upd" //操作模式 crt:新建 upd:修正 del:刪除
"biNoticeId": "12345678-1111-2222-3333-1234567890", //寄送履歷ID ※必須
"send": 1744257060000 //要變更的寄送時間 ※修正模式只能修正寄送時間，若修正時間小於現在時間則無法修正
}
[刪除]
{
"mode": "del" //操作模式 crt:新建 upd:修正 del:刪除 ※若寄送時間小於現在時間則無法刪除
"biNoticeId": "12345678-1111-2222-3333-1234567890", //寄送履歷ID ※必須
}
取得訊息寄發履歷
URL：{POST} https://{Domain}/notice/get-notice-history
參數：
{
"msgType":"notify", //發送類型 非必須 mail:郵件、notify:端外、sms:簡訊
"selType":"multi", //挑選方式 非必須 single:個別 multi:批次
"theme":"測試", //標題(title) 非必須 ※模糊搜尋
"content":"測試", //內文(body) 非必須 ※模糊搜尋
"source":"IES", //發送消息來源 非必須 HiTeach、IES、Sokrates、Auth、Event
"geo": { //地理資訊 非必須 ※無值:null
"countryId": "TW", //國ID
"provinceId": null, //省ID
"cityId": "72", //市ID
"type": "school" //類型 tmid、school
},
"school":[ //學校ID 非必須 ※無值:null
"hbgl",
"habook"
],
"crowdIds":[ //寄送對象的TMID 非必須 ※無值:null
"1595321354"
],
"unitType":[ //教育機構 非必須 1:基礎教育機構(K-小學) 2:中等教育機構(國中、高中/職) 3:高等教育機構(大學、研究所) 4:其他 ※無值:null
"1"
],
"sendTimeFrom":1741225000000, //寄送時間篩選範圍From ※無值:0
"sendTimeTo":1741250529878 //寄送時間篩選範圍To ※無值:0
}
- 返回：
[
{
"msgType": "notify",
"selType": "multi",
"hubName": "hita5",
"subject": "",
"template": null,
"search": [
{
"mode": "area", //搜尋模式 area:學區 schGeo:學校地理 tmidGeo:TMID地理 unit:機構 school:學校 crtTime:帳號生成時間 softUse:使用軟體 point:積分範圍 tmid:帳號列表(個別挑選用)
"areaId": "02944f32-f534-3397-ea56-e6f1fc6c3714", //學區ID ※area專有
"areaName": "醍摩豆智慧学区", //學區名 ※area專有 ※2025-4-1追加
"countryId": null, //國ID ※schGeo、tmidGeo專有
"countryName": null, //國名稱 ※schGeo、tmidGeo專有 ※2025-4-1追加
"provinceId": null, //省ID ※schGeo、tmidGeo專有
"provinceName": null, //省名稱 ※schGeo、tmidGeo專有 ※2025-4-1追加
"cityId": null, //市ID ※schGeo、tmidGeo專有
"cityName": null, //市名稱 ※schGeo、tmidGeo專有 ※2025-4-1追加
"distId": null, //區ID ※schGeo、tmidGeo專有
"distName": null, //區名稱 ※schGeo、tmidGeo專有 ※2025-4-1追加
"unitType": null, //機構類型
"unitName": "基礎教育機構(K-小學)", /機構類型名稱 ※2025-4-1追加
"crtFrom": 0, //TMID帳號生成時間From ※crtTime專有
"crtTo": 0, //TMID帳號生成時間To ※crtTime專有
"softUse": [], //軟體使用 ※softUse專有 "HiTeach"、"HiTeachCC"、"HiTA"、"IES5"、"Account"、"Sokrates"、"SokAPP"、"IRS"
"softUseMode": null, //軟體使用模式 and or ※softUse專有
"pointFrom": 0, //積分範圍From ※point專有
"pointTo": 0, //積分範圍To ※point專有
"school": null, //學校ID ※school專有
"schoolName": null, //學校名稱 ※school專有 ※2025-4-1追加
"tmId": [] //TMID列表 ※tmid專有
}
],
"data": "{\"img\":[\"https://img.anfensi.com/upload/2019-9/201993946255396.png\"],\"action\":[{\"type\":\"click\",\"label\":\"醍摩豆\",\"url\":\"https://www.habook.com\",\"quickLogin\":false}]}",
"type": 0,
"jumpUrl": null,
"callbackName": null,
"refuseName": null,
"theme": "發送測試T1",
"content": "發送測試T1-內容",
"crowd": null,
"crowdIds": [
"1595321354"
],
"createId": "1522758684",
"sendTime": 1741232408080,
"createTime": 1741232405080,
"source": "IES",
"id": "1836728761283476182746",
"code": "BINotice",
"pk": "BINotice"
}
]
Delete Page