三網(wǎng)合一短信接口文檔.doc

三網(wǎng)合一短信接口文檔v2.0一、HTTP接口調(diào)用說明(支持POST和GET)HTTP網(wǎng)關(guān)地址:UTF8編碼網(wǎng)關(guān)55:6000/utf8/web_api/SendSMS_V2.aspxGBK 編碼網(wǎng)關(guān)55:6000/gbk/web_api/SendSMS_V2.aspx提示:HTTP調(diào)用URL接口時(shí), 參數(shù)值必須URL編碼后再調(diào)用1.1 參數(shù)說明序號(hào)參數(shù)名描述1X_sid會(huì)員編號(hào)2X_eid企業(yè)編號(hào)3X_uid會(huì)員帳號(hào)4X_pwd_md5MD5（MD5（密碼）+本機(jī)外網(wǎng)ip）英文字母全是小寫5X_ac操作指令10 發(fā)送普通短信70字12 發(fā)送長(zhǎng)短信450字13發(fā)送打包短信不同內(nèi)容20 接收回復(fù)短信30查詢賬戶余額50修改接口密碼100 獲取外網(wǎng)IP，用于生成x_pwd_md56X_gate_id300固定不能修改7X_target_no接口短信手機(jī)號(hào)，多個(gè)號(hào)碼用逗號(hào)分開，最多支持100條每次8X_memo短信發(fā)送內(nèi)容，最多450字符,必須url編碼1.2發(fā)送短信1.2.1發(fā)送普通短信（70字） 請(qǐng)求參數(shù)X_ac=10&x_eid=企業(yè)代碼&x_uid=會(huì)員帳號(hào)&x_pwd_md5=訪問密碼&x_gate_id=300&x_target_no=接收手機(jī)號(hào)&x_memo=發(fā)送短信內(nèi)容1.2.1發(fā)送長(zhǎng)短信(450字) 請(qǐng)求參數(shù)X_ac=12&x_eid=企業(yè)代碼&x_uid=會(huì)員帳號(hào)&x_pwd_md5=訪問密碼&x_gate_id=300&x_target_no=接收手機(jī)號(hào)&x_memo=發(fā)送短信內(nèi)容返回值描述類型值int0(大于0) 成功計(jì)費(fèi)條數(shù)=0 (小于等于0) 失敗2.接收回復(fù)短信(分主動(dòng)和被動(dòng)兩種接收)2.1主動(dòng)接收回復(fù)短信(最小調(diào)用間隔30秒一次) 請(qǐng)求參數(shù)X_ac=20&x_eid=企業(yè)代碼&x_uid=會(huì)員帳號(hào)&x_pwd_md5=訪問密碼&x_gate_id=300 返回XML格式（返回2條用戶回復(fù)的短信）1(序列號(hào)可以忽略)1001（會(huì)員編號(hào),如果有多個(gè)帳號(hào)情況下回復(fù)手機(jī)號(hào))能收到我回復(fù)的測(cè)試短信么？（回復(fù)內(nèi)容）2009-11-21 16:54:14(回復(fù)時(shí)間)10655059052084（回復(fù)到網(wǎng)關(guān)的號(hào)碼）1200 (用戶擴(kuò)展碼) 2100213020930000這是第二條測(cè)試短信!2009-11-21 16:13:3710655059052084101 2.2被動(dòng)接收回復(fù)短信（如果有新回復(fù)短信，我們會(huì)主動(dòng)以PUSH方式發(fā)送給用戶指定的頁(yè)面） 此方式采用http+xml+post技術(shù)，需要用戶提供一個(gè)接收短信頁(yè)面地址 以下是post+xml時(shí)的樣本： 11001這個(gè)是被動(dòng)回復(fù)過來的，能收到么？ 2008-03-14 23:07:39 1065810889988 101 3.查詢短信余額請(qǐng)求參數(shù)X_ac=30&x_eid=企業(yè)代碼&x_uid=會(huì)員帳號(hào)&x_pwd_md5=訪問密碼&x_gate_id=300 返回值Sms:10000,mms:5000描述Sms:指短信剩余條數(shù)，mms:指彩信剩余條數(shù)4.修改接口密碼請(qǐng)求參數(shù)X_ac=50&x_eid=企業(yè)代碼&x_uid=會(huì)員帳號(hào)&x_pwd_md5=訪問密碼&x_new_pwd=接口新密碼MD5&x_gate_id=300 返回值 1 修改新密碼成功，否則失敗。5.打包提交不同內(nèi)容短信(最多支持100個(gè)包),必須使用POST方式請(qǐng)求參數(shù)(只接受POST方式)X_ac=13&x_eid=企業(yè)代碼&x_uid=會(huì)員帳號(hào)&x_pwd_md5=訪問密碼&x_gate_id=300&x_memo=xml格式x_memo格式如下 編號(hào) (如果失敗，會(huì)輸出這個(gè)編號(hào),保證此包里不要重復(fù))用戶手機(jī)號(hào)碼1長(zhǎng)短信，0普通短信,(超過70字自動(dòng)設(shè)置1)擴(kuò)展碼 返回值(Int數(shù)字類型) 大于0成功，否則失敗6.獲取公網(wǎng)ip用于驗(yàn)證訪問密碼，x_pwd_md5需要用到這個(gè)值請(qǐng)求參數(shù)X_ac=100返回值00HTTP返回值參對(duì)表編號(hào)值說明1大于0發(fā)送成功,此次發(fā)送成功條數(shù)2-1參數(shù)無效3-2通道不存在或者當(dāng)前業(yè)務(wù)不支持此通道4-3定時(shí)格式錯(cuò)誤5-4接收號(hào)碼無效6-5提交號(hào)碼個(gè)數(shù)超過上限,每個(gè)通道都有批量提交的上限.詳細(xì)值請(qǐng)參考通道說明7-6發(fā)送短信內(nèi)容長(zhǎng)度不符合要求,參考通道要求長(zhǎng)度8-7當(dāng)前賬戶余額不足9-8網(wǎng)關(guān)發(fā)送短信時(shí)出現(xiàn)異常10-9用戶或者密碼沒輸入11-10企業(yè)ID或者會(huì)員賬號(hào)不存在12-11密碼錯(cuò)誤13-12賬戶鎖定14-13網(wǎng)關(guān)狀態(tài)關(guān)閉15-14驗(yàn)證用戶時(shí)執(zhí)行異常16-15網(wǎng)關(guān)初始化失敗17-16當(dāng)前IP已被系統(tǒng)屏蔽,可能是與您設(shè)置的接入IP不同或者是失敗次數(shù)太多18-17發(fā)送異常19-18賬號(hào)未審核20-19當(dāng)前時(shí)間不允許此通道工作，主要對(duì)群發(fā)通道限制21-20傳輸密鑰未設(shè)置，請(qǐng)登陸平臺(tái)設(shè)置22-21提取密鑰異常23-22簽名驗(yàn)證失敗24-23發(fā)現(xiàn)屏蔽關(guān)鍵字25-100到-199運(yùn)營(yíng)商返回失敗代碼二、WebService調(diào)用方式WS網(wǎng)關(guān)地址:Utf8網(wǎng)關(guān) 55:6000/utf8/ws_api/WebSMS_V2.asmxGBK網(wǎng)關(guān)55:6000/gbk/ws_api/WebSMS_V2.asmxWebService服務(wù)函數(shù)目錄1.EditPWD 修改接口密碼,平臺(tái)登錄密碼不受影響 2.FastSend 快速發(fā)送短信,直接提交到運(yùn)營(yíng)商,本站不存儲(chǔ)任何數(shù)據(jù).返回值:SendResult 自定義類 3.FastSendLongSMS 發(fā)送長(zhǎng)短信,最多支持450字.按64字計(jì)費(fèi),本站不存儲(chǔ)任何數(shù)據(jù).返回值:SendResult 自定義類 4.GetBalance 查詢賬戶剩余短信/彩信條數(shù),返回值:sms:100,mms:100 當(dāng)前余額,否則返回失敗代碼 5.GetUpSMS 客戶主動(dòng)讀取上行短信,最小間隔30秒,返回多個(gè)Woxp_UpSMS上行類。每條上行信息生成一個(gè)類,沒有上行就返回NULL 6.SendXMLPack 打包發(fā)送短信，適合不同內(nèi)容批量提交，以xml格式打包，上限100條.返回值:SendResult 公共參數(shù)調(diào)用描述eid_pwd_gateId，該參數(shù)是字符串類型，由多個(gè)值拼成所有函數(shù)都必須依賴這個(gè)參數(shù)來提供服務(wù)參數(shù)格式（ 會(huì)員編號(hào)-企業(yè)代碼會(huì)員帳號(hào)MD5（MD5（接口密碼）+登錄IP）-通道號(hào)）各個(gè)參數(shù)用-分開參數(shù)例如（1）會(huì)員編號(hào)：15（2）企業(yè)代碼：10001（3）會(huì)員帳號(hào)：smsone（4）登錄MD5: e10adc3949ba59abbe56e057f20f883e, MD5（MD5（接口密碼）+登錄IP）登錄IP可以由55:6000/utf8/web_api/SendSMS_V2.aspx?x_ac=100獲?。?）通道號(hào):300(這個(gè)是固定值)eid_pwd_gateId =15-10001-smsone-e10adc3949ba59abbe56e057f20f883e-300 (注意分隔符-半角下輸入)1. 修改接口密碼 public int EditPWD(string eid_pwd_md5, string newPwd_md5) 參數(shù)描述 newPwd_md5,新接口密碼MD5值（32 位） 返回值 1成功，否則失敗.2.發(fā)送普通短信70字 public SendResult FastSend(string eid_pwd_gateId, string TargetNo, string MsgContent, string SendTime, string strSubId)參數(shù)描述（1） TargetNo 發(fā)送手機(jī)號(hào)碼，多個(gè)號(hào)碼用逗號(hào)分開。最多支持100個(gè)號(hào)碼（2） MsgContent 發(fā)送短信內(nèi)容，最多70個(gè)字符（3） SendTime 定時(shí)發(fā)送時(shí)間，暫時(shí)為null,預(yù)留參數(shù)（4） strSubId 擴(kuò)展碼，確認(rèn)不同用戶回復(fù)返回值: SendResult自定義類 string int(是否成功由這個(gè)值確定，大于0成功其它值失敗) string int string string string成功標(biāo)識(shí) RetCode值大于0代表發(fā)送成功，返回計(jì)費(fèi)條數(shù)，否則就返回失敗代碼3.發(fā)送長(zhǎng)短信450字public SendResult FastSendLongSMS(string eid_pwd_gateId, string TargetNo, string MsgContent, string SendTime, string strSubId)解釋同【發(fā)送普通短信70字】一樣，請(qǐng)參考FastSend上面說明.4.查詢賬戶余額public string GetBalance(string eid_pwd_md5)調(diào)用成功后返回值Sms:1000,mms:1000該帳號(hào)剩余短信1000條，彩信1000條5.獲取用戶回復(fù)的短信public Woxp_UpSMS GetUpSMS(string eid_pwd_gateId)返回值， 如果有回復(fù)短信返回Woxp_UpSMS數(shù)組集合.每個(gè)數(shù)組存儲(chǔ)回復(fù)詳細(xì)信息。否則為NULL Woxp_UpSMS 自定義類型 int (上行編號(hào)，可以忽略) int (會(huì)員編號(hào)區(qū)分企業(yè)下面多個(gè)帳號(hào)) string (回復(fù)者的手機(jī)號(hào)) string (回復(fù)內(nèi)容) string (回復(fù)時(shí)間) string (用戶擴(kuò)展碼，區(qū)分哪個(gè)用戶回復(fù)) stri