助通-SMS短信平臺(tái)(HTTP方式-推薦)接口開(kāi)發(fā)文檔

1、上海助通信息科技有限公司SMS接口開(kāi)發(fā)文檔V: 20160508目錄API接口說(shuō)明 1（HTT叨式）接口 11、普通短信 22、變量短信 43、余額查詢(xún) 64、狀態(tài)報(bào)告 75、回復(fù)內(nèi)容接口 96、發(fā)送量數(shù)據(jù)報(bào)表提取 12API接口說(shuō)明（HTTP方式）接口1、普通短信提交地址：接口提交方式：GET/POST功能：發(fā)送短信輸入?yún)?shù)描述提交urlusername用戶名（必填）tkey當(dāng)前時(shí)間（必填，24 小時(shí)制），格式： yyyyMMddHHmms颯如：2016031513053Q客戶時(shí)間早于或晚于網(wǎng)關(guān)時(shí)間超過(guò) 30分鐘，則網(wǎng)關(guān)拒絕提交。password密碼(必填)：md5( md5(passwor

2、d) + tkey)其中“ +”表示字符串連接。即：先對(duì)密碼進(jìn)行md5加密，將結(jié)果與tkey值合并，再進(jìn)行一次 md5加密。兩次md5加密后字符串都需轉(zhuǎn)為小寫(xiě)。例如：若當(dāng)前時(shí)間為 2016-03-1512:05:30,密碼為123456,貝U： password=md5(md5( 123456”)+ 20160315120530 )貝U: password =md5(e10ade3949ba59abbe56e057f20f883e 20160315120530則：password = ea8b8077f748b2357ce635b9f49b7abemobile手機(jī)號(hào)（必填，最多支持2000個(gè)號(hào)

3、碼）content發(fā)送內(nèi)容（必填，最好不要包含空格和回車(chē)，最多支持 500個(gè)字，一 個(gè)內(nèi)容里面只能包含一個(gè)簽名，如：內(nèi)容【簽名】）productid產(chǎn)品id（必填，/、同的產(chǎn)品用于發(fā)/、同類(lèi)型的信息）xh擴(kuò)展的小號(hào)，必須為數(shù)字，沒(méi)有請(qǐng)留空。注意：若為多簽名用戶，又無(wú)法確保所提交簽名與擴(kuò)展號(hào)一一對(duì)應(yīng)， 參數(shù)xh=0o所發(fā)送簽名和擴(kuò)展號(hào)需要提前報(bào)備， SMS1信平臺(tái)系統(tǒng) 會(huì)根據(jù)簽名自動(dòng)加上擴(kuò)展號(hào)。樣例: 用戶名 &password= 3?碼 &tkey=20160324151338&mobile=手機(jī)號(hào) &content=此次登錄驗(yàn)證碼 123456【助通 科技】&

4、amp;productid=產(chǎn)品 id&xh=其中：content參數(shù)，采用下列方式處理：/ String content ="漢字"/ content = URLEncoderencode(content, "UTF-8");返回參數(shù)描述-1用戶名或者密碼不止確或用戶禁用或者是管理賬戶1,xxxxxxxx1代表發(fā)送短信成功，xxxxxxxx代表消息編號(hào)（消息ID, 在匹配狀態(tài)報(bào)告時(shí)會(huì)用到）0,xxxxxxxx0發(fā)送短信失敗,xxxxxxxx代表消息編號(hào)2余額/、夠或扣費(fèi)錯(cuò)誤3扣費(fèi)失敗異常（請(qǐng)聯(lián)系客服）6啟效號(hào)碼為空7短信內(nèi)谷為空8無(wú)簽名，必須，

5、格式：【簽名】9沒(méi)有Url提交權(quán)限10發(fā)送號(hào)碼過(guò)多，最多支持2000個(gè)號(hào)碼11產(chǎn)品ID異?；虍a(chǎn)品禁用12參數(shù)異常13tkey參數(shù)錯(cuò)誤15Ip驗(yàn)證失敗16xh參數(shù)錯(cuò)誤19短信內(nèi)容過(guò)長(zhǎng)，最多支持500個(gè)，或提交編碼異常導(dǎo)致2、變量短信一般變量提交地址： （如果提交的 是一個(gè)內(nèi)容，SM繇統(tǒng)會(huì)按照單內(nèi)容多號(hào)碼方式提交）接口提交方式：POST （get不支持大數(shù)據(jù)）功能：發(fā)送短信短信簽名（重要）：如果用戶發(fā)送的內(nèi)容最后一個(gè)字符為，默認(rèn)為用戶已經(jīng)增加了簽名，否則自動(dòng)追加用戶在平臺(tái)中設(shè)置的簽名到發(fā)送的內(nèi)容最后。格式：“【簽名】”，系統(tǒng)自動(dòng)追加的簽名中，會(huì)自動(dòng)增加“【】”，內(nèi)容 為用戶設(shè)置的內(nèi)容。一個(gè)內(nèi)容中只

6、能有一個(gè)簽名。變量短信只支持單條多任務(wù)發(fā) 送，不支持群發(fā)多任務(wù)發(fā)送輸入?yún)?shù)描述username用戶名（必填）tkey當(dāng)前時(shí)間（必填，24 小時(shí)制），格式：yyyyMMddHHmms颯如：2016031513053Q客戶時(shí)間早于或晚于網(wǎng)關(guān)時(shí)間超過(guò) 30分鐘,則網(wǎng)關(guān)拒絕提交。password密碼(必填)：md5( md5(password) + tkey)其中“ +”表示字符串連接。即：先對(duì)密碼進(jìn)行md5加密，將結(jié)果與 tkey值合并，再進(jìn)彳亍-次 md5加密。兩次md5加密后字符串都需轉(zhuǎn)為小寫(xiě)。例如： ”前時(shí)間為 2016-03-1512:05:30,密碼為 123456,貝U： passwor

