互億無(wú)線(xiàn) · 文檔中心

短信營(yíng)銷(xiāo) - API文檔


短信營(yíng)銷(xiāo)接口文檔 點(diǎn)擊下載

短信營(yíng)銷(xiāo)接口接入指南 點(diǎn)擊訪(fǎng)問(wèn)

1.概要

1.1文檔說(shuō)明

本文檔主要提供給互億平臺的用戶(hù)對接接口的使用說(shuō)明,開(kāi)發(fā)者可以利用 ihuyi 提供的 HTTP 接口,調用 ihuyi 的營(yíng)銷(xiāo)短信服務(wù)。

1.2接口內容

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

1.3提交方式

POST

1.4加密方式

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

1.5 api id / api key

登錄用戶(hù)中心,進(jìn)入“營(yíng)銷(xiāo)短信”模塊,在產(chǎn)品概覽頁(yè)面右側獲取,如下圖所示:

1.6短信模版

短信模板是對您將要發(fā)送的短信進(jìn)行相似性提取后的內容。
舉個(gè)例子,
A用戶(hù)在您平臺注冊會(huì )員,需要發(fā)送一條短信,內容如下:
尊敬的王先生,互億無(wú)線(xiàn)雙旦活動(dòng),送您100元優(yōu)惠券!回T退訂
同時(shí),B用戶(hù)也在您的平臺注冊會(huì )員,發(fā)送了如下短信:
尊敬的李先生,互億無(wú)線(xiàn)雙旦活動(dòng),送您100元優(yōu)惠券!回T退訂
我們提取相同部分以后,可以制作以下短信模板:
尊敬的${name},互億無(wú)線(xiàn)雙旦活動(dòng),送您100元優(yōu)惠券!回T退訂
其中,${name}為變量部分,可以是數字、字母、漢字。

注意:付費用戶(hù)可以通過(guò)左側導航【營(yíng)銷(xiāo)短信】-【短信發(fā)送】-【模版管理】新增短信模板,運營(yíng)商審核通過(guò)之后即可正式使用。

1.7短信簽名

短信簽名是加在短信的開(kāi)頭或結尾,在【】加上您的公司名稱(chēng)或店鋪名稱(chēng)的標識符,例如:【互億無(wú)線(xiàn)】。 根據電信基礎運營(yíng)商的規定,每條短信必須附加短信簽名,否則將無(wú)法正常發(fā)送。

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

參數 類(lèi)型 是否必填 說(shuō)明
api_id string Api的ID 如:sms-yx*******
signature string

請求驗證加密簽名(非短信簽名);
簽名生成方式:


32位小寫(xiě);
如:

timestamp int 東八時(shí)區;10位時(shí)間戳,時(shí)間允許相差±60S
golang: time.Now().Unix()
php: time()
request_id string 請求方請求ID,建議使用唯一ID,比如使用uuid;我方系統會(huì )2小時(shí)內去重驗證處理,防止網(wǎng)絡(luò )重放攻擊;

3. 短信批量提交接口

3.1協(xié)議說(shuō)明

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

3.2請求地址

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

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

參數              類(lèi)型     是否必填   說(shuō)明
product_id int 產(chǎn)品ID,如:1001
phone array 手機號數組(最多1萬(wàn)個(gè)號碼),如:["18800000000","18800000001"]
sign_name string 短信簽名,如:互億無(wú)線(xiàn)
content string 是/否 template_id為空時(shí)必填; 
短信內容,如:您的短信群發(fā)功能已開(kāi)通,請在3個(gè)工作日之內至平臺進(jìn)行企業(yè)認證! 短信內容和模板ID必須傳入1個(gè);當短信內容和模板ID都傳入時(shí),傳入內容生效,模板ID屬性失效;
template_id int 是/否 content為空時(shí)必填; 
模板ID
template_var object 選擇模板時(shí),且模板是變量模板時(shí),可以傳入變量值,需要傳入json格式;
key value 格式存儲,如:{"${name}":"\u5f20\u4e09","${order_no}":"202009041156181103"}
send_time string 定時(shí)發(fā)送時(shí)間 2020-08-26 16:08:14

3.4返回參數(json格式)

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

4. 余額查詢(xún)接口

4.1請求地址

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

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

4.3返回參數(json格式)

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

示例:

 

{

    "code": "OK",

    "message": "請求成功",

    "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

        }

    ]

}

5. 短信模板提交接口

5.1協(xié)議說(shuō)明

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

5.2請求地址

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

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

參數 類(lèi)型 是否必填 說(shuō)明
title string 模板標題(用于標識,不會(huì )出現在短信內容中)
content string 模板內容(變量請使用變量標識方式:${變量名稱(chēng)}, 如: ${name} )
purpose string 應用場(chǎng)景描述
is_variable int 0表示不帶變量,1表示帶變量

5.4返回參數(json格式)

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

6. 回執推送

6.1協(xié)議說(shuō)明

協(xié)議類(lèi)目 說(shuō)明
調用方式 主動(dòng)回調
請求方式 POST
編碼格式 UTF-8
Content-Type application/json
數據格式 json

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

6.2回執數據定義

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

響應說(shuō)明:

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

7. 上行推送

7.1協(xié)議說(shuō)明

協(xié)議類(lèi)目 說(shuō)明
調用方式 主動(dòng)回調
請求方式 POST
編碼格式 UTF-8
Content-Type application/json
數據格式 json

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

7.2回執數據定義

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

響應說(shuō)明:

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

8.模板審核推送

8.1協(xié)議說(shuō)明

協(xié)議類(lèi)目 說(shuō)明
調用方式 主動(dòng)回調
請求方式 POST
編碼格式 UTF-8
Content-Type application/json
數據格式 json

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

8.2模板審核數據定義

參數 類(lèi)型 說(shuō)明
template_id int 模板ID
code string 狀態(tài)值(SUCCESS審核通過(guò),FAIL審核失敗)
message string 審核消息

9.錯誤碼查詢(xún)

Code 說(shuō)明
OK 請求成功
ParamError 參數錯誤
AccessKeyIDNotExist AccessKeyID不存在
UserIDNotExist 用戶(hù)ID不存在
AmountError 數額錯誤(超出許可范圍)
TimestampError 時(shí)間錯誤(超出許可范圍)
ProductIDNotExist 產(chǎn)品ID不存在
TypeNotExist 類(lèi)型不存在
RemarkError 備注錯誤
RequestIDExisted 請求ID已存在
NonceExisted 隨機數已存在
SingError 簽名錯誤
SignExpired 簽名過(guò)期
BalanceNotEnough 余額不足
PackIDExisted 資源包ID已存在
SystemError 系統異常
InputDataInvalid 請求參數異常

現在注冊,即享新用戶(hù)禮包!

在線(xiàn)咨詢(xún)
電話(huà)咨詢(xún)

服務(wù)熱線(xiàn):

4008 808 898

服務(wù)熱線(xiàn)(工作時(shí)間):

4008 808 898

業(yè)務(wù)咨詢(xún)(非工作時(shí)間):

售后咨詢(xún)(非工作時(shí)間):

驗證碼已發(fā)送到您的手機,請查收!

輸入驗證碼后,點(diǎn)擊“開(kāi)通體驗賬戶(hù)”按鈕可立即開(kāi)通體驗賬戶(hù)。

收不到短信驗證碼?
互億無(wú)線(xiàn)不提供接碼服務(wù),接碼用戶(hù)請勿點(diǎn)擊開(kāi)通按鈕。
×