短信驗證碼/短信通知API接口文檔下載: 點擊下載
本文檔主要提供給互億通信平臺的用戶對接接口的使用說明,開發者可以利用互億通信平臺提供的 HTTP 接口,調用互億通信平臺的短信驗證碼/通知服務。
本文檔包含短信發送、余額查詢、發送回執推送、上行回復推送等。
GET / POST
1、采用HTTPS協議提交請求
2、通過MD5動態簽名方式加密
登錄用戶中心,進入【驗證碼通知短信】模塊,在產品總攬頁面右上角,如下圖所示:
短信模板是對您將要發送的短信進行相似性提取后的內容。舉個例子,
A用戶在您平臺注冊會員,需要發送一條短信,內容如下:
您好,您的驗證碼是:666666
同時,B用戶也在您的平臺注冊會員,發送了如下短信:
您好,您的驗證碼是:888888
我們提取相似度以后,可以制作以下短信模板:
您好,您的驗證碼是:【變量】
其中,變量是可變的,可以是 數字、字母、漢字。
注意:未付費用戶僅可使用默認短信模板,付費用戶可以通過左側導航【驗證碼通知短信】-【短信發送】-【簽名/模版管理】新增短信模板,運營商審核通過之后即可正式使用。
短信簽名是加在短信的開頭或結尾,在【】加上您的公司名稱或店鋪名稱的標識符,例如:【互億通信】。 根據電信基礎運營商的規定,每條短信必須附加短信簽名,否則將無法正常發送。
注意:未付費用戶僅可使用默認短信簽名【互億通信】,付費用戶可以通過點擊左側導航【驗證碼通知短信】-【短信發送】-【簽名/模版管理】修改簽名,運營商審核通過之后即可正式使用。
通過POST、 GET 方式進行短信提交,數據編碼采用utf-8格式,24小時全天發送。
http://106.ihuyi.com/webservice/sms.php?method=Submit
參數名稱 | 參數值描述 | 必填 |
account | APIID(請登錄用戶中心查看) | 是 |
password | 1、APIKEY(32位字符串,可以登錄用戶中心查看) 2、動態密碼(生成動態密碼方式請看該文檔末尾的說明) |
是 |
mobile | 接收手機號碼,只能提交1個號碼 | 是 |
content | 短信內容(編碼格式為UTF-8,支持300個字的長短信,長短信按多條計費) 例如:您的驗證碼是:1234。請不要把驗證碼泄露給其他人。 |
是 |
time | Unix時間戳(10位整型數字,當使用動態密碼方式時為必填) | 否 |
format | 返回格式(可選值為:xml或json,系統默認為xml) | 否 |
用戶通過http 或 https提交發送短信請求到服務器后,服務器會返回一串xml格式的字符串,SubmitResult結構說明如下:
參數名稱 | 類型 | 描述 |
code | int | 返回值為2時,表示提交成功 |
smsid | string | 當提交成功后,此字段為流水號,否則為0 |
msg | string | 提交結果描述 |
示例(成功)
<?xml version="1.0" encoding="utf-8"?> <SubmitResult xmlns="106.ihuyi.com"> <code>2</code> <msg>提交成功</msg> <smsid>14745625541233112231</smsid> </SubmitResult>
示例(失敗)
<?xml version="1.0" encoding="utf-8"?> <SubmitResult xmlns="106.ihuyi.com"> <code>405</code> <msg>用戶名或密碼不正確</msg> <smsid>0</smsid> </SubmitResult>
code | msg |
0 | 提交失敗 |
2 | 提交成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
403 | 手機號碼不能為空 |
4030 | 手機號碼已被列入黑名單 |
404 | 語音通知內容不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
4051 | 剩余條數不足 |
4052 | 訪問ip與備案ip不符 |
406 | 手機格式不正確 |
4071 | 沒有提交備案模板 |
4072 | 你提交過來語音內容必須與報備過的模板格式相匹配 |
40722 | 變量內容超過指的的長度 |
4073 | 短信內容超出長度限制 |
408 | 您的帳戶疑被惡意利用,已被自動凍結,如有疑問請與客服聯系。 |
http://106.ihuyi.com/webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機號碼&content=您的驗證碼是:1234。請不要把驗證碼泄露給其他人。
通過接口可以方便的查詢你的賬戶驗證碼通知短信剩余條數。
http://106.ihuyi.com/webservice/sms.php?method=GetNum
參數名稱 | 參數值描述 | 是否必填 |
account | APIID(請登錄用戶中心查看) | 是 |
password | 1、APIKEY(32位字符串,可以登錄用戶中心查看) 2、動態密碼(生成動態密碼方式請看該文檔末尾的說明) |
是 |
time | Unix時間戳(10位整型數字,當使用動態密碼方式時為必填) | 否 |
format | 返回格式(可選值為:xml或json,系統默認為xml) | 否 |
用戶通過http 或 https提交帳戶余額查詢請求到服務器后,服務器會返回一串xml格式的字符串,GetNumResult結構說明如下:
參數名稱 | 類型 | 描述 |
code | int | 狀態返回值 |
msg | string | 查詢結果描述 |
num | string | 剩余數量 |
示例(成功)
<?xml version="1.0" encoding="utf-8"?> <GetNumResult xmlns="106.ihuyi.com"> <code>2</code> <msg>查詢成功</msg> <smsid>856</smsid> </GetNumResult>
示例(失敗)
<?xml version="1.0" encoding="utf-8"?> <GetNumResult xmlns="106.ihuyi.com"> <code>405</code> <msg>用戶名或密碼不正確</msg> <smsid>0</smsid> </GetNumResult>
code | msg |
2 | 查詢成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
http://106.ihuyi.com/webservice/sms.php?method=GetNum&account=APIID&password=APIKEY
用戶先提供數據接收地址,然后綁定到互億通信系統后臺,平臺會以POST方式實時的將回執信息推送到此地址。
參數名稱 | 參數值描述 |
mobilephone | 手機號碼 |
content | 上行內容 |
smsid | 流水號(對應提交時返回的smsid)(僅作參考) |
reply_time | 上行時間 |
注意: 成功接收請輸出字符 "success" (不包含引號)結束推送,否則以接收失敗處理。每個回執最多推送3次。每次間隔疊加60秒。
用戶先提供數據接收地址,然后綁定到互億通信系統后臺,平臺會以POST方式實時的將回復信息推送到此地址。
參數名稱 | 參數值描述 |
code | 狀態值(2成功 其他為失敗) |
msg | 回執狀態說明 |
mobilephone | 手機號碼 |
smsid | 流水號(對應提交時返回的smsid) |
report_time | 回執時間 |
注意: 成功接收請輸出字符 "success" (不包含引號)結束推送,否則以接收失敗處理。每個回執最多推送3次。每次間隔疊加60秒。
以PHP為例,提交短信的生成方式:
$time = time(); $password = md5($account.$apikey.$mobile.$content.$time);
例如:
APIID: test APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d 手機號:138xxxxxxxx 內容:您的驗證碼是:2546。請不要把驗證碼泄露給其他人。 time:1451544941 結果:$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx您的驗證碼是:2546。請不要把驗證碼泄露給其他人。1451544941');
注意:因為短信內容會包含中文,所以字符編碼統一為UTF-8
查詢剩余條數的生成方式:
$time = time(); $password = md5($account.$apikey.$time);
例如:
APIID: test APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d 手機號:138xxxxxxxx time:1451544941 結果:$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');
Unix時間戳參考地址:http://tool.chinaz.com/Tools/unixtime.aspx