彩信營(yíng)銷(xiāo)接口文檔下載： 點(diǎn)擊下載
本文檔主要提供給互億平臺(tái)的用戶(hù)對(duì)接接口的使用說(shuō)明，開(kāi)發(fā)者可以利用 ihuyi 提供的 HTTP 接口，調(diào)用 ihuyi 的營(yíng)銷(xiāo)彩信服務(wù)。
本文檔包含彩信批量提交、余額查詢(xún)、彩信模板提交、回執(zhí)推送、上行推送、模板審核推送。
POST
1、采用HTTPS協(xié)議提交請(qǐng)求
2、通過(guò)MD5動(dòng)態(tài)簽名方式加密
登錄用戶(hù)中心，進(jìn)入“營(yíng)銷(xiāo)彩信”模塊，在產(chǎn)品概覽頁(yè)面右側(cè)獲取，如下圖所示：
.png)
彩信模板是對(duì)您將要發(fā)送的彩信進(jìn)行相似性提取后的內(nèi)容。
注意：付費(fèi)用戶(hù)可以通過(guò)左側(cè)導(dǎo)航【營(yíng)銷(xiāo)彩信】-【彩信發(fā)送】-【模版管理】新增彩信模板，運(yùn)營(yíng)商審核通過(guò)之后即可正式使用。
彩信簽名是在【】加上您的公司名稱(chēng)或店鋪名稱(chēng)的標(biāo)識(shí)符，例如：【互億無(wú)線】。根據(jù)電信基礎(chǔ)運(yùn)營(yíng)商的規(guī)定，每條彩信必須附加彩信簽名，否則將無(wú)法正常發(fā)送。
.png)
| 參數(shù) | 類(lèi)型 | 是否必填 | 說(shuō)明 |
| api_id | string | 是 | Api的ID 如:2RYN7CQHL1M***** |
| signature | string | 是 | 請(qǐng)求驗(yàn)證加密簽名(非彩信簽名)； 簽名生成方式： 僅公共參數(shù)以ASCII碼從小到大排序值，key=value，多值以"&"隔開(kāi)，拼接之后md5 32位小寫(xiě)； 如：md5(api_id=xxxx&api_key=xxxx&request_id=xxxx×tamp=xxxxxxx) |
| timestamp | int | 是 | 東八時(shí)區(qū);10位時(shí)間戳，時(shí)間允許相差±60S golang: time.Now().Unix() php: time() |
| request_id | string | 是 | 請(qǐng)求方請(qǐng)求ID，建議使用唯一ID，比如使用uuid；我方系統(tǒng)會(huì)2小時(shí)內(nèi)去重驗(yàn)證處理，防止網(wǎng)絡(luò)重復(fù)攻擊； |
| 協(xié)議類(lèi)目 | 說(shuō)明 |
| 請(qǐng)求方式 | POST |
| 編碼格式 | UTF-8 |
| Content-Type | application/json |
https://api.ihuyi.com/mms/v1/batchSend
| 參數(shù) | 類(lèi)型 | 是否必填 | 說(shuō)明 | ||||||||||||
| product_id | int | 是 | 產(chǎn)品ID，如:1001 | ||||||||||||
| phone | Array |
是 | 手機(jī)號(hào)數(shù)組(最多1萬(wàn)個(gè)號(hào)碼)如：["18800000000"，"18800000001"] | ||||||||||||
| sign_name | string | 是/否 | 彩信簽名(template_id未填寫(xiě)則必填) | ||||||||||||
| title | string | 是/否 | 彩信標(biāo)題(template_id未填寫(xiě)則必填) | ||||||||||||
| content | array<[][]DataItem> | 是/否 | 彩信內(nèi)容和模板ID必須傳入1個(gè)；當(dāng)彩信內(nèi)容和模板ID都傳入時(shí)，傳入內(nèi)容生效，模板ID屬性失效 彩信元素DataItem結(jié)構(gòu):（具體參照文檔9.01）
|
||||||||||||
| template_id | int | 是/否 | 模板ID(內(nèi)容為空則必填) | ||||||||||||
| send_time | string | 否 | 定時(shí)發(fā)送時(shí)間 2020-08-26 16:08:14 |
| 參數(shù) | 類(lèi)型 | 說(shuō)明 |
| task_id | string | 下發(fā)批次ID，推送回執(zhí)相關(guān)會(huì)用作關(guān)聯(lián) |
| code | string | 狀態(tài)碼，OK表示發(fā)送成功，其他則是錯(cuò)誤 |
| message | string | 消息內(nèi)容 |
https://api.ihuyi.com/mms/v1/balance
| 參數(shù) | 類(lèi)型 | 說(shuō)明 | ||||||||||||
| task_id | string | 下發(fā)批次ID，推送回執(zhí)相關(guān)會(huì)用作關(guān)聯(lián) | ||||||||||||
| code | string | 狀態(tài)碼，OK表示發(fā)送成功，其他則是錯(cuò)誤 | ||||||||||||
| message | string | 消息內(nèi)容 | ||||||||||||
| data | array |
多個(gè)數(shù)組方式返回 DataItem結(jié)構(gòu)：
|
示例：
{
"code": "OK",
"message": "請(qǐng)求成功",
"data": [
{
"product_id": 1018,
"product_name": "營(yíng)銷(xiāo)彩信-房產(chǎn)類(lèi)",
"balance": 188888
},
{
"product_id": 1020,
"product_name": "營(yíng)銷(xiāo)彩信-商超類(lèi)",
"balance": 200000
}
]
}
| 協(xié)議類(lèi)目 | 說(shuō)明 |
|
請(qǐng)求方式 |
POST |
|
編碼格式 |
UTF-8 |
|
Content-Type |
application/json |
https://api.ihuyi.com/mms/v1/templateCreate
| 參數(shù) | 類(lèi)型 | 是否必填 | 說(shuō)明 | ||||||||||||
| title | string | 是 | 模板標(biāo)題(用于標(biāo)識(shí),不會(huì)出現(xiàn)在彩信內(nèi)容中) | ||||||||||||
| content | array<[][]DataItem> | 是 | 彩信元素內(nèi)容DataItem結(jié)構(gòu):（具體參照文檔9.01）
|
||||||||||||
| purpose | string | 是 | 應(yīng)用場(chǎng)景描述 | ||||||||||||
| sign_name | string | 是 | 短信簽名 |
| 參數(shù) | 類(lèi)型 | 說(shuō)明 |
| template_id | int | 模板ID |
| code | string | 狀態(tài)碼，OK表示發(fā)送成功，其他則是錯(cuò)誤 |
| message | string | 消息內(nèi)容 |
| 協(xié)議類(lèi)目 | 說(shuō)明 |
| 調(diào)用方式 | 主動(dòng)回調(diào) |
| 請(qǐng)求方式 | POST |
| 編碼格式 | UTF-8 |
| Content-Type | application/json |
| 數(shù)據(jù)格式 | json |
| 參數(shù) | 類(lèi)型 | 說(shuō)明 |
| task_id | string | 下發(fā)批次ID |
| phone | string | 手機(jī)號(hào)碼 |
| code | string | 狀態(tài)碼，DELIVERED則是成功，其他則是失敗 |
| message | string | 返回消息，用戶(hù)接收成功 |
| send_time | string | 發(fā)送時(shí)間 |
| report_time | string | 回執(zhí)時(shí)間 |
響應(yīng)說(shuō)明:
成功接收請(qǐng)輸出字符 “success” （不包含引號(hào)）結(jié)束推送，否則以接收失敗處理。每個(gè)回執(zhí)最多推送3次。每次間隔疊加60秒。
| 協(xié)議類(lèi)目 | 說(shuō)明 |
| 調(diào)用方式 | 主動(dòng)回調(diào) |
| 請(qǐng)求方式 | POST |
| 編碼格式 | UTF-8 |
| Content-Type | application/json |
| 數(shù)據(jù)格式 | json |
| 參數(shù) | 類(lèi)型 | 說(shuō)明 |
| task_id | string | 下發(fā)批次ID |
| phone | string | 手機(jī)號(hào)碼 |
| content | string | 上行內(nèi)容 |
| dest_code | string | 上行通道擴(kuò)展號(hào) |
| send_time | string | 發(fā)送時(shí)間 |
| receive_time | string | 收取時(shí)間 |
響應(yīng)說(shuō)明:
成功接收請(qǐng)輸出字符 “success” （不包含引號(hào)）結(jié)束推送，否則以接收失敗處理。每個(gè)回執(zhí)最多推送3次。每次間隔疊加60秒。
| 協(xié)議類(lèi)目 | 說(shuō)明 |
| 調(diào)用方式 | 主動(dòng)回調(diào) |
| 請(qǐng)求方式 | POST |
| 編碼格式 | UTF-8 |
| Content-Type | application/json |
| 數(shù)據(jù)格式 | json |
| 參數(shù) | 類(lèi)型 | 說(shuō)明 |
| template_id | int | 模板ID |
| code | string | 狀態(tài)值(SUCCESS審核通過(guò)，F(xiàn)AIL審核失敗) |
| message | string | 審核消息 |
1) 支持視頻、圖片、音頻和文字，圖片編碼格式為二進(jìn)制后base64，文字編碼格式為utf-8；
2) 彩信由多幀組成，同一幀中元素最多允許一段文字和一種媒體文件（即同一幀中只允許展現(xiàn)視頻、圖片、音頻中的一種媒體文件），多個(gè)媒體文件請(qǐng)分別放置在多幀中；
3) 內(nèi)容類(lè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":"這是測(cè)試文本內(nèi)容1"},{"con_type":"image","ext_type":"jpg","data":"這是base64內(nèi)容"}],[{"con_type":"text","ext_type":"txt","data":"這是測(cè)試文本內(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":"這是測(cè)試文本內(nèi)容3"}],[{"con_type":"audio","ext_type":"mp3","data":"test"},{"con_type":"text","ext_type":"txt","data":"這是base64內(nèi)容"}]]
億互通106短信群發(fā)平臺(tái)，致力于為企業(yè)和開(kāi)發(fā)者用戶(hù)提供短信驗(yàn)證碼接口、短信群發(fā)、視頻短信及語(yǔ)音通知產(chǎn)品，無(wú)需硬件設(shè)備與軟件即可網(wǎng)頁(yè)在線群發(fā)，通過(guò)平臺(tái)提供的接口及JAVA、PHP等開(kāi)發(fā)語(yǔ)言DEMO示例，可快速調(diào)用短信、語(yǔ)音發(fā)送能力。
服務(wù)熱線：
4008 808 898
服務(wù)熱線（工作時(shí)間）：
4008 808 898
業(yè)務(wù)咨詢(xún)（非工作時(shí)間）：
4008 808 898
售后咨詢(xún)（非工作時(shí)間）：
4008 808 898
