http:// 服務(wù)器地址:端口/service/webService/Web_Service?wsdl
- 接口參數(shù):
- 服務(wù)器地址:IP
- 端口:PORT
- 用戶賬號:
- 用戶密碼:
- 通信認證密碼:
第一章 余額
1.1 請求地址
String getAmount(String xmlParams)
xmlParams:字符串類型,以xml格式的請求參數(shù),詳細請求格式看以下具體參數(shù)說明。
1.2參數(shù)說明
testss 123456 453245
參數(shù)名稱 | 含義 | 說明 |
username | 用戶賬號 | 用戶賬號 |
password | 用戶密碼 | 用戶密碼 |
veryCode | 通信認證密碼 |
1.3返回值
在接收請求后,返回以xml的方式返回處理結(jié)果。格式為:
返回值說明:0 -------返回狀態(tài)值:成功返回0 失敗返回:失敗代碼------當status為0時,會出現(xiàn)該屬性
名稱 | 說明 |
status | 返回狀態(tài)值,具體參照狀態(tài)碼說明 |
account | 余額,條數(shù)= acount * 10 |
返回碼 | 描 述 |
0 | 查詢成功 |
100 | 查詢余額失敗 |
101 | 用戶賬號不存在或密碼錯誤 |
102 | 賬號已禁用 |
103 | 參數(shù)不正確 |
105 | 認證碼錯誤 |
117 | 未開通此接入方式 |
數(shù)字account | 短信余額 |
第二章 發(fā)送接口
2.1 請求地址
String sendMsg(String xmlParams)
xmlParams:字符串類型,以xml格式的請求參數(shù),詳細請求格式看以下具體參數(shù)說明。
2.2參數(shù)說明
JSM00001 123456 453245 1595****097 @1@=你好 8888 2 1 JSM00001-0001
參數(shù)名稱
|
含義
|
說明
|
username
|
用戶賬號(必填)
|
用戶賬號
|
password
|
用戶密碼(必填)
|
用戶密碼
|
veryCode
|
通信認證密碼(必填) | 通信認證密碼。 |
mobile | 手機號碼(必填) | 手機號碼(群發(fā)短信時,最多100個,英文逗號,隔開) |
content | 短信內(nèi)容(必填) | 短信內(nèi)容(最多300個漢字),特殊字符需要轉(zhuǎn)義;如果使用模板短信發(fā)送,此參數(shù)用來傳遞模板短信的變量和值,參數(shù)之間以逗號隔開 |
extcode | 擴展碼 | 用戶自己分配的小號(即顯示在接收手機上的主叫尾號,可用于上行信息匹配)例:我們給合作方開的特服號是106905994140010,然后合作方在發(fā)送信息的時候可以隨意填寫擴展號ext=8888(最大支持4位),那么用戶收到信息時顯示的下發(fā)號碼就是1069059941400108888 |
sendtime | 定時時間 | 定時短信的定時時間,格式為: (yyyyMMddhhmmss),例如:20140504111010 代表2014年5月4日 11時10分10秒,短信會在指定的時間發(fā)送出去 sendTime值為空時,為即時發(fā)送短信 sendTime值不為空時,為定時發(fā)送短信 |
msgtype |
短信類型(必填) |
短信類型。1-普通短信,2-模板短信。 |
signtag |
短信簽名序號 |
短信簽名序號,如果帳號報備多個簽名,此參數(shù)指定使用第幾個簽名(由于運營商要求,帳號只允許單一簽名,此參數(shù)可以省略) |
signtext |
自定義簽名 |
自定義簽名,帳號支持自定義簽名該參數(shù)才生效 |
tempid |
模板短信編號 |
模板編號,(msgtype=2時參數(shù)必填) |
code | 編碼格式 | 編碼方式(utf-8,gbk),默認:gbk |
1) IP:如果用戶開賬戶時指定IP,則接口只接收該IP發(fā)送請求。
2) 發(fā)送模版短信msgtype=2,tempid必須填寫模版編號
2.3 返回值
返回值說明
名稱 | 說明 |
status | 返回狀態(tài)值,具體參照狀態(tài)碼說明 |
msgid | 消息id,和狀態(tài)報告內(nèi)msgid匹配的 |
返回碼 | 描 述 |
0 | 提交成功 |
100 | 發(fā)送失敗 |
101 | 用戶賬號不存在或密碼錯誤 |
102 | 賬號已禁用 |
103 | 參數(shù)不正確 |
105 | 短信內(nèi)容超過300字或為空、或內(nèi)容編碼格式不正確 |
106 | 手機號碼超過100個或有錯誤號碼 |
108 | 余額不足 |
109 | ip錯誤 |
110#(敏感詞A,敏感詞B) | 短信內(nèi)容存在系統(tǒng)保留關(guān)鍵詞,如有多個詞,使用逗號分隔:110#(李老師,XX,成人) |
114 | 模板短信序號不存在 |
115 | 短信簽名標簽序號不存在 |
116 | 認證碼不正確 |
117 | 未開通此接入方式 |
第三章 狀態(tài)報告接口
3.1 請求地址
String queryReport(String xmlParams)
xmlParams:字符串類型,以xml格式的請求參數(shù),詳細請求格式看以下具體參數(shù)說明。
建議訪問頻率:3分鐘一次
3.2參數(shù)說明
JSM00001 123456 453245
參數(shù)名稱 | 含義 | 說明 |
username | 用戶賬號(必填) | 用戶賬號 |
password | 用戶密碼(必填) | 用戶密碼 |
veryCode | 通信認證密碼(必填) |
3.3返回值
返回值說明:1595****097 7506751276725633025 MA:0006 1595****097 7506751276725633026 MA:0006 1595****097 7507418680283693057 DELIVRD
名稱 | 說明 |
mobile | 返回狀態(tài)值,具體參照狀態(tài)碼說明 |
msgid | 消息id,與發(fā)送接口消息id對應(yīng) |
status | 返回狀態(tài)碼,具體參照狀態(tài)碼說明 |
time | 狀態(tài)報告的時間 |
extno | 擴展碼 |
返回碼 | 描 述 |
DELIVRD | 發(fā)送成功,返回其他請參照失敗狀態(tài)碼 |
3.4錯誤返回值
返回值說明:
名稱 | 說明 |
status | 返回狀態(tài)碼,具體參照狀態(tài)碼說明 |
返回碼 | 描 述 |
100 | 獲取狀態(tài)報告失敗 |
101 | 用戶賬號不存在或密碼錯誤 |
102 | 賬號已禁用 |
103 | 參數(shù)不正確 |
104 | 暫無短信狀態(tài)報告 |
105 | 認證碼錯誤 |
117 | 未開通此接入方式 |
第四章 上行接口
4.1 請求地址
String queryMo(String xmlParams)
xmlParams:字符串類型,以xml格式的請求參數(shù),詳細請求格式看以下具體參數(shù)說明。
建議訪問頻率:3分鐘一次
4.2 參數(shù)說明
JSM00001 123456 453245
參數(shù)名稱 | 含義 | 說明 |
username | 用戶賬號(必填) | 用戶賬號 |
password | 用戶密碼(必填) | 用戶密碼 |
veryCode | 通信認證密碼(必填) |
4.3返回值
返回值說明:1595****097 106905994140001 江蘇美圣信息技術(shù)有限公司 1595****097 106905994140001 4006000699
名稱 | 說明 |
mobile | 對應(yīng)的手機號碼 |
recvcode | 接受號碼 |
content | 回復(fù)內(nèi)容 |
time | 接收時間 |
4.4錯誤返回值
返回值說明:
名稱 | 說明 |
status | 返回狀態(tài)碼,請參照狀態(tài)碼說明 |
返回碼 | 描 述 |
100 | 獲取上行短信失敗 |
101 | 用戶賬號不存在或密碼錯誤 |
102 | 賬號已禁用 |
103 | 參數(shù)不正確 |
104 | 暫無上行短信 |
105 | 認證碼錯誤 |
117 | 未開通此接入方式 |