短信api接口

1、概要

1.1 文檔說明

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

1.2 接口內容

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

1.3 提交方式

GET / POST

1.4 加密方式

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

1.5 API ID / API KEY

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

1.6 短信模版

短信模板是對您將要發(fā)送的短信進行相似性提取后的內容。舉個例子，

A 用戶在您平臺注冊會員，需要發(fā)送一條短信，內容如下:

您好，您的驗證碼是:666666

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

您好，您的驗證碼是:888888

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

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

其中，變量是可變的，可以是 數字、字母、漢字。

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

1.7 短信簽名

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

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

2、短信發(fā)送

2.1 接口描述

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

2.2 請求地址

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

2.3 請求參數

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

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

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

2.4 響應示例

示例（成功）

  2         提交成功 14745625541233112231 

示例（失?。?/p>

  405 用戶名或密碼不正確 0     

2.5 響應參數

 

code	msg
0	提交失敗
2	提交成功
400	非法ip訪問
401	帳號不能為空
402	密碼不能為空
403	手機號碼不能為空
4030	手機號碼已被列入黑名單
404	短信內容不能為空
405	API ID 或 API KEY 不正確
4050	賬號被凍結
40501	動態(tài)密碼已過期
40502	動態(tài)密碼校驗失敗
4051	剩余條數不足
4052	訪問 ip 與備案 ip 不符
406	手機格式不正確
407	短信內容含有敏感字符
4070	簽名格式不正確
4071	簽名格式不正確
4072	簽名格式不正確
40722	變量內容超過指定的長度【8】
4073	短信內容超出長度限制
4074	短信內容包含 emoji 符號
4075	簽名未通過審核
408	發(fā)送超限([20]條)，已加入黑名單，可登入平臺解除
4080	同一手機號碼同一秒鐘之內發(fā)送頻率不能超過 1 條
4082	超出同一手機號一天之內【5】條短信限制
4085	同一手機號驗證碼短信發(fā)送超出【5】條

2.6 請求示例

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

3、余額查詢

3.1 接口描述

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

3.2 請求地址

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

3.3 請求參數

參數名稱	參數值描述	是否必填
account	APIID（請登錄用戶中心【驗證碼通知短信】-【產品縱覽】查看）	是
password	1、APIKEY（請登錄用戶中心【驗證碼通知短信】-【產品縱覽】查看） 2、動態(tài)密碼（生成動態(tài)密碼方式請看該文檔末尾的說明）	是
time	Unix時間戳（10位整型數字，當使用動態(tài)密碼方式時為必填）	否
format	返回格式（可選值為：xml或json，系統(tǒng)默認為xml）	否

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

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

3.4 響應示例

示例（成功）

  2 查詢成功 856         

示例（失?。?/p>

  405 用戶名或密碼不正確 0 

3.5 響應參數

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

3.6 GET請求示例

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

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

4.1 接口描述

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

4.2 推送參數

參數名稱	參數值描述
code	狀態(tài)值（2成功 其他為失?。?/td>
msg	回執(zhí)狀態(tài)說明
mobilephone	手機號碼
smsid	流水號（對應提交時返回的smsid）
report_time	回執(zhí)時間 例:2017-08-02 14:31:51

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

5、上行回復推送

5.1 接口描述

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

5.2 推送參數

參數名稱	參數值描述
mobilephone	手機號碼
content	上行內容
smsid	流水號(對應提交時返回的 smsid)(僅作參考)
reply_time	上行時間 例:2017-05-24 17:46:50

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

6、提交模板

6.1 接口描述

通過 POST、 GET 方式提交短信模版，數據編碼采用 utf-8 格式，24 小時全天發(fā)送。

6.2 請求地址

http://106.ihuyi.com/webservice/sms.php?method=AddTemplate&account=APIID&password=APIKEY&content=您的驗證碼是:【變量】。請不要把驗證碼泄露給其他人。

6.3 請求參數

參數名稱	參數值描述
method	AddTemplate
account	提交賬戶
password	提交賬戶密碼 (可以明文密碼或使用 32 位 MD5 加密)
模板內容	模板內容

返回值 AddTemplateResult 結構說明:

參數名稱	類型	描述
code	int	返回值為 2 時，表示添加成功
msg	string	提交狀態(tài)描述
templateid	int	添加成功則返回模板 ID

6.4 響應參數

code	msg
2	添加成功
400	提交狀態(tài)描述
401	添加成功則返回模板 ID
402	密碼不能為空
404	模板內容不能為空
405	用戶名或密碼不正確
4050	賬號被凍結
407	模板內容含有敏感字符

6.5 模板審核狀態(tài)推送

在遵守 HTTP 協(xié)議規(guī)范的前提下，通過 POST 方式將回執(zhí)推送到用戶指定的 URL 地址。

參數說明:

