短信營銷API接口文檔下載：  點擊下載

1、概要

1.1 文檔說明

本文檔主要提供給互億通信平臺的用戶對接接口的使用說明，開發者可以利用互億通信平臺提供的 HTTP 接口，調用互億通信平臺的短信營銷服務。

1.2 接口內容

本文檔包含短信發送、余額查詢、發送回執推送、上行回復推送等。

1.3 提交方式

GET / POST

1.4 加密方式

1、采用HTTPS協議提交請求
2、通過MD5動態簽名方式加密

1.5 API ID / API KEY

登錄用戶中心，進入【短信營銷】模塊，在【產品總攬】頁面右上角

1.6 短信模版

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

您好，您的驗證碼是：666666

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

您好，您的驗證碼是：888888

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

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

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

注意：付費用戶可以通過左側導航【短信營銷】-【短信發送】-【模版管理】新增短信模板，運營商審核通過之后即可正式使用。

1.7 短信簽名

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

2、短信發送

2.1 接口描述

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

2.2 請求地址

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

2.3 請求參數

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

2.4 響應示例

示例（成功）

 2 提交成功 14745625541233112231 

示例（失?。?/p>

 405 用戶名或密碼不正確 0 

2.5 響應參數

2.6 請求示例

http://api.yx.ihuyi.com/webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機號碼&content=短信內容【簽名】

3、余額查詢

3.1 接口描述

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

3.2 請求地址

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

3.3 請求參數

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

3.4 響應示例

示例（成功）

 2 查詢成功 856 

示例（失?。?/p>

 405 用戶名或密碼不正確 0 

3.5 響應參數

3.6 GET請求示例

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

4、發送回執推送

4.1 接口描述

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

4.2 推送參數

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

5、上行回復推送

5.1 接口描述

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

5.2 推送參數

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

6、生成動態密碼方式

以PHP為例，提交短信的生成方式：

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

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手機號：138xxxxxxxx
內容：尊敬的會員，您好，夏季新品已上市，請關注。退訂回TD【互億通信】
time：1451544941
結果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx尊敬的會員，您好，夏季新品已上市，請關注。退訂回TD【互億通信】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