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

1.概要

1.1 文檔說明

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

1.2 接口內容

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

1.3 提交方式

POST

1.4 加密方式

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

1.5 api id / api key

登錄用戶中心，進入“營銷彩信”模塊，在產品概覽頁面右側獲取，如下圖所示：

1.6 彩信模版

彩信模板是對您將要發送的彩信進行相似性提取后的內容。

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

1.7 彩信簽名

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

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

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

3. 彩信批量提交接口

3.1 協議說明

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

3.2 請求地址

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

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

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

3.4 返回參數(json格式)

參數	類型	說明
task_id	string	下發批次ID，推送回執相關會用作關聯
code	string	狀態碼，OK表示發送成功，其他則是錯誤
message	string	消息內容

4. 余額查詢接口

4.1 請求地址

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

4.2 返回參數(json格式)

參數	類型	說明
task_id	string	下發批次ID，推送回執相關會用作關聯
code	string	狀態碼，OK表示發送成功，其他則是錯誤
message	string	消息內容
data	array	多個數組方式返回 DataItem結構： 參數 類型 描述 product_id int 產品ID product_name string 產品名稱 balance float 余額

示例：

5. 彩信模板提交接口

5.1 協議說明

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

5.2 請求地址

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

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

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

5.4返回參數(json格式)

參數	類型	說明
template_id	int	模板ID
code	string	狀態碼，OK表示發送成功，其他則是錯誤
message	string	消息內容

6. 回執推送

6.1 協議說明

協議類目	說明
調用方式	主動回調
請求方式	POST
編碼格式	UTF-8
Content-Type	application/json
數據格式	json

6.2 回執數據定義

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

響應說明:

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

7. 上行推送

7.1 協議說明

協議類目	說明
調用方式	主動回調
請求方式	POST
編碼格式	UTF-8
Content-Type	application/json
數據格式	json

 

 

7.2 回執數據定義

參數	類型	說明
task_id	string	下發批次ID
phone	string	手機號碼
content	string	上行內容
dest_code	string	上行通道擴展號
send_time	string	發送時間
receive_time	string	收取時間

響應說明:

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

8. 模板審核推送

8.1 協議說明

協議類目	說明
調用方式	主動回調
請求方式	POST
編碼格式	UTF-8
Content-Type	application/json
數據格式	json

8.2 模板審核數據定義

參數	類型	說明
template_id	int	模板ID
code	string	狀態值(SUCCESS審核通過，FAIL審核失敗)
message	string	審核消息

9. 參數示例說明

9.1 內容格式定義

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

內容格式json格式參考如下：

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