參數名稱	參數值描述
code	狀態(tài)值(2 成功 0 駁回)
msg	審核狀態(tài)描述
templateid	模板 ID

注意:

1.成功接收請輸出字符 “success” (不包含引號)結束推送，否則以接收失敗處理。

2.每個回執(zhí)最多推送 3 次。每次間隔疊加 60 秒。

3.code 值說明

2 成功

0 駁回(原因請看 msg 字段)

7、生成動態(tài)密碼方式

以PHP為例，提交語音驗證碼的生成方式：

$time = time();
$password = md5($account.$apikey.$mobile.$content.$time);

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手機號：138xxxxxxxx
內容：您的驗證碼是:2546。請不要把驗證碼泄露給其他人。
time：1451544941
結果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx 您的 驗證碼是:2546。請不要把驗證碼泄露給其他人。1451544941');

注意:因為短信內容會包含中文，所以字符編碼統(tǒng)一為 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

8、常見問題

8.1 如何處理亂碼

說明: 將短信內容( content)進行 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());

8.2 如何實現 UNIX 時間戳

語言	代碼
JAVA	String date = new java.text.SimpleDateFormat("dd/MM/yyyy HH:mm:ss").format(new java.util.Date(Unix timestamp *1000))
Linux	date -d @Unix timestamp
C	strptime(datetime, "%Y-%m-%d %H:%M:%S", &tm_time); unixtime = mktime(&tm_time);
C++	std::time_t t = std::time(0);
DELPHI	uses DateUtils; DateTimeToUnix(Now)
GO	import "time" cur := time.Now() timestamp := cur.UnixNano() / 1000000
Perl	先 my $time = Unix timestamp 然后 my ($sec, $min, $hour, $day, $month, $year) = (localtime($time))[0,1,2,3,4,5,6]
PHP	date('r', Unix timestamp)
Node.js	var date = new Date( time * 1000 ); var time = date.getTime()/1000;
Python	先 import time 然后 time.gmtime(Unix timestamp)
Ruby	Time.at(Unix timestamp)
SHELL	date +%s //UNIX 的時間戳;
VBScript / ASP	DateAdd("s", Unix timestamp, "01/01/1970 00:00:00")
VB6	DateDiff("s", "1970-1-1 0:0:0", ToUnixTime)
易語言	時間_到時間戳()

9、短信插件

語言	DEMO 地址
ECtouch	http://422ajvm.cn/plugin/sms/ectouch.html
ECshop	http://422ajvm.cn/plugin/sms/ecshop.html
Dedecmsv5.7	http://422ajvm.cn/plugin/sms/dedecms57.html
小京東 v4.2	http://422ajvm.cn/plugin/sms/jd.html
快捷訂餐系統(tǒng)	http://422ajvm.cn/plugin/sms/kjcms.html
方維 p2p v2.7	http://422ajvm.cn/plugin/sms/fanwe_v2.7.html
方維 p2p v3.0	http://422ajvm.cn/plugin/sms/fanwe_v3.html
方維團購	http://422ajvm.cn/plugin/sms/fanwe_tuangou.html
ShopNC	http://422ajvm.cn/plugin/sms/shopnc.html
Astgo	http://422ajvm.cn/plugin/sms/astgo.html
Iwebshop	http://422ajvm.cn/plugin/sms/iwebshop.html
Kppw 威客系統(tǒng)	http://422ajvm.cn/plugin/sms/kppw.html
Phpyun	http://422ajvm.cn/plugin/sms/phpyun.html
芝麻樂	http://422ajvm.cn/plugin/sms/zhimale.html
小京東 v5.0	http://422ajvm.cn/plugin/sms/xjd5.html
騎士人才系統(tǒng)	http://422ajvm.cn/plugin/sms/qscms_v4.1.html
友價源碼系統(tǒng)	http://422ajvm.cn/plugin/sms/yj.html
ThinkSNS	http://422ajvm.cn/plugin/sms/thinksns.html
小豬生活通 o2o	http://422ajvm.cn/plugin/sms/pigo2o.html
CmsEasy	http://422ajvm.cn/plugin/sms/cmseasy.html
Wordpress v4.0	http://422ajvm.cn/plugin/sms/wordpress4.html
TPShop	http://422ajvm.cn/plugin/sms/tpshop.html
微贊微信管理系統(tǒng)	http://422ajvm.cn/plugin/sms/weizan.html
微米 CMS	http://422ajvm.cn/plugin/sms/weimi.html
Destoon	http://422ajvm.cn/plugin/sms/Destoonb2b_V6.0.html
ECmall	http://422ajvm.cn/plugin/sms/ecmall_V2.3.html
方維 p2p v3.6	http://422ajvm.cn/plugin/sms/fanwe_v3.6.html
得推校園 O2O	http://422ajvm.cn/plugin/sms/detuio2o.html
微橙-人人店	http://422ajvm.cn/plugin/sms/weicheng.html