華錄億動短信接口文檔

1、企業(yè)短信平臺企業(yè)API接口說明華錄億動2013-05-21版本時間更新內(nèi)容更新人1.02010-08-11文檔成立李2.02010-08-111.擴展發(fā)送接口函數(shù),增加了如下功能:a. 使用基本參數(shù)的形式發(fā)送短信;b. 通過xml的形式組織短信并發(fā)送;c. 支持多號碼發(fā)送,號碼間用逗號分隔,號碼類別(即各運營商號碼,如:小靈通手機)可混合發(fā)送同一條信息;d. 支持回執(zhí)確認(rèn)的操作.e. 支持上行獲取的操作;f. 返回格式更新為XML的模式,以存放更豐富的返回信息,如:發(fā)送狀態(tài)報告,獲取上行;g. 查詢用戶余額。e. 添加彩信發(fā)送功能f. 添加彩信獲取狀態(tài)報告李3.02013-05-211、 修改

2、文檔中出現(xiàn)的錯誤2、 調(diào)整文檔中參數(shù)列表的順序，方便用戶調(diào)用3、 添加.net調(diào)用方法簡單介紹閆衛(wèi)新目 錄1企業(yè)API接口31.1接口函數(shù)說明31.1.1發(fā)送消息函數(shù)sendSmsAsXml41.1.2發(fā)送消息函數(shù)sendLongSmsAsXml41.1.3發(fā)送消息函數(shù)sendSmsAsNormal51.1.4發(fā)送消息函數(shù)sendSmsAsNormal1（支持用戶擴展）61.1.5發(fā)送消息函數(shù)sendLongSmsAsNormal61.1.6發(fā)送任務(wù)狀態(tài)查詢getSmsStates71.1.7發(fā)送彩信sendMms71.1.8彩信發(fā)送狀態(tài)查詢getMmsStates81.1.9接收消息函數(shù)ge

3、tMoList91.1.10接收消息函數(shù)getMoList1101.1.11查詢余額getAmount101.2企業(yè)接口調(diào)用方式111.2.1C#中的調(diào)用111.2.2PHP中的調(diào)用111.2.3Java的調(diào)用方式131.2.4彩信的調(diào)用方式141 企業(yè)API接口企業(yè)API接口的實現(xiàn)使用了WebService的方式，企業(yè)用戶通過調(diào)用WebService的指定接口函數(shù)以達到發(fā)送和接收短信的目的；企業(yè)接口的服務(wù)地址為： 要查看接口的定義的話則在連接地址下面增加“?WSDL”，即：1.1 接口函數(shù)說明企業(yè)接口中提供了常用的短信函數(shù)如下：sendSmsAsXml函數(shù)為通過基本參數(shù)發(fā)送消息sendLon

4、gSmsAsXml 函數(shù)為通過基本參數(shù)發(fā)送長消息（遺留接口，可直接調(diào)用sendSmsAsXml）sendSmsAsNormal函數(shù)為通過XML發(fā)送消息sendLongSmsAsNormal 函數(shù)為通過XML發(fā)送長消息(遺留接口，可直接調(diào)用SendSmsAsNormal)sendLongSmsAsNormal1發(fā)送短信，支持?jǐn)U展的方法getSmsStates函數(shù)為獲取狀態(tài)報告sendMms 函數(shù)為發(fā)送彩信getMmsStates 函數(shù)為獲取彩信狀態(tài)報告getMoList函數(shù)為獲取上行g(shù)etMoList1函數(shù)為獲取上行,xml有目的號碼字段getAmount函數(shù)為查詢余額1.1.1 發(fā)送消息函數(shù)s

5、endSmsAsXml函數(shù)定義如下：public String sendSmsAsXml(String smsPack, String cpid, String cppwd)函數(shù)參數(shù)有三個：參數(shù)名說明smsPackXml格式數(shù)據(jù)包（電話號，短信內(nèi)容，流水號），sms節(jié)點為根節(jié)點,。msg表示一個短信包。phone節(jié)點為接收號碼,號碼間用逗號”,”分隔.可支持最大50個號碼。content節(jié)點為內(nèi)容節(jié)點，內(nèi)容無字?jǐn)?shù)限制，低于70按一條計費，多余70字按65字一條計費，最多支持300字。spnumber節(jié)點為對應(yīng)的流水號節(jié)點，此節(jié)點將用來匹配狀態(tài)報告。chid節(jié)點為預(yù)留節(jié)點，用來作為擴展節(jié)點。cp

