短信營(yíng)銷(xiāo)API接口文檔下載：  點(diǎn)擊下載

1、概要

1.1 文檔說(shuō)明

本文檔主要提供給互億通信平臺(tái)的用戶(hù)對(duì)接接口的使用說(shuō)明，開(kāi)發(fā)者可以利用互億通信平臺(tái)提供的 HTTP 接口，調(diào)用互億通信平臺(tái)的短信營(yíng)銷(xiāo)服務(wù)。

1.2 接口內(nèi)容

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

1.3 提交方式

GET / POST

1.4 加密方式

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

1.5 API ID / API KEY

登錄用戶(hù)中心，進(jìn)入【短信營(yíng)銷(xiāo)】模塊，在【產(chǎn)品總攬】頁(yè)面右上角

1.6 短信模版

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

您好，您的驗(yàn)證碼是：666666

同時(shí)，B用戶(hù)也在您的平臺(tái)注冊(cè)會(huì)員，發(fā)送了如下短信：

您好，您的驗(yàn)證碼是：888888

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

您好，您的驗(yàn)證碼是：【變量】

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

注意：付費(fèi)用戶(hù)可以通過(guò)左側(cè)導(dǎo)航【短信營(yíng)銷(xiāo)】-【短信發(fā)送】-【模版管理】新增短信模板，運(yùn)營(yíng)商審核通過(guò)之后即可正式使用。

1.7 短信簽名

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

2、短信發(fā)送

2.1 接口描述

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

2.2 請(qǐng)求地址

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

2.3 請(qǐng)求參數(shù)

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

2.4 響應(yīng)示例

示例（成功）

 2 提交成功 14745625541233112231 

示例（失敗）

 405 用戶(hù)名或密碼不正確 0 

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

2.6 請(qǐng)求示例

http://api.yx.ihuyi.com/webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機(jī)號(hào)碼&content=短信內(nèi)容【簽名】

3、余額查詢(xún)

3.1 接口描述

通過(guò)接口可以方便的查詢(xún)你的賬戶(hù)驗(yàn)證碼通知短信剩余條數(shù)。

3.2 請(qǐng)求地址

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

3.3 請(qǐng)求參數(shù)

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

3.4 響應(yīng)示例

示例（成功）

 2 查詢(xún)成功 856 

示例（失敗）

 405 用戶(hù)名或密碼不正確 0 

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

3.6 GET請(qǐng)求示例

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

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

4.1 接口描述

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

4.2 推送參數(shù)

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

5、上行回復(fù)推送

5.1 接口描述

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

5.2 推送參數(shù)

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

6、生成動(dòng)態(tài)密碼方式

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

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

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手機(jī)號(hào)：138xxxxxxxx
內(nèi)容：尊敬的會(huì)員，您好，夏季新品已上市，請(qǐng)關(guān)注。退訂回TD【互億通信】
time：1451544941
結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx尊敬的會(huì)員，您好，夏季新品已上市，請(qǐng)關(guān)注。退訂回TD【互億通信】1451544941');

注意：因?yàn)槎绦艃?nèi)容會(huì)包含中文，所以字符編碼統(tǒng)一為UTF-8

查詢(xún)剩余條數(shù)的生成方式：

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

例如：

APIID： test
APIKEY：1q784322ba1d9bb88d50cf5cdfd89k7d
手機(jī)號(hào)：138xxxxxxxx
time：1451544941
結(jié)果：$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');

Unix時(shí)間戳參考地址：http://tool.chinaz.com/Tools/unixtime.aspx