|
輸入參數
|
※輸入參數請都先以UrlEncode過後再帶入、以避免因特殊字元造成的錯誤
|
名稱
|
描述
|
資料型態
|
註解
|
|
Ccid
|
客戶證號
|
字串
|
最長為15位元的客戶證號
|
|
Key
|
授權碼
|
字串
|
長度為36的授權碼字串
|
|
[GsmNo]
|
車機門號
|
車機門號字串
|
可選參數，若沒有帶此參數表示傳遞至該客戶名下所有可以接收此類廣播訊息的車機。
車機門號間以半形逗號分隔，例如：0987654321,0987654322。
注意：
1.就算串接了重複的門號，訊息也只會發送至該車機一次。
2.若欲傳送廣播訊息至不能接收此類訊息的車機時，訊息將不會發送至這些車機，並會在相對應回應的<DispatchId>寫入-2的值。
|
|
Msg
|
訊息內容
|
UrlEncode編碼字串
|
編碼前長度限制為130個字元(中文占2字元、英文占1字元，中英文交會時API會視需要插入空白字元)的廣播訊息內容，實際呼叫時須先以UrlEncode編碼。
由於新型車機派遣機制限制，無法使用半形雙引號(")，若訊息內需存在雙引號，請使用全形雙引號(＂)或單引號(')取代之。
若訊息內存在半形雙引號，系統會自動將半形雙引號(")取代成半形單引號(')。
|
|
[Account]
|
帳號
|
UrlEncode編碼字串
|
可選參數，長度限制為20字元的帳號，實際呼叫時須先以UrlEncode編碼。
|
|
|
輸出結果
|
若API執行成功，輸出結果為一XML：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<Counter>共回應多少筆MsgInfo</Counter>
<MsgInfo>
<GsmNo>車輛門號</GsmNo>
<DispatchId>該車機的派遣序號或錯誤種類</DispatchId>
</MsgInfo>
<MsgInfo></MsgInfo>
……(MsgInfo共Counter筆)
<SuccessCounter>實際發送廣播訊息的車機數</SuccessCounter>
</Data>
|
輸出參數說明：
|
標籤名稱
|
描述
|
資料型態
|
註解
|
|
Counter
|
發送資訊總數
|
數字
|
此次API共回應多少筆MsgInfo。
若有輸入GsmNo，此值應該等同於輸入不重覆的GsmNo筆數相同；
若沒有輸入GsmNo，此值應該和客戶名下所有可以接收廣播訊息的門號數相同。
|
|
MsgInfo
|
發送資訊
|
|
MsgInfo共有Counter筆。
|
|
GsmNo
|
車機門號
|
字串
|
發送訊息的來源車機門號。
|
|
DispatchId
|
派遣序號
|
數字
|
此次廣播訊息發送時系統配給該車的派遣序號。
注意：
若派遣序號為負數，表示沒有派送廣播訊息至該車機，對照表如下：
|
DispatchId值
|
代表意義
|
|
-1
|
單一車機因訊息過多無法發送廣播。
|
|
-2
|
車機種類無法接收此類廣播訊息。
|
|
|
SuccessCounter
|
發送廣播車機數
|
數字
|
實際發送廣播訊息至多少台車機。
|
|
|
錯誤訊息
|
若API執行失敗，結果以XML格式回傳：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<ErrorCode>錯誤訊息代碼</ErrorCode>
</Data>
|
錯誤訊息代碼說明如下：
|
錯誤訊息代碼
|
錯誤說明
|
|
001
|
輸入的授權碼(Key)是不合法的授權碼
|
|
002
|
使用的IP是不合法的IP
|
|
003
|
存取時間小於允許間隔時間
|
|
004
|
任務派遣數量超過系統上限
|
|
010
|
輸入的參數有缺漏
|
|
011
|
輸入的客戶證號(Ccid)不正確
|
|
012
|
輸入的車機門號(GsmNo)至少有一組錯誤
|
|
200
|
系統忙碌或其他原因造成沒有完成服務，請重試
|
|
201
|
空白的訊息內容
|
|
202
|
訊息內容過長，長度限制為130個字元
|
|
203
|
輸入的訊息內容(Msg)為錯誤的Url編碼
|
|
204
|
輸入的帳號(Account)長度過長
|
|
205
|
訊息內容(Msg)包含異常字元
|
|
|
範例
|
呼叫範例：
https://efms.hinet.net/FMS_WS/Services/API/Send_BroadcastMsg.aspx?Ccid=123456&Key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Msg=%e8%ab%8b%e5%9b%9e%e5%85%ac%e5%8f%b8
回應範例：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<Counter>3</Counter>
<MsgInfo>
<GsmNo>0987654321</GsmNo>
<DispatchId>5</DispatchId>
</MsgInfo>
<MsgInfo>
<GsmNo>0987654322</GsmNo>
<DispatchId>16</DispatchId>
</MsgInfo>
<MsgInfo>
<GsmNo>0987654323</GsmNo>
<DispatchId>-2</DispatchId>
</MsgInfo>
<SuccessCounter>2</SuccessCounter>
</Data>
|
|