短信驗(yàn)證碼接口文檔

互億無線短信驗(yàn)證碼API中國(guó)·上海4008808898互億無線短信驗(yàn)證碼API接口說明文件標(biāo)識(shí)Ihuyi_SMSAPI-SEND版本編號(hào)V3.3發(fā)布者上海思銳信息技術(shù)有限公司發(fā)布日期2010-05-12最新更新2024-08-06

目錄192541.概要 4305601.1文檔說明 4103401.2提交方式 4299521.3加密方式 4121921.4APIID/APIKEY 482111.5短信模版 4104202.短信單條發(fā)送 541172.1接口描述 5267802.2請(qǐng)求地址 5152862.3請(qǐng)求參數(shù) 5210622.4響應(yīng)示例 6115642.5響應(yīng)參數(shù) 756702.6GET請(qǐng)求示例 8117493.短信批量發(fā)送 8285653.1接口描述 8196943.2請(qǐng)求地址 8220443.3請(qǐng)求參數(shù) 8321483.4響應(yīng)參數(shù) 925813.5傳參說明 10143434.余額查詢 10243884.1接口描述 1051204.2請(qǐng)求地址 11320944.3請(qǐng)求參數(shù) 11219534.4響應(yīng)示例 11198574.5響應(yīng)參數(shù) 12265974.6GET請(qǐng)求示例 12178055.發(fā)送回執(zhí)推送 12206965.1接口描述 129305.2推送參數(shù) 13268666.上行回復(fù)推送 1333036.1接口描述 13323946.2推送參數(shù) 13178047.提交模板 14162507.1接口描述 14155527.2請(qǐng)求地址 14153417.3請(qǐng)求參數(shù) 14288897.4響應(yīng)參數(shù) 15134207.5模板審核狀態(tài)推送 1555328.刪除模板 16137018.1接口描述 16301618.2請(qǐng)求地址 16218938.3請(qǐng)求參數(shù) 1647558.4響應(yīng)參數(shù) 17197349.生成動(dòng)態(tài)密碼方式 173020010.常見問題 181069210.1如何處理亂碼 18716210.2如何實(shí)現(xiàn)UNIX時(shí)間戳 19453511.短信DEMO 201122312.短信插件 20259113.聯(lián)系方式 22