7、d =md5(md5( 123456”)+ 20160315120530 )貝U: password =md5(e10ade3949ba59abbe56e057f20f883e 20160315120530)則：password = ea8b8077f748b2357ce635b9f49b7abecontent發(fā)送內(nèi)容多個(gè)內(nèi)容用 分開(kāi)，如短信1【簽名】短信2【簽名】 （必填，最多200個(gè)，一個(gè)內(nèi)容里面只能包含一個(gè)簽名）mobile手機(jī)號(hào)，多個(gè)手機(jī)號(hào)為用13688888888（最多 200 個(gè),忤角，分開(kāi)，如 必填）productid產(chǎn)品id（必填）xh擴(kuò)展的小號(hào)，必須

8、為數(shù)字，沒(méi)有請(qǐng)留空。注意：若為多簽名用戶，又無(wú)法確保所提交簽名與擴(kuò)展號(hào)一一對(duì)應(yīng)， 參數(shù)xh=0o所發(fā)送簽名和擴(kuò)展號(hào)需要提前報(bào)備，SM則信平臺(tái)系統(tǒng) 會(huì)根據(jù)簽名自動(dòng)加上擴(kuò)展號(hào)。樣例: &password=3?55 &tkey=20160324151338&mobile二手機(jī)號(hào) 1,手機(jī)號(hào) 2&content"短信 1【簽名】 短信2【簽名】&productid=產(chǎn)品id&xh=手機(jī)號(hào)與內(nèi)容的條數(shù)必須相同，否則會(huì)發(fā)送失敗。其中：content參數(shù)，采用下列方式處理:/ String content ="漢字"/ conte

9、nt = URLEncoder.encode(content, "UTF-8");返回參數(shù)描述-1用戶名或者密碼不止確或用戶禁用或者是管理賬戶1,xxxxxxxx1代表發(fā)送短信成功，xxxxxxxx代表消息編號(hào)（消息ID）0,xxxxxxxx0發(fā)送短信失敗,xxxxxxxx代表消息編號(hào)2余額不夠3扣費(fèi)失?。ㄕ?qǐng)聯(lián)系客服）6啟效號(hào)碼為空7短信內(nèi)谷為空8無(wú)簽名，必須，格式：【簽名】9沒(méi)有Url提交權(quán)限10號(hào)碼有誤；發(fā)送號(hào)碼過(guò)多，最多支持200個(gè)號(hào)碼11產(chǎn)品ID異常12參數(shù)異常13tkey參數(shù)錯(cuò)誤14提交手機(jī)號(hào)碼數(shù)和內(nèi)容數(shù)不對(duì)等15Ip驗(yàn)證失敗16xh參數(shù)錯(cuò)誤19短信內(nèi)容過(guò)長(zhǎng)，最多

