1.概要

1.1文檔說明

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

1.2接口內(nèi)容

本文檔包含短信批量提交、余額查詢、短信模板提交、回執(zhí)推送、上行推送、模板審核推送。

1.3提交方式

POST

1.4加密方式

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

1.5 api id / api key

登錄用戶中心，進入“營銷短信”模塊，在產(chǎn)品概覽頁面右側(cè)獲取，如下圖所示：

1.6短信模版

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

1.7短信簽名

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

2. 公共請求參數(shù)(json格式)

3. 短信批量提交接口

3.1協(xié)議說明

3.2請求地址

https://api.ihuyi.com/sms-yx/v1/batchSend

3.3請求參數(shù)（json格式,需要包含公共請求參數(shù)）

*product_id獲?。旱卿浀娇刂婆_，進入“云通訊 -> 營銷短信 -> 產(chǎn)品總覽 -> 我的資源包”頁面查看。

3.4返回參數(shù)(json格式)

4. 余額查詢接口

4.1請求地址

https://api.ihuyi.com/sms-yx/v1/balance

4.2請求參數(shù)（json格式,需要包含公共請求參數(shù)）

4.3返回參數(shù)(json格式)

示例：

5. 短信模板提交接口

5.1協(xié)議說明

5.2請求地址

https://api.ihuyi.com/sms-yx/v1/templateCreate

5.3請求參數(shù)(json格式,需要包含公共請求參數(shù))

5.4返回參數(shù)(json格式)

6. 回執(zhí)推送

6.1協(xié)議說明

注意：接口推送后請記錄數(shù)據(jù)并及時返回結(jié)果，業(yè)務邏輯采用異步處理，避免接口響應超時而導致重復推送。

6.2回執(zhí)數(shù)據(jù)定義

響應說明:

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

7. 上行推送

7.1協(xié)議說明

注意：接口推送后請記錄數(shù)據(jù)并及時返回結(jié)果，業(yè)務邏輯采用異步處理，避免接口響應超時而導致重復推送。

7.2回執(zhí)數(shù)據(jù)定義

響應說明:

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

8.模板審核推送

8.1協(xié)議說明

注意：接口推送后請記錄數(shù)據(jù)并及時返回結(jié)果，業(yè)務邏輯采用異步處理，避免接口響應超時而導致重復推送。

8.2模板審核數(shù)據(jù)定義

9.錯誤碼查詢