1.概要1.1文檔說明本文檔主要提供給互億平臺(tái)的用戶對(duì)接接口的使用說明，開發(fā)者可以利用ihuyi提供的HTTP接口，調(diào)用ihuyi的短信驗(yàn)證碼/通知服務(wù)。1.2提交方式GET/POST1.3加密方式1、采用HTTPS協(xié)議提交請(qǐng)求2、通過MD5動(dòng)態(tài)簽名方式加密1.4APIID/APIKEY登錄用戶中心，進(jìn)入【驗(yàn)證碼通知短信】模塊，在【產(chǎn)品總覽】頁面右側(cè)，如下圖所示：1.5短信模版短信模板是對(duì)您將要發(fā)送的短信進(jìn)行相似性提取后的內(nèi)容。舉個(gè)例子，A用戶在您平臺(tái)注冊(cè)會(huì)員，需要發(fā)送一條短信，內(nèi)容如下：您好，您的驗(yàn)證碼是：666666同時(shí)，B用戶也在您的平臺(tái)注冊(cè)會(huì)員，發(fā)送了如下短信：您好，您的驗(yàn)證碼是：888888我們提取相似度以后，可以制作以下短信模板：您好，您的驗(yàn)證碼是：【變量】其中，變量是可變的，可以是數(shù)字、字母、漢字。注意：未付費(fèi)用戶僅可使用默認(rèn)短信模板，付費(fèi)用戶可以通過左側(cè)導(dǎo)航【驗(yàn)證碼通知短信】-【短信發(fā)送】-【簽名/模版管理】新增短信模板，運(yùn)營(yíng)商審核通過之后即可正式使用。1.6短信簽名短信簽名是加在短信的開頭或結(jié)尾，在【】加上您的公司名稱或店鋪名稱的標(biāo)識(shí)符，例如：【互億無線】。根據(jù)電信基礎(chǔ)運(yùn)營(yíng)商的規(guī)定，每條短信必須附加短信簽名，否則將無法正常發(fā)送。注意：未付費(fèi)用戶僅可使用默認(rèn)短信簽名【互億無線】，付費(fèi)用戶可以通過點(diǎn)擊左側(cè)導(dǎo)航【驗(yàn)證碼通知短信】-【短信發(fā)送】-【簽名/模版管理】修改簽名，運(yùn)營(yíng)商審核通過之后即可正式使用。2.短信單條發(fā)送2.1接口描述通過POST、GET方式進(jìn)行短信提交，數(shù)據(jù)編碼采用utf-8格式，24小時(shí)全天發(fā)送。內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded2.2請(qǐng)求地址http://106./webservice/sms.php?method=Submit2.3請(qǐng)求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID（用戶中心【驗(yàn)證碼通知短信】-【產(chǎn)品縱覽】查看）是password1、APIKEY（用戶中心【驗(yàn)證碼通知短信】-【產(chǎn)品縱覽】查看）2、動(dòng)態(tài)密碼（生成動(dòng)態(tài)密碼方式請(qǐng)看該文檔末尾的說明）是mobile接收手機(jī)號(hào)碼，只能提交1個(gè)號(hào)碼是content短信內(nèi)容（編碼格式為UTF-8，支持500個(gè)字的長(zhǎng)短信，長(zhǎng)短信按多條計(jì)費(fèi)）例如：您的驗(yàn)證碼是：1234。請(qǐng)不要把驗(yàn)證碼泄露給其他人。是timeUnix時(shí)間戳（10位整型數(shù)字，當(dāng)使用動(dòng)態(tài)密碼方式時(shí)為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）否用戶通過http或https提交發(fā)送短信請(qǐng)求到服務(wù)器后，服務(wù)器會(huì)返回一串xml格式的字符串，SubmitResult結(jié)構(gòu)說明如下：參數(shù)名稱類型描述codeint返回值為2時(shí)，表示提交成功smsidstring當(dāng)提交成功后，此字段為流水號(hào)，否則為0msgstring提交結(jié)果描述2.4響應(yīng)示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns="106."><code>2</code><msg>提交成功</msg><smsid>14745625541233112231</smsid></SubmitResult>示例（失?。?lt;?xmlversion="1.0"encoding="utf-8"?><SubmitResultxmlns="106."><code>405</code><msg>用戶名或密碼不正確</msg><smsid>0</smsid></SubmitResult>2.5響應(yīng)參數(shù)codemsg0提交失敗2提交成功400非法ip訪問401帳號(hào)不能為空402密碼不能為空403手機(jī)號(hào)碼不能為空4030手機(jī)號(hào)碼已被列入黑名單404短信內(nèi)容不能為空405APIID或APIKEY不正確4050賬號(hào)被凍結(jié)40501動(dòng)態(tài)密碼已過期40502動(dòng)態(tài)密碼校驗(yàn)失敗4051剩余條數(shù)不足4052訪問ip與備案ip不符406手機(jī)號(hào)碼格式不正確407短信內(nèi)容含有敏感字符4070簽名格式不正確4071沒有提交備案模板4072提交的短信內(nèi)容與審核通過的模板內(nèi)容不匹配40722變量?jī)?nèi)容超過指定的長(zhǎng)度【8】4073短信內(nèi)容超出長(zhǎng)度限制4074短信內(nèi)容包含emoji符號(hào)4075簽名未通過審核4077短信變量?jī)?nèi)容含有敏感字符408發(fā)送超限【50】條，已加入黑名單，可登入平臺(tái)解除4082超出同一手機(jī)號(hào)一天之內(nèi)【100】條短信限制4085同一手機(jī)號(hào)一天之內(nèi)驗(yàn)證碼短信發(fā)送超出【10】條2.6GET請(qǐng)求示例http://106./webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機(jī)號(hào)碼&content=您的驗(yàn)證碼是：1234。請(qǐng)不要把驗(yàn)證碼泄露給其他人。3.短信批量發(fā)送3.1接口描述通過POST方式進(jìn)行短信提交，數(shù)據(jù)編碼采用utf-8格式，24小時(shí)全天發(fā)送。內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded3.2請(qǐng)求地址https://106./webservice/sms.php?method=SubmitBatch3.3請(qǐng)求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID(用戶中心【驗(yàn)證碼通知短信】-【產(chǎn)品總覽】查看)是password1、APIKEY(用戶中心【驗(yàn)證碼通知短信】-【產(chǎn)品總覽】查看)2、動(dòng)態(tài)密碼(生成動(dòng)態(tài)密碼方式請(qǐng)看該文檔末尾的說明)是mobile手機(jī)號(hào)碼（可參考下文示例）是templateid模板ID選填content短信內(nèi)容選填timeUnix時(shí)間戳（10位整型數(shù)字，當(dāng)使用動(dòng)態(tài)密碼方式時(shí)為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）否sendTime定時(shí)發(fā)送時(shí)間否用戶通過http或https提交發(fā)送短信請(qǐng)求到服務(wù)器后，服務(wù)器會(huì)返回一串xml格式的字符串，SubmitBatchResult結(jié)構(gòu)說明如下：參數(shù)名稱類型描述codeint返回值為2時(shí)，表示提交成功smsidstring流水號(hào)（對(duì)應(yīng)提交時(shí)返回的smsid）msgstring回執(zhí)狀態(tài)說明3.4響應(yīng)參數(shù)codemsg0提交失敗2提交成功400非法ip訪問401帳號(hào)不能為空402密碼不能為空403手機(jī)號(hào)碼不能為空4031手機(jī)號(hào)碼必須大于1個(gè)4032手機(jī)號(hào)碼必須小于5000個(gè)404模板ID模和模板內(nèi)容二選一4041模板ID不正確405APIID或APIKEY不正確4050賬號(hào)被凍結(jié)40501動(dòng)態(tài)密碼已過期40502動(dòng)態(tài)密碼校驗(yàn)失敗40505沒有簽定合同4051剩余條數(shù)不足4052訪問ip與備案ip不符4053用戶不存在4054帳戶無效406手機(jī)號(hào)碼格式不正確407短信內(nèi)容含有敏感字符4070簽名格式不正確4074短信內(nèi)容包含emoji符號(hào)4075簽名未通過審核4077短信變量?jī)?nèi)容含有敏感字符408定時(shí)發(fā)送時(shí)間無效(大于當(dāng)時(shí)間10分鐘，小于當(dāng)前時(shí)間7天409計(jì)費(fèi)錯(cuò)誤3.5傳參說明1、不含變量手機(jī)號(hào)格式：號(hào)碼之間使用英文逗號(hào)隔開，如：136xxxx1111,136xxxx2222,136xxxx3333模板ID：對(duì)應(yīng)您在平臺(tái)報(bào)備過的模板ID，如：624452模板內(nèi)容：您有新的訂單，請(qǐng)注意查收。2、含變量手機(jī)號(hào)格式：變量之間用半|符號(hào)隔開，如：136xxxx1111|11111111|菜鳥,136xxxx2222|22222222|京東,136xxxx3333|3333333333|順豐模板ID：對(duì)應(yīng)您在平臺(tái)報(bào)備過的模板ID，如：624452模板內(nèi)容：您的訂單號(hào)是：【變量】。已由【變量】快遞發(fā)出，請(qǐng)注意查收。注意：?jiǎn)未翁峤蛔钌?個(gè)號(hào)碼，最多5000個(gè)號(hào)碼模板ID和模板內(nèi)容二選一，如果傳模板內(nèi)容或者號(hào)碼數(shù)量超過500都會(huì)進(jìn)入人工審核流程。4.余額查詢4.1接口描述通過接口可以方便的查詢你的賬戶驗(yàn)證碼通知短信剩余條數(shù)。4.2請(qǐng)求地址http://106./webservice/sms.php?method=GetNum4.3請(qǐng)求參數(shù)參數(shù)名稱參數(shù)值描述必填accountAPIID（用戶中心【驗(yàn)證碼通知短信】-【產(chǎn)品縱覽】查看）是password1、APIKEY（用戶中心【驗(yàn)證碼通知短信】-【產(chǎn)品縱覽】查看）2、動(dòng)態(tài)密碼（生成動(dòng)態(tài)密碼方式請(qǐng)看該文檔末尾的說明）是timeUnix時(shí)間戳（10位整型數(shù)字，當(dāng)使用動(dòng)態(tài)密碼方式時(shí)為必填）否format返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）否用戶通過http或https提交帳戶余額查詢請(qǐng)求到服務(wù)器后，服務(wù)器會(huì)返回一串xml格式的字符串，GetNumResult結(jié)構(gòu)說明如下：參數(shù)名稱類型描述codeint狀態(tài)返回值msgstring查詢結(jié)果描述numstring剩余數(shù)量4.4響應(yīng)示例示例（成功）<?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns="106."><code>2</code><msg>查詢成功</msg><num>856</num></GetNumResult>示例（失?。?lt;?xmlversion="1.0"encoding="utf-8"?><GetNumResultxmlns="106."><code>405</code><msg>用戶名或密碼不正確</msg><num>0</num></GetNumResult>4.5響應(yīng)參數(shù)codemsg2查詢成功400非法ip訪問401帳號(hào)不能為空402密碼不能為空405用戶名或密碼不正確4050賬號(hào)被凍結(jié)4.6GET請(qǐng)求示例http://106./webservice/sms.php?method=GetNum&account=APIID&password=APIKEY5.發(fā)送回執(zhí)推送5.1接口描述用戶先提供數(shù)據(jù)接收地址，然后綁定到互億無線系統(tǒng)后臺(tái)，平臺(tái)會(huì)以POST方式實(shí)時(shí)的將回執(zhí)信息推送到此地址，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。5.2推送參數(shù)參數(shù)名稱參數(shù)值描述code狀態(tài)值（2成功其他為失?。﹎sg回執(zhí)狀態(tài)說明mobilephone手機(jī)號(hào)碼smsid流水號(hào)（對(duì)應(yīng)提交時(shí)返回的smsid）report_time回執(zhí)時(shí)間例：2017-08-0214:31:51注意:成功接收請(qǐng)輸出字符“success”（不包含引號(hào)）結(jié)束推送，否則以接收失敗處理。每個(gè)回執(zhí)最多推送3次。每次間隔疊加60秒。6.上行回復(fù)推送6.1接口描述用戶先提供數(shù)據(jù)接收地址，然后綁定到互億無線系統(tǒng)后臺(tái)，平臺(tái)會(huì)以POST方式實(shí)時(shí)的將回復(fù)信息推送到此地址，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。6.2推送參數(shù)參數(shù)名稱參數(shù)值描述mobilephone手機(jī)號(hào)碼content上行內(nèi)容smsid流水號(hào)（對(duì)應(yīng)提交時(shí)返回的smsid）（僅作參考）reply_time上行時(shí)間例：2017-05-2417:46:50注意:成功接收請(qǐng)輸出字符“success”（不包含引號(hào)）結(jié)束推送，否則以接收失敗處理。每個(gè)回執(zhí)最多推送3次。每次間隔疊加60秒。7.提交模板7.1接口描述通過POST、GET方式提交短信模版，數(shù)據(jù)編碼采用utf-8格式，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。7.2請(qǐng)求地址http://106./webservice/sms.php?method=AddTemplate&account=APIID&password=APIKEY&content=【互億無線】尊敬的會(huì)員，您好，夏季新品已上市，請(qǐng)關(guān)注。退訂回TD7.3請(qǐng)求參數(shù)參數(shù)名稱參數(shù)值描述methodAddTemplateaccount提交賬戶password提交賬戶密碼（可以明文密碼或使用32位MD5加密）content模板內(nèi)容type1驗(yàn)證碼2通知scene使用場(chǎng)景返回值A(chǔ)ddTemplateResult結(jié)構(gòu)說明：參數(shù)名稱類型描述codeint返回值為2時(shí)，表示添加成功msgstring提交狀態(tài)描述templateidint添加成功則返回模板ID7.4響應(yīng)參數(shù)codemsg2添加成功400非法ip訪問401用戶名不能為空402密碼不能為空404模板內(nèi)容不能為空405用戶名或密碼不正確4050賬號(hào)被凍結(jié)407模板內(nèi)容含有敏感字符7.5模板審核狀態(tài)推送在遵守HTTP協(xié)議規(guī)范的前提下，通過POST方式將回執(zhí)推送到用戶指定的URL地址，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。參數(shù)說明：參數(shù)名稱參數(shù)值描述code狀態(tài)值（2成功0駁回）msg審核狀態(tài)描述templateid模板ID注意：1.成功接收請(qǐng)輸出字符“success”（不包含引號(hào)）結(jié)束推送，否則以接收失敗處理。2.每個(gè)回執(zhí)最多推送3次。每次間隔疊加60秒。3.code值說明2成功0駁回（原因請(qǐng)看msg字段）8.刪除模板8.1接口描述通過POST、GET方式提交短信模版，數(shù)據(jù)編碼采用utf-8格式，內(nèi)容格式為：Content-Type:application/x-www-form-urlencoded。8.2請(qǐng)求地址http://106./webservice/sms.php?method=DelTemplate&account=APIID&password=APIKEY&templateid=1238.3請(qǐng)求參數(shù)參數(shù)名稱參數(shù)值描述methodDelTemplateaccount提交賬戶password提交賬戶密碼（可以明文密碼或使用32位MD5加密）templateid模板id返回值A(chǔ)ddTemplateResult結(jié)構(gòu)說明：參數(shù)名稱類型描述codeint返回值為2時(shí)，表示刪除成功msgstring提交狀態(tài)描述8.4響應(yīng)參數(shù)codemsg2刪除成功400非法ip訪問401用戶名不能為空402密碼不能為空404模板ID不能為空或模板ID不存在405用戶名或密碼不正確4050賬號(hào)被凍結(jié)9.生成動(dòng)態(tài)密碼方式以PHP為例，提交短信的生成方式：$time=time();$password=md5($account.$apikey.$mobile.$content.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機(jī)號(hào)：138xxxxxxxx內(nèi)容：您的驗(yàn)證碼是：2546。請(qǐng)不要把驗(yàn)證碼泄露給其他人。time：1451544941結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx您的驗(yàn)證碼是：2546。請(qǐng)不要把驗(yàn)證碼泄露給其他人。1451544941');注意：因?yàn)槎绦艃?nèi)容會(huì)包含中文，所以字符編碼統(tǒng)一為UTF-8查詢剩余條數(shù)的生成方式：$time=time();$password=md5($account.$apikey.$time);例如：APIID：testAPIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d手機(jī)號(hào)：138xxxxxxxxtime：1451544941結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');Unix時(shí)間戳參考地址：/Tools/unixtime.aspx10.常見問題10.1如何處理亂碼說明：將短信內(nèi)容（content）進(jìn)行UTF-8編碼后提交。PHP亂碼：$content=iconv("GBK","UTF-8",$content);JAVA亂碼：sb.append("&content="+URLEncoder.encode(content,"UTF-8"));C#亂碼：byte[]bTemp=System.Text.Encoding.GetEncoding("GBK").GetBytes(sbTemp.ToString());10.2如何實(shí)現(xiàn)UNIX時(shí)間戳語言代碼JAVAStringdate=newjava.text.SimpleDateFormat("dd/MM/yyyyHH:mm:ss").format(newjava.util.Date(Unixtimestamp*1000))Linuxdate-d@UnixtimestampCstrptime(datetime,"%Y-%m-%d%H:%M:%S",&tm_time);unixtime=mktime(&tm_time);C++std::time_tt=std::time(0);DELPHIusesDateUtils;DateTimeToUnix(Now)GOimport"time"cur:=time.Now()timestamp:=cur.UnixNano()/1000000Perl先my$time=Unixtimestamp然后my($sec,$min,$hour,$day,$month,$year)=(localtime($time))[0,1,2,3,4,5,6]PHPdate('r',Unixtimestamp)Node.jsvardate=newDate(time*1000);vartime=date.getTime()/1000;Python先importtime然后time.gmtime(Unixtimestamp)RubyTime.at(Unixtimestamp)SHELLdate+%s//UNIX的時(shí)間戳;VBScript/ASPDateAdd("s",Unixtimestamp,"01/01/197000:00:00")VB6DateDiff("s","1970-1-10:0:0",ToUnixTime)易語言時(shí)間_到時(shí)間戳（）11.短信DEMO語言DEMO地址PHP/demo/sms/php.htmlJAVA/demo/sms/java.htmlASP/demo/sms/asp.htmlASP.NET(C#)/demo/sms/aspx.htmlJSP/demo/sms/jsp.htmlC/demo/sms/c.htmlC++/demo/sms/cpp.htmlDELPHI/demo/sms/delphi.htmlGO/demo/sms/go.htmlNODE.JS/demo/sms/nodejs.htmlPYTHON/demo/sms/python.htmlRUBY/demo/sms/ruby.htmlSHELL/demo/sms/shell.htmlVB6/demo/sms/vb6.html易語言/demo/sms/eyuyan.html12.短信插件語言下載地址ECtouch