6、id分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼對于smsPack結(jié)構(gòu)如下:<?xml version="1.0" encoding="utf-8" ?><sms> <msg> <phone>13811111111</phone> <content>xxxxxxxxxx</content> <spnumber>短信流水號</spnumber><chid>0</chid> </msg&

7、gt; <msg> . </msg></sms>返回值及其含義如下:statusmessage0發(fā)送成功及成功的信息描述其他對應(yīng)響應(yīng)的錯誤信息1.1.2 發(fā)送消息函數(shù)sendLongSmsAsXml（遺留接口）函數(shù)定義如下：public String sendLongSmsAsXml (String smsPack, String cpid, String cppwd)函數(shù)參數(shù)有三個：參數(shù)名說明smsPackXml格式數(shù)據(jù)包（電話號，短信內(nèi)容，流水號），sms節(jié)點為根節(jié)點,。msg表示一個短信包。phone節(jié)點為接收號碼,號碼間用逗號”,”分隔.可支持最大5

8、0個號碼。content節(jié)點為內(nèi)容節(jié)點，內(nèi)容無字?jǐn)?shù)限制，低于70按一條計費，多余70字按65字一條計費，最多支持300字。spnumber節(jié)點為對應(yīng)的流水號節(jié)點，此節(jié)點將用來匹配狀態(tài)報告。chid節(jié)點為預(yù)留節(jié)點，用來作為擴展節(jié)點。cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼對于smsPack結(jié)構(gòu)如下:<?xml version="1.0" encoding="utf-8" ?><sms> <msg> <phone>13811111111</phone>

9、 <content>xxxxxxxxxx</content> <spnumber>短信流水號</spnumber><chid>0</chid> </msg> <msg> . </msg></sms>返回值及其含義如下:statusmessage0發(fā)送成功及成功的信息描述其他對應(yīng)響應(yīng)的錯誤信息1.1.3 發(fā)送消息函數(shù)sendSmsAsNormal函數(shù)定義如下：public String sendSmsAsNormal(String phone, String msgcont,

10、String spnumber,String chid, String cpid, String cppwd);函數(shù)的參數(shù)有六個：參數(shù)名說明phone發(fā)送的手機號碼，多個號碼使用”,”分開，最多支持50個號碼msgcont需要發(fā)送的內(nèi)容，內(nèi)容最多300字，低于70按一條收費多于70系統(tǒng)自動拆分成多條并按65字計費。spnumber流水號，用來匹配狀態(tài)報告。chid預(yù)留字段，默認(rèn)為0cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼返回參數(shù)如下：statusmessage0發(fā)送成功及成功的信息描述其他對應(yīng)響應(yīng)的錯誤信息1.1.4 發(fā)送消息函數(shù)sendSmsAsNormal1（支持用

11、戶擴展）函數(shù)定義如下：public String sendSmsAsNormal1(String phone, String msgcont, String spnumber,String chid, String cpid, String cppwd,String extend);函數(shù)的參數(shù)有六個：參數(shù)名說明phone發(fā)送的手機號碼，多個號碼使用”,”分開，最多支持50個號碼msgcont需要發(fā)送的內(nèi)容，內(nèi)容最多300字，低于70按一條收費多于70系統(tǒng)自動拆分成多條并按65字計費。Spnumber流水號，用來匹配狀態(tài)報告。Chid預(yù)留字段，默認(rèn)為0Cpid分配給企業(yè)用戶的登錄名cppwd分配

