短訊API

出自Intersoft supporting Wiki

跳轉到: 導航, 搜索

短訊API 是基於Microsoft.NET WebService 開發,支援XML/SOAP、WSDL。

目錄

短訊API 位置

http
http://login.speedfax.net:8680
http://login.speedfax.net/SMSWS/sms.asmx

SSL 加密連線
https://login.speedfax.net:8681
https://login.speedfax.net/SMSWS/sms.asmx

支援以下使用方法

  • SOAP 1.1
  • SOAP 1.2
  • HTTP Get
  • HTTP Post

使用範例

AddMessage

發送單一短訊,使用者可設定發送時間

變數 內容
UserName 登入名稱
Password 密碼
MobileNumber 接收者手機號碼
Message 訊息內容(支援長短訊)
ScheduleTime 發送時間
  • 空白為即時發送
  • 格式為 yyyy-MM-dd HH:mm[1][2]


  • HTTP POST
    直接將以下字串Post[3]到API位置 /sms.asmx/AddMessage
    UserName=string&Password=string&MobileNumber=string&Message=string&ScheduleTime=string
  • HTTP GET
    利用URL直接加入一短訊
    /sms.asmx/AddMessage?UserName=string&Password=string&MobileNumber=string&Message=string&ScheduleTime=string
  • SOAP 1.1
    請參考WebService頁面或使用WSDL[4]直接匯入



AddMessage 回傳資訊

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddMessageResponse xmlns="http://login.speedsms.hk:8680/">
 <MessageResult>
  <MessageID>guid</MessageID>
  <MessageLength>int</MessageLength>
 </MessageResult>
</AddMessageResponse>
</soap:Body>
</soap:Envelope>
變數 內容
MessageID 短訊獨一無二的識別編號, 格式為GUID[5]字串
MessageLength 需要的短訊額



CheckMessageStatus

利用發送短所得之MessageID來查詢訊息現在的狀態

變數 內容
UserName 登入名稱
Password 密碼
MessageID 短訊獨一無二的識別編號



CheckMessageStatus 回傳資訊

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CheckMessageStatusResponse xmlns="http://login.speedsms.hk:8680/">
 <MessageStatus>
  <MessageID>guid</MessageID>
  <MessageStatus>string</MessageStatus>
  <MessageScheduledTime>string</MessageScheduledTime>
  <MessageSentTime>string</MessageSentTime>
  <MessageReceiptTime>string</MessageReceiptTime>
 </MessageStatus>
</CheckMessageStatusResponse>
</soap:Body>
</soap:Envelope>
變數 內容
MessageID 短訊識別編號
MessageStatus 現在的狀態 -
  • Success
  • Partial
  • Sending
  • Scheduled
  • Queueing
MessageScheduledTime 未發送時,預定發送的時間
MessageSentTime 已發送,發送時間
MessageReceiptTime 已發送,收到回條的時間

詞匯

  1. yyyy: 年份 (e.g. 2008)/MM: 月份 (e.g. 05)/dd: 日 (e.g. 01)/HH: 24小時制時間/mm: 分鐘
  2. 例: 2008-02-14 09:00為2008年2月14日9:00
  3. Post:遞交 內容會放在指令裏,不會在URL上顯示
  4. WSDL:Web Service Definition Language - Web服務描述語言
  5. GUID:Globally Unique Identifier wikipedia:Globally Unique Identifier