10、支持500個(gè)3、余額查詢(xún)提交地址：余額接口提交方式：GET/POST功能：查詢(xún)短信剩余數(shù)量輸入?yún)?shù)描述username用戶名tkey當(dāng)前時(shí)間（必填，24 小時(shí)制），格式：yyyyMMddHHmms颯如：20160315130530=客戶時(shí)間早于或晚于網(wǎng)關(guān)時(shí)間超過(guò) 30分鐘,則網(wǎng)關(guān)拒絕提交。password密碼(必填)：md5( md5(password) + tkey)其中“ +”表示字符串連接。即：先對(duì)密碼進(jìn)行md5加密，將結(jié)果與 tkey值合并，再進(jìn)彳亍-次 md5加密。兩次md5加密后字符串都需轉(zhuǎn)為小寫(xiě)。例如： ”前時(shí)間為 2016-03-1512:05:30,密碼為 123456,貝U

11、： password =md5(md5( 123456”)+ 20160315120530 )貝U: password =md5(e10adc3949ba59abbe56e057f20f883e 2016031512053。則：password = ea8b8077f748b2357ce635b9f49b7abe樣例: ey=2016xxxxxxxxxx返回參數(shù)描述200200代表短信的數(shù)量-1用戶名或者密碼/、止確-2tkey不止確-3用戶不存在或用戶停用4、狀態(tài)報(bào)告狀態(tài)報(bào)告接口提交方式：GET/POST功能：ZT平臺(tái)會(huì)實(shí)時(shí)把發(fā)送的消息報(bào)告推送到用戶配置的下行地址中。用 戶獲取網(wǎng)關(guān)發(fā)送的數(shù)據(jù)

12、，接收成功返回0,接收不到數(shù)據(jù)返回非0推送后用戶方?jīng)]有返回值，ZT平臺(tái)默認(rèn)推送三次后，不再推送方式1 :批量推送方式（客服設(shè)置）間隔5秒/次此方式需要用戶在ZT平臺(tái)填寫(xiě)下行地址我平臺(tái)每次返回400（最大）組內(nèi)容，客戶被動(dòng)接收狀態(tài)報(bào)告并解析之推送 URM式： 例如：17521381,1,2015-11-06 15:28:56param參數(shù)規(guī)則如下：消息ID,手機(jī)號(hào)碼，狀態(tài)，時(shí)間；消息ID,手機(jī)號(hào)碼,狀態(tài)，時(shí)間說(shuō)明：每一組中由消息ID,手機(jī)號(hào)碼，狀態(tài)，時(shí)間組成，并由英文，分 開(kāi)，每一組之間又由英文；分開(kāi)返回參數(shù)消息報(bào)告參數(shù)描述param包括推送的消息id包括推送的手機(jī)包括返回的狀態(tài)。1代表成功，非

13、1代表失敗（為失敗代 碼）包括狀態(tài)時(shí)間,格式為：yyyyMMddHHmmss用戶接收成功需要向SMSF臺(tái)返回0方式2:主動(dòng)提取狀態(tài)報(bào)告（客服設(shè)置）我平臺(tái)每次返回400（最大）組內(nèi)容，客戶被動(dòng)接收狀態(tài)報(bào)告并解析之, 時(shí)間間隔最好定為1分鐘左右，輸入?yún)?shù)包括用戶名和密碼輸入?yún)?shù)描述username用戶名tkey當(dāng)前時(shí)間（必填,24 小時(shí)制），格式：yyyyMMddHHmms颯如：2016031513053Q客戶時(shí)間早于或晚于網(wǎng)關(guān)時(shí)間超過(guò) 30分鐘,則網(wǎng)關(guān)拒絕提交。password密碼(必填):md5( md5(password) + tkey)其中“ +”表示字符串連接。即：先對(duì)密碼進(jìn)行md5加密