12、給企業(yè)用戶的對應(yīng)密碼Extend擴展小號（不超過5位，可以為空），例如設(shè)置extend為1001，擴展會在顯示的時候追加到發(fā)送號碼上，比如發(fā)送的號碼是106902588，啟用擴展后用戶那里顯示的會是1069025881001返回參數(shù)如下：statusmessage0發(fā)送成功及成功的信息描述其他對應(yīng)響應(yīng)的錯誤信息1.1.5 發(fā)送消息函數(shù)sendLongSmsAsNormal（遺留接口）函數(shù)定義如下：public String sendLongSmsAsNormal (String phone, String msgcont, String spnumber,String chid, String

13、 cpid, String cppwd);函數(shù)的參數(shù)有六個：參數(shù)名說明phone發(fā)送的手機號碼，多個號碼使用”,”分開，最多支持50個號碼msgcont需要發(fā)送的內(nèi)容，內(nèi)容最多300字，低于70按一條收費多于70系統(tǒng)自動拆分成多條并按65字計費。spnumber流水號，用來匹配狀態(tài)報告。chid預(yù)留字段，默認(rèn)為0cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼返回參數(shù)如下：statusmessage0發(fā)送成功及成功的信息描述其他對應(yīng)響應(yīng)的錯誤信息1.1.6 發(fā)送任務(wù)狀態(tài)查詢getSmsStates函數(shù)定義如下：public String getSmsStates(String

14、cpid,String cppwd)函數(shù)的參數(shù)有兩個：參數(shù)名說明cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼返回結(jié)果為一個XML列表對象<?xml version="1.0" encoding="utf-8" ?> <smsResult><result> < spnumber >短信流水號</ spnumber > <phone>手機號碼</phone> <status>DELIVRD</status> <sendtime

15、>20101102000000</sendtime> </result> </smsResult>Spnumber：下發(fā)時對應(yīng)的流水號Phone： 下發(fā)時對應(yīng)的手機號碼Status：表示短信對應(yīng)的結(jié)果:DELIVRD成功其他 失敗Sendtime：節(jié)點為下發(fā)時的時間1.1.7 發(fā)送彩信sendMms函數(shù)定義如下：public String sendMms(String smsPack, String cpid, String cppwd)函數(shù)的參數(shù)有兩個：參數(shù)名說明smsPack彩信數(shù)據(jù)包為XML格式cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用

16、戶的對應(yīng)密碼smsPack為一個XML列表對象<?xml version="1.0" encoding="utf-8" ?><mms> <phone>13811111111</phone> <spnumber>短信流水號</spnumber> <subject>這是一個測試</subject> <chid></chid>    <pages>  

17、60;    <page dur=”50”>         <img type=” gif”>base64編碼</img>          <text>這是第1屏中的文字</text>       </page>    &#

18、160;  <page dur=”30”>          <img type=” jpeg”>base64編碼</img>          <text>這是第2屏中文字</text>       </page>  </pages></mms&g

19、t;Pages下面可以由多個page節(jié)點，每一個節(jié)點代表一個彩信屏。1. 每一屏中只能有一個圖片img和一個文字text 節(jié)點，圖片在上?；蛘邇H有一個圖片，或者僅有一段文字。2. 圖片節(jié)點中的內(nèi)容就是圖片文件內(nèi)容的base64編碼。3. 圖片的格式可以采用gif和jepg兩種。4. 圖片的寬度是以內(nèi)，高度在以內(nèi)。5. 所有的圖片和文字的總大小不能超過（建議在之內(nèi)，有些手機不能顯示超過的彩信）彩信屏數(shù)沒有太多的限制，建議在制作端限制在屏之內(nèi)（有的手機顯示不了屏以上的彩信）返回參數(shù)如下：statusmessage0發(fā)送成功及成功的信息描述其他對應(yīng)響應(yīng)的錯誤信息1.1.8 彩信發(fā)送狀態(tài)查詢getMm

20、sStates函數(shù)定義如下：public String getMmsStates(String cpid,String cppwd)函數(shù)的參數(shù)有三個：參數(shù)名說明cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼返回參數(shù)如下：<?xml version="1.0" encoding="utf-8" ?> <smsResult><result><spnumber>0</spnumber> <phone>手機號碼</phone> <status>DEL

21、IVRD</status> <sendtime>20130322163620</sendtime> </result> </smsResult>Spnumber：下發(fā)時對應(yīng)的流水號Phone： 下發(fā)時對應(yīng)的手機號碼Status：表示短信對應(yīng)的結(jié)果:DELIVRD成功其他 失敗Sendtime：節(jié)點為下發(fā)時的時間1.1.9 接收消息函數(shù)getMoList函數(shù)定義如下：public String getMoList(String nextId, String cpid, String cppwd);函數(shù)的參數(shù)有三個：參數(shù)名說明nextId

