彩信/視頻短信 - API文檔

1.概要

1.1 文檔說明

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

1.2 接口內(nèi)容

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

1.3 提交方式

POST

1.4 加密方式

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

1.5 api id / api key

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

1.6 彩信模版

彩信模板是對(duì)您將要發(fā)送的彩信進(jìn)行相似性提取后的內(nèi)容。

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

1.7 彩信簽名

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

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

3. 彩信批量提交接口

3.1 協(xié)議說明

3.2 請(qǐng)求地址

https://api.ihuyi.com/mms/v1/batchSend

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

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

4. 余額查詢接口

4.1 請(qǐng)求地址

https://api.ihuyi.com/mms/v1/balance

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

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

示例：

5. 彩信模板提交接口

5.1 協(xié)議說明

5.2 請(qǐng)求地址

https://api.ihuyi.com/mms/v1/templateCreate

5.3 請(qǐng)求參數(shù)(json格式，需要包含公共請(qǐng)求參數(shù))

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

6. 回執(zhí)推送

6.1 協(xié)議說明

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

響應(yīng)說明:

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

7. 模板審核推送

7.1 協(xié)議說明

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

8. 參數(shù)示例說明

8.1 內(nèi)容格式定義

1) 支持視頻、圖片、音頻和文字，圖片編碼格式為二進(jìn)制后base64，文字編碼格式為utf-8；
2) 彩信由多幀組成，同一幀中元素最多允許一段文字和一種媒體文件（即同一幀中只允許展現(xiàn)視頻、圖片、音頻中的一種媒體文件），多個(gè)媒體文件請(qǐng)分別放置在多幀中；
3) 內(nèi)容類型(con_type)支持：text(文本)、image(圖片)、audio(音頻)、video(視頻)；
4) 文件擴(kuò)展名(ext_type)支持：jpg、jpeg、png、gif、mp3、mp4。

內(nèi)容格式j(luò)son格式參考如下：

[[{"con_type":"text","ext_type":"txt","data":"這是測試文本內(nèi)容1"},{"con_type":"image","ext_type":"jpg","data":"這是base64內(nèi)容"}],[{"con_type":"text","ext_type":"txt","data":"這是測試文本內(nèi)容2"},{"con_type":"video","ext_type":"mp4","data":"這是base64內(nèi)容"}],[{"con_type":"image","ext_type":"jpg","data":"這是base64內(nèi)容"},{"con_type":"text","ext_type":"txt","data":"這是測試文本內(nèi)容3"}],[{"con_type":"audio","ext_type":"mp3","data":"test"},{"con_type":"text","ext_type":"txt","data":"這是base64內(nèi)容"}]]

9.錯(cuò)誤碼查詢