14、，將結(jié)果與 tkey值合并，再進(jìn)彳亍-次 md5加密。兩次md5加密后字符串都需轉(zhuǎn)為小寫(xiě)。例如： ”前時(shí)間為2016-03-1512:05:30,密碼為 123456,貝U： password =md5(md5( 123456”)+ 20160315120530 )貝U: password =md5(e10adc3949ba59abbe56e057f20f883e 2016031512053。則：password = ea8b8077f748b2357ce635b9f49b7abe提 取 URL 地 址： 例 如tkey=2016xxxxxxxxxx說(shuō)明：每一組中由消息ID,手機(jī)號(hào)碼，狀態(tài)，時(shí)

15、間組成，并由英文，分 開(kāi)，每一組之間又由英文；分開(kāi)返回參數(shù)消息報(bào)告參數(shù)描述非空字符串包括推送的消息id包括推送的手機(jī)包括返回的狀態(tài)。1代表成功，非1代表失?。槭〈a）包括狀態(tài)時(shí)間,格式為：yyyy-MM-dd HH:mm:ss-4tkey不止確-3異常情況-2沒(méi)有可取數(shù)據(jù)-1用戶名或密碼錯(cuò)誤5、回復(fù)內(nèi)容接口回復(fù)接口提交方式：GET功能：獲取上行內(nèi)容，ZT平臺(tái)會(huì)自動(dòng)實(shí)時(shí)的推送用戶手機(jī)回復(fù)的內(nèi)容到上 行地址中。推送后用戶方?jīng)]有返回值，ZT平臺(tái)默認(rèn)推送三次后，不再推送。注：回復(fù)是手機(jī)到網(wǎng)關(guān)，網(wǎng)關(guān)到我們的系統(tǒng)。從手機(jī)到網(wǎng)關(guān)只有手機(jī)號(hào)可用 于識(shí)別網(wǎng)關(guān)到我們的系統(tǒng)，我們系統(tǒng)中的消息 ID,是取的這號(hào)碼

16、的最新的消息 ID,只能做參考用。用手機(jī)號(hào)碼匹配消息ID參考使用。方式1 :推送方式此方式需要在ZT短信平臺(tái)中填寫(xiě)上行地址上行皿WriBd wiWW號(hào)K- * 二.京閩電事a也看：上號(hào)用飛-l/JtBat： I3. . 乩電I毛加工|» if 史國(guó)例如： 推送URL格式:mobile=xxxx&content=xxxxx&msgid=xxxxx&xh=xxxxx;返回參數(shù)回復(fù)內(nèi)容參數(shù)描述msgid回復(fù)的消息idmobile回復(fù)的手機(jī)號(hào)碼content手機(jī)回復(fù)的內(nèi)容xh推送的用戶小號(hào)一次推送一個(gè)號(hào)碼，mobile指手機(jī)號(hào)，content指回復(fù)的內(nèi)容，msgid

17、指上行對(duì)應(yīng)的msgid, xh代表擴(kuò)展號(hào)碼。用戶接收回復(fù)內(nèi)容成功，需要向 SMSF臺(tái)返回0回復(fù)內(nèi)容接口推送的內(nèi)容樣例內(nèi)容,12121209876512,1023 ;方式2:主動(dòng)提取時(shí)間間隔最好定為1分鐘左右，此方式需要在ZT短信平臺(tái)中填寫(xiě)上行地 址，地址一定要標(biāo)記填寫(xiě)為：initiative-grab-reply上HfcttteWW-g*輸入?yún)?shù)包括用戶名和密碼輸入?yún)?shù)描述username用戶名tkey當(dāng)前時(shí)間（必填，24 小時(shí)制），格式：yyyyMMddHHmms颯如：2016031513053Q客戶時(shí)間早于或晚于網(wǎng)關(guān)時(shí)間超過(guò) 30分鐘,則網(wǎng)關(guān)拒絕提交。passwo

18、rd密碼(必填)：md5( md5(password) + tkey)其中“ +”表示字符串連接。即：先對(duì)密碼進(jìn)行md5加密，將結(jié)果與 tkey值合并，再進(jìn)彳亍-次 md5加密。兩次md5加密后字符串都需轉(zhuǎn)為小寫(xiě)。例如： ”前時(shí)間為 2016-03-1512:05:30,密碼為 123456,貝U： password =md5(md5( 123456”)+ 20160315120530 )貝U: password =md5(e10adc3949ba59abbe56e057f20f883e 20160315120530則：password = ea8b8077f748b2357ce635b9f49b7abe提取地址： =2016xxxxxxxxxx說(shuō)明：返回格式為：手機(jī)號(hào)，內(nèi)容，消息ID,小號(hào)，時(shí)間，他們之間以r分開(kāi)，分組之間以回分開(kāi),最大返回50組內(nèi)容。，只能取一次返回參數(shù)非空內(nèi)容回復(fù)內(nèi)容參數(shù)描述格式說(shuō)明：手機(jī)號(hào)r內(nèi)容r消息IDr小號(hào)r時(shí)間p 手機(jī)號(hào)r內(nèi)容r消息IDr小號(hào)r時(shí)間-4tkey不止確-3異常情況-2沒(méi)有可取數(shù)據(jù)-1用戶名或密碼錯(cuò)誤6、發(fā)送量數(shù)據(jù)報(bào)表提取查 詢(xún) 地 址： 提 交 地 址 key=2016xxxxxxxxxx&dstime=201