短信驗證碼/通知-API文檔

短信驗證碼/短信通知API接口文檔下載：點擊下載

1、概要

1.1 文檔說明

本文檔主要提供給億互通平臺的用戶對接接口的使用說明，開發(fā)者可以利用億互通平臺提供的 HTTP 接口，調(diào)用億互通平臺的短信驗證碼/通知服務(wù)。

1.2 接口內(nèi)容

本文檔包含短信發(fā)送、余額查詢、發(fā)送回執(zhí)推送、上行回復(fù)推送等。

1.3 提交方式

GET / POST

1.4 加密方式

1、采用HTTPS協(xié)議提交請求
2、通過MD5動態(tài)簽名方式加密

1.5 API ID / API KEY

登錄用戶中心，進(jìn)入【驗證碼通知短信】模塊，在產(chǎn)品總攬頁面右上角，如下圖所示：

1.6 短信模版

短信模板是對您將要發(fā)送的短信進(jìn)行相似性提取后的內(nèi)容。舉個例子，
A用戶在您平臺注冊會員，需要發(fā)送一條短信，內(nèi)容如下：

您好，您的驗證碼是：666666

同時，B用戶也在您的平臺注冊會員，發(fā)送了如下短信：

您好，您的驗證碼是：888888

我們提取相似度以后，可以制作以下短信模板：

您好，您的驗證碼是：【變量】

其中，變量是可變的，可以是數(shù)字、字母、漢字。

注意：未付費用戶僅可使用默認(rèn)短信模板，付費用戶可以通過左側(cè)導(dǎo)航【驗證碼通知短信】-【短信發(fā)送】-【簽名/模版管理】新增短信模板，運營商審核通過之后即可正式使用。

1.7 短信簽名

短信簽名是加在短信的開頭或結(jié)尾，在【】加上您的公司名稱或店鋪名稱的標(biāo)識符，例如：【億互通】。根據(jù)電信基礎(chǔ)運營商的規(guī)定，每條短信必須附加短信簽名，否則將無法正常發(fā)送。

注意：未付費用戶僅可使用默認(rèn)短信簽名【億互通】，付費用戶可以通過點擊左側(cè)導(dǎo)航【驗證碼通知短信】-【短信發(fā)送】-【簽名/模版管理】修改簽名，運營商審核通過之后即可正式使用。

2、短信發(fā)送

2.1 接口描述

通過POST、 GET 方式進(jìn)行短信提交，數(shù)據(jù)編碼采用utf-8格式，24小時全天發(fā)送。

2.2 請求地址

http://106.ihuyi.com/webservice/sms.php?method=Submit

2.3 請求參數(shù)

參數(shù)名稱	參數(shù)值描述	必填
account	APIID（請登錄用戶中心查看）	是
password	1、APIKEY（32位字符串，可以登錄用戶中心查看） 2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）	是
mobile	接收手機(jī)號碼，只能提交1個號碼	是
content	短信內(nèi)容（編碼格式為UTF-8，支持300個字的長短信，長短信按多條計費）例如：您的驗證碼是：1234。請不要把驗證碼泄露給其他人。	是
time	Unix時間戳（10位整型數(shù)字，當(dāng)使用動態(tài)密碼方式時為必填）	否
format	返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）	否

用戶通過http 或 https提交發(fā)送短信請求到服務(wù)器后，服務(wù)器會返回一串xml格式的字符串，SubmitResult結(jié)構(gòu)說明如下：

參數(shù)名稱	類型	描述
code	int	返回值為2時，表示提交成功
smsid	string	當(dāng)提交成功后，此字段為流水號，否則為0
msg	string	提交結(jié)果描述

2.4 響應(yīng)示例

示例（成功）

<?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>

2.5 響應(yīng)參數(shù)

code	msg
0	提交失敗
2	提交成功
400	非法ip訪問
401	帳號不能為空
402	密碼不能為空
403	手機(jī)號碼不能為空
4030	手機(jī)號碼已被列入黑名單
404	語音通知內(nèi)容不能為空
405	用戶名或密碼不正確
4050	賬號被凍結(jié)
4051	剩余條數(shù)不足
4052	訪問ip與備案ip不符
406	手機(jī)格式不正確
4071	沒有提交備案模板
4072	你提交過來語音內(nèi)容必須與報備過的模板格式相匹配
40722	變量內(nèi)容超過指的的長度
4073	短信內(nèi)容超出長度限制
408	您的帳戶疑被惡意利用，已被自動凍結(jié)，如有疑問請與客服聯(lián)系。

2.6 請求示例

http://106.ihuyi.com/webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機(jī)號碼&content=您的驗證碼是：1234。請不要把驗證碼泄露給其他人。

3、余額查詢

3.1 接口描述

通過接口可以方便的查詢你的賬戶驗證碼通知短信剩余條數(shù)。

3.2 請求地址

http://106.ihuyi.com/webservice/sms.php?method=GetNum

3.3 請求參數(shù)

參數(shù)名稱	參數(shù)值描述	是否必填
account	APIID（請登錄用戶中心查看）	是
password	1、APIKEY（32位字符串，可以登錄用戶中心查看） 2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）	是
time	Unix時間戳（10位整型數(shù)字，當(dāng)使用動態(tài)密碼方式時為必填）	否
format	返回格式（可選值為：xml或json，系統(tǒng)默認(rèn)為xml）	否

用戶通過http 或 https提交帳戶余額查詢請求到服務(wù)器后，服務(wù)器會返回一串xml格式的字符串，GetNumResult結(jié)構(gòu)說明如下：

參數(shù)名稱	類型	描述
code	int	狀態(tài)返回值
msg	string	查詢結(jié)果描述
num	string	剩余數(shù)量

3.4 響應(yīng)示例

示例（成功）

<?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>

3.5 響應(yīng)參數(shù)

code	msg
2	查詢成功
400	非法ip訪問
401	帳號不能為空
402	密碼不能為空
405	用戶名或密碼不正確
4050	賬號被凍結(jié)

3.6 GET請求示例

http://106.ihuyi.com/webservice/sms.php?method=GetNum&account=APIID&password=APIKEY

4、發(fā)送回執(zhí)推送

4.1 接口描述

用戶先提供數(shù)據(jù)接收地址，然后綁定到億互通系統(tǒng)后臺，平臺會以POST方式實時的將回執(zhí)信息推送到此地址。

4.2 推送參數(shù)

參數(shù)名稱	參數(shù)值描述
mobilephone	手機(jī)號碼
content	上行內(nèi)容
smsid	流水號（對應(yīng)提交時返回的smsid）（僅作參考）
reply_time	上行時間

注意: 成功接收請輸出字符 "success" （不包含引號）結(jié)束推送，否則以接收失敗處理。每個回執(zhí)最多推送3次。每次間隔疊加60秒。

5、發(fā)送回執(zhí)推送

5.1 接口描述

用戶先提供數(shù)據(jù)接收地址，然后綁定到億互通系統(tǒng)后臺，平臺會以POST方式實時的將回復(fù)信息推送到此地址。

5.2 推送參數(shù)

參數(shù)名稱	參數(shù)值描述
code	狀態(tài)值（2成功其他為失敗）
msg	回執(zhí)狀態(tài)說明
mobilephone	手機(jī)號碼
smsid	流水號（對應(yīng)提交時返回的smsid）
report_time	回執(zhí)時間