創瑞短信平臺接口文檔 |
本文檔主要定了短信平臺對用戶開放的主要接口和定義。 1、普通短信發送 用戶通過HTTP的POST方式提交短信發送請求。編碼采用UTF-8編碼。 1.1短信提交地址 URL地址為:http://web.cr6868.com/asmx/smsservice.aspx 1.2參數定義 序號 參數 說明 1 name 必填參數。用戶賬號 2 pwd 必填參數。(web平臺:基本資料中的接口密碼) 3 content 必填參數。發送內容(1-500 個漢字)UTF-8編碼 4 mobile 必填參數。手機號碼。多個以英文逗號隔開 5 stime 可選參數。發送時間,填寫時已填寫的時間發送,不填時為當前時間發送 6 sign 可選參數。用戶簽名。 7 type 必填參數。固定值 pt 8 extno 可選參數,擴展碼,用戶定義擴展碼,只能為數字 1.3短信提交響應 用戶短信通過http請求提交到服務器后,服務器返回響應碼,響應碼的格式如下: 1.3.1格式說明 短信提交響應為英文逗號隔開的一行數據,狀態,發送編號,無效號碼數,成功提交數,黑名單數和消息,無論發送的號碼是多少,一個發送請求只返回一個sendid,如果響應的狀態不是“0”,則只有狀態和消息。 1.3.2示例 提交成功 20130821110353234137876543為返回的sendid,這個工狀態報告匹配時使用。 提交失敗 本示例表明用戶提交失敗,返回錯誤碼為1,服務器端并未返回sendid等。 1.3.3響應狀態值說明 代碼 說明 0 提交成功 1 含有敏感詞匯 2 余額不足 3 沒有號碼 4 包含sql語句 10 賬號不存在 11 賬號注銷 12 賬號停用 13 IP鑒權失敗 14 格式錯誤 -1 系統異常 1.4短信發送例子 http://web.cr6868.com/asmx/smsservice.aspx?name=test&pwd=112345&content=testmsg&mobile=13566677777,18655555555&stime=2012-08-01 8:20:23&sign=testsign&type=pt&extno=123 2、個性短信發送 2.1短信提交地址 URL地址為:http://web.cr6868.com/asmx/smsservice.aspx 2.2參數定義 序號 參數 說明 1 name 必填參數。用戶賬號 2 pwd 必填參數。(web平臺:基本資料中的接口密碼) 3 content 必填參數。發送內容UTF-8編碼,建議每次1000個 格式:內容#@#號碼#@@#內容#@#號碼 例:你好張三#@#13566666666#@@#你好李四#@#13999999999 4 stime 可選參數。發送時間,填寫時已填寫的時間發送,不填時為當前時間發送 5 sign 可選參數。用戶簽名。 6 type 必填參數。固定值 gx 7 extno 可選參數,擴展碼,用戶定義擴展碼,只能為數字 2.3短信提交響應 用戶短信通過http請求提交到服務器后,服務器返回響應碼,響應碼的格式如下: 2.3.1格式說明 短信提交響應為英文逗號隔開的一行數據,狀態,發送編號,無效號碼數,成功提交數,黑名單數和消息,無論發送的號碼是多少,一個發送請求只返回一個sendid,如果響應的狀態不是“0”,則只有狀態和消息。Code值與普通短信含義相同 2.3.2示例 提交成功 20130821110353234137876543為返回的sendid,這個工狀態報告匹配時使用。 3、狀態報告推送(post方式推送) 如果管理員設置用戶賬戶需要狀態報告,并且也配置了賬戶的狀態報告接收地址,則用戶可以接收到其發送短信的狀態報告。用戶側啟動一個HTTP服務用于接收狀態報告。POST方式推送 3.1參數定義 序號 參數 說明 1、name 接收狀態報告驗證的用戶名(不是賬戶名),是按照用戶要求配置的名稱,可以為空 2、pwd 接收狀態報告驗證的密碼,可以為空 3、sendid 提交短信時平臺返回的sendid,參見1.2 4、time 報告時間(多個號碼時,是第一個號碼的時間) 5、mobile 當多個號碼狀態相同時 手機號以英文逗號隔開;不同時,為單個手機號碼。 6、state 狀態報告數值 3.2狀態報告值 狀態報告的值即,state后面的數據,如下 狀態值(字符串) 說明 DELIVRD 短消息轉發成功 EXPIRED 短消息超過有效期 UNDELIV 短消息是不可達的 UNKNOWN 未知短消息狀態 REJECTD 短消息被短信中心拒絕 DTBLACK 目的號碼是黑名單號碼 ERR:104 系統忙 REJECT 審核駁回 其他 網關內部狀態 3.3示例 http://pushUrl?name=admin&pwd=12345&sendid=12345&time=2013-08-20 20:11:34&mobile=13900210021&state=DELIVRD 其中,pushUrl為用戶啟動的服務地址。 4、短信接收(與報告雷同 post方式推送) 4.1參數定義 序號、參數說明 1 name 接收信息驗證的用戶名(不是賬戶名),是按照用戶要求配置的名稱,可以為空 2 pwd 接收信息服務需驗證的密碼,可以為空 3 args 手機號、內容、時間、系統擴展碼+自定義擴展碼;以 #@# 分割。(擴展碼可能為空) 多個上行以#@@# 分割 4.2示例 http://pushMoUrl?name=admin&pwd=12345&args=13800210021#@#content1#@#2013-08-21 21:20:11#@#008123#@@#13978767656#@#content2#@#2013-08-21 21:20:30#@#008456 本例中 008為系統為該用戶設置的擴展碼,123和另外一個456是提交短信時用戶自己加的自定義擴展碼;即發送時extno=123 系統擴展碼可能變化,如果變化一般長度不變,建議通過長度來截取得到自定義擴展碼 其中,pushUrl為用戶啟動的服務地址。 5、余額查詢接口 5.1接口地址 http://web.cr6868.com/asmx/smsservice.aspx 5.2參數定義 序號 參數 說明 1 name 必填參數。用戶賬號 2 pwd 必填參數。用戶密碼 3 type 必填參數。固定值 balance 5.3提交響應 code為獲取狀態,balance是用戶余額。 5.4提交響應值 代碼 說明 0 成功 10 賬號不存在 11 賬號注銷 12 賬號停用 13 IP鑒權失敗 5.5示例 http://web.cr6868.com/asmx/smsservice.aspx?name=test&pwd=testpwd&type=balance |
【返回首頁】 |
上一篇:群發短信內容編寫技巧 下一篇:群發短信效果差的真實原因 |
更多詳情請搜索: |