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

1.概要

1.1 文檔說明

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

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 彩信模版

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

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

1.7 彩信簽名

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

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

參數(shù)	類型	是否必填	說明
api_id	string	是	Api的ID 如:2RYN7CQHL1M*****
signature	string	是	請求驗證加密簽名(非彩信簽名)； 簽名生成方式： 僅公共參數(shù)以ASCII碼從小到大排序值，key=value，多值以"&"隔開，拼接之后md5 32位小寫； 如：md5(api_id=xxxx&api_key=xxxx&request_id=xxxx×tamp=xxxxxxx)
timestamp	int	是	東八時區(qū);10位時間戳，時間允許相差±60S golang: time.Now().Unix() php: time()
request_id	string	是	請求方請求ID，建議使用唯一ID，比如使用uuid；我方系統(tǒng)會2小時內(nèi)去重驗證處理，防止網(wǎng)絡(luò)重復(fù)攻擊；

3. 彩信批量提交接口

3.1 協(xié)議說明

協(xié)議類目	說明
請求方式	POST
編碼格式	UTF-8
Content-Type	application/json

3.2 請求地址

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

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

參數(shù)	類型	是否必填	說明
product_id	int	是	產(chǎn)品ID，如:1001
phone	Array	是	手機號數(shù)組(最多1萬個號碼)如：["18800000000"，"18800000001"]
sign_name	string	是/否	彩信簽名(template_id未填寫則必填)
title	string	是/否	彩信標題(template_id未填寫則必填)
content	array<[][]DataItem>	是/否	彩信內(nèi)容和模板ID必須傳入1個；當彩信內(nèi)容和模板ID都傳入時，傳入內(nèi)容生效，模板ID屬性失效 彩信元素DataItem結(jié)構(gòu):（具體參照文檔9.01） 參數(shù) 類型 描述 con_type int 內(nèi)容類型 ext_type string 文件擴展名 data string 數(shù)據(jù)
template_id	int	是/否	模板ID(內(nèi)容為空則必填)
send_time	string	否	定時發(fā)送時間 2020-08-26 16:08:14

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

參數(shù)	類型	說明
task_id	string	下發(fā)批次ID，推送回執(zhí)相關(guān)會用作關(guān)聯(lián)
code	string	狀態(tài)碼，OK表示發(fā)送成功，其他則是錯誤
message	string	消息內(nèi)容

4. 余額查詢接口

4.1 請求地址

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

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

參數(shù)	類型	說明
task_id	string	下發(fā)批次ID，推送回執(zhí)相關(guān)會用作關(guān)聯(lián)
code	string	狀態(tài)碼，OK表示發(fā)送成功，其他則是錯誤
message	string	消息內(nèi)容
data	array	多個數(shù)組方式返回 DataItem結(jié)構(gòu)： 參數(shù) 類型 描述 product_id int 產(chǎn)品ID product_name string 產(chǎn)品名稱 balance float 余額

示例：

5. 彩信模板提交接口

5.1 協(xié)議說明

協(xié)議類目	說明
請求方式	POST
編碼格式	UTF-8
Content-Type	application/json

5.2 請求地址

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

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

參數(shù)	類型	是否必填	說明
title	string	是	模板標題(用于標識,不會出現(xiàn)在彩信內(nèi)容中)
content	array<[][]DataItem>	是	彩信元素內(nèi)容DataItem結(jié)構(gòu):（具體參照文檔9.01） 參數(shù) 類型 描述 con_type int 內(nèi)容類型 ext_type string 文件擴展名 data string 數(shù)據(jù)
purpose	string	是	應(yīng)用場景描述
sign_name	string	是	短信簽名

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

參數(shù)	類型	說明
template_id	int	模板ID
code	string	狀態(tài)碼，OK表示發(fā)送成功，其他則是錯誤
message	string	消息內(nèi)容

6. 回執(zhí)推送

6.1 協(xié)議說明

協(xié)議類目	說明
調(diào)用方式	主動回調(diào)
請求方式	POST
編碼格式	UTF-8
Content-Type	application/json
數(shù)據(jù)格式	json

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

參數(shù)	類型	說明
task_id	string	下發(fā)批次ID
phone	string	手機號碼
code	string	狀態(tài)碼，DELIVERED則是成功，其他則是失敗
message	string	返回消息，用戶接收成功
send_time	string	發(fā)送時間
report_time	string	回執(zhí)時間

響應(yīng)說明:

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

7. 上行推送

7.1 協(xié)議說明

協(xié)議類目	說明
調(diào)用方式	主動回調(diào)
請求方式	POST
編碼格式	UTF-8
Content-Type	application/json
數(shù)據(jù)格式	json

 

 

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

參數(shù)	類型	說明
task_id	string	下發(fā)批次ID
phone	string	手機號碼
content	string	上行內(nèi)容
dest_code	string	上行通道擴展號
send_time	string	發(fā)送時間
receive_time	string	收取時間

響應(yīng)說明:

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

8. 模板審核推送

8.1 協(xié)議說明

協(xié)議類目	說明
調(diào)用方式	主動回調(diào)
請求方式	POST
編碼格式	UTF-8
Content-Type	application/json
數(shù)據(jù)格式	json

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

參數(shù)	類型	說明
template_id	int	模板ID
code	string	狀態(tài)值(SUCCESS審核通過，F(xiàn)AIL審核失敗)
message	string	審核消息

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

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

1) 支持視頻、圖片、音頻和文字，圖片編碼格式為二進制后base64，文字編碼格式為utf-8；
2) 彩信由多幀組成，同一幀中元素最多允許一段文字和一種媒體文件（即同一幀中只允許展現(xiàn)視頻、圖片、音頻中的一種媒體文件），多個媒體文件請分別放置在多幀中；
3) 內(nèi)容類型(con_type)支持：text(文本)、image(圖片)、audio(音頻)、video(視頻)；
4) 文件擴展名(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)容"}]]