22、預(yù)留字段，默認(rèn)為0cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼返回參數(shù)如下：<?xml version="1.0" encoding="utf-8" ?> <moResult><result> <phone>手機號碼</phone> <content>1000</ content > <datetime>20101102000000</ datetime > </result> </moResult >P

23、hone：上傳用戶的手機號碼。Content：用戶上傳的內(nèi)容。Datetime：用戶上傳時的時間。1.1.10 接收消息函數(shù)getMoList1函數(shù)定義如下：public String getMoList(String nextId, String cpid, String cppwd);函數(shù)的參數(shù)有三個：參數(shù)名說明nextId預(yù)留字段，默認(rèn)為0cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼返回參數(shù)如下：<?xml version="1.0" encoding="utf-8" ?> <moResult><r

24、esult> <phone>手機號碼</phone> <content>1000</ content > <datetime>20101102000000</ datetime > <dest>1065700089123</dest> </result> </moResult >phone：上傳用戶的手機號碼。content：用戶上傳的內(nèi)容。datetime：用戶上傳時的時間。dest：上行目的號碼1.1.11 查詢余額getAmount函數(shù)定義如下：public St

25、ring getAmount(String cpid, String cppwd, String chid)函數(shù)的參數(shù)有三個：參數(shù)名說明cpid分配給企業(yè)用戶的登錄名cppwd分配給企業(yè)用戶的對應(yīng)密碼chid預(yù)留字段，默認(rèn)為0。返回值：數(shù)字，即剩余的條數(shù)1.2 企業(yè)接口調(diào)用方式企業(yè)接口函數(shù)的調(diào)用方式，此處列出各種語言及開發(fā)環(huán)境調(diào)用的示例，具體環(huán)境還需要作實際的修改。1.2.1 C#中的調(diào)用在你的項目的引用上右鍵à添加服務(wù)引用，點擊左下角高級，接著在彈出的對話框中”添加web引用”，在url中填寫：cn.my2my.hl.esmsservice service = new cn.my2

26、my.hl.esmsservice();實例化對象并調(diào)用相應(yīng)方法1.2.2 PHP中的調(diào)用<?phpset_time_limit(0);header("Content-Type: text/html; charset=gbk");/* * 定義程序絕對路徑 */define('SCRIPT_ROOT', dirname(_FILE_).'/');require_once SCRIPT_ROOT.'include/Client.php'/* * 網(wǎng)關(guān)地址 */$gwUrl = ' http:/ /newesmsse

27、rvice/services/esmsservice '/* * 序列號,請通過華錄億動銷售人員獲取 */$serialNumber = '用戶名'/* * 密碼,請通過華錄億動銷售人員獲取 */$password = '密碼'/* * 登錄后所持有的SESSION KEY，即可通過login方法時創(chuàng)建 */$sessionKey = '621163'/* * 連接超時時間，單位為秒 */$connectTimeOut = 2;/* * 遠程信息讀取超時時間，單位為秒 */ $readTimeOut = 10;/*$proxyhost可選

28、，代理服務(wù)器地址，默認(rèn)為 false ,則不使用代理服務(wù)器$proxyport可選，代理服務(wù)器端口，默認(rèn)為 false$proxyusername可選，代理服務(wù)器用戶名，默認(rèn)為 false$proxypassword可選，代理服務(wù)器密碼，默認(rèn)為 false*/$proxyhost = false;$proxyport = false;$proxyusername = false;$proxypassword = false; $client = new Client($gwUrl,$serialNumber,$password,$sessionKey,$proxyhost,$proxyport

29、,$proxyusername,$proxypassword,$connectTimeOut,$readTimeOut);$client->setOutgoingEncoding("gbk");$statusCode = $client->sendSmsAsNormal("quot;,"PHP WebService Client測試","201009201216","201","用戶名","密碼");echo "處理狀態(tài)

30、碼:".$statusCode;$result = $client->getMoList("用戶名","密碼");$result_1 = $client->getSmsStates("用戶名","密碼");?>1.2.3 Java的調(diào)用方式需要下載apache soap。下載地址：/soap/index.html導(dǎo)入：import org.apache.axis.client.Call;import org.apache.axis.client.Service;例子：private static Service service = new Service();private String URL=" http:/ /newesmsservice/services/esmsservice "public String testSend(int type) try Call call = (Call) service.createCall();call.setTargetEndpointAddress(new URL(URL);String send=&quo