功能示例 / Example
追求卓越,美好人生。新款夏裝兩件活動,三件X折。中褲X元起,限時選購。活動時間從X月X日開始,歡迎光臨!退訂回T
尊敬的貴賓您好:又到周末了,忙碌一周的您可以稍稍休息一下了,XX-KTV伴您度過一個輕松愉快的周末!訂座電話:XXX-XXX-XXXX。退訂回T
開發(fā)流程 / Process
-
注冊開發(fā)者賬號
-
免費測試短信發(fā)送
-
購買短信套餐
-
快速調(diào)用接口
-
完成開發(fā)
接口介紹 / Introduction
-
靈活接入
標準HTTP(S)協(xié)議,提供完善的技術開發(fā)文檔
-
穩(wěn)定發(fā)送
專業(yè)機房,超大容量,海量并發(fā)支持
-
專業(yè)服務
專業(yè)技術團隊答疑解難,24小時運維監(jiān)控
應用場景 / Scenes
-
活動促銷
適用于折扣、返利等具備會員營銷性質(zhì)場景,低成本,高ROI
-
新品上線
適用于電商、快消品、互聯(lián)網(wǎng)等行業(yè),降低企業(yè)獲客成本
-
品牌推廣
適用于所有企業(yè),有效提升企業(yè)影響力
- 概要
- 短信發(fā)送
- 余額查詢
- 發(fā)送回執(zhí)推送
- 上行回復推送
- 生成動態(tài)密碼
1、概要
1.1 文檔說明
本文檔主要提供給互億平臺的用戶對接接口的使用說明,開發(fā)者可以利用 ihuyi 提供的 HTTP 接口,調(diào)用 ihuyi 的短信營銷服務。
1.2 接口內(nèi)容
本文檔包含短信發(fā)送、余額查詢、發(fā)送回執(zhí)推送、上行回復推送等。
1.3 提交方式
GET / POST
1.4 加密方式
1、采用HTTPS協(xié)議提交請求
2、通過MD5動態(tài)簽名方式加密
1.5 API ID / API KEY
登錄用戶中心,進入【短信營銷】模塊,在【產(chǎn)品總攬】頁面右上角
1.6 短信模版
短信模板是對您將要發(fā)送的短信進行相似性提取后的內(nèi)容。舉個例子,
A用戶在您平臺注冊會員,需要發(fā)送一條短信,內(nèi)容如下:
您好,您的驗證碼是:666666
同時,B用戶也在您的平臺注冊會員,發(fā)送了如下短信:
您好,您的驗證碼是:888888
我們提取相似度以后,可以制作以下短信模板:
您好,您的驗證碼是:【變量】
其中,變量是可變的,可以是 數(shù)字、字母、漢字。
注意:付費用戶可以通過左側導航【短信營銷】-【短信發(fā)送】-【模版管理】新增短信模板,運營商審核通過之后即可正式使用。
1.7 短信簽名
短信簽名是加在短信的開頭或結尾,在【】加上您的公司名稱或店鋪名稱的標識符,例如:【互億無線】。 根據(jù)電信基礎運營商的規(guī)定,每條短信必須附加短信簽名,否則將無法正常發(fā)送。
2、短信發(fā)送
2.1 接口描述
通過POST、 GET 方式進行短信提交,數(shù)據(jù)編碼采用utf-8格式,24小時全天發(fā)送。
2.2 請求地址
http://api.yx.ihuyi.com/webservice/sms.php?method=Submit
2.3 請求參數(shù)
參數(shù)名稱 | 參數(shù)值描述 | 必填 |
account | APIID(請登錄用戶中心【短信營銷】-【產(chǎn)品縱覽】查看) | 是 |
password | 1、APIKEY(請登錄用戶中心【短信營銷】-【產(chǎn)品縱覽】查看) 2、動態(tài)密碼(生成動態(tài)密碼方式請看該文檔末尾的說明) |
是 |
mobile | 接收手機號碼, 多個號碼請用英文逗號隔開。 | 是 |
content | 短信內(nèi)容(編碼格式為UTF-8,支持300個字的長短信,長短信按多條計費) 注:1、請?zhí)顚懹袑嶋H意義的短信內(nèi)容,避免用"短信測試、aaaaa"等字樣。 2、【簽名】請用您的公司名、品牌名等。 例:尊敬的會員,您好,夏季新品已上市,請關注。退訂回TD【互億無線】 |
是 |
time | Unix時間戳(10位整型數(shù)字,當使用動態(tài)密碼方式時為必填) | 否 |
stime | 指定短信下發(fā)時間(格式:2016-11-30 15:30:00) | 否 |
format | 返回格式(可選值為:xml或json,系統(tǒng)默認為xml) | 否 |
用戶通過http 或 https提交發(fā)送短信請求到服務器后,服務器會返回一串xml格式的字符串,SubmitResult結構說明如下:
參數(shù)名稱 | 類型 | 描述 |
code | int | 返回值為2時,表示提交成功 |
smsid | string | 當提交成功后,此字段為流水號,否則為0 |
msg | string | 提交結果描述 |
2.4 響應示例
示例(成功)
2
提交成功 14745625541233112231
示例(失敗)
405
用戶名或密碼不正確 0
2.5 響應參數(shù)
code | msg |
0 | 提交失敗 |
2 | 提交成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
403 | 手機號碼不能為空 |
4030 | 手機號碼已被列入黑名單 |
404 | 短信內(nèi)容不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
4051 | 剩余條數(shù)不足 |
4052 | 訪問ip與備案ip不符 |
406 | 手機格式不正確 |
407 | 短信內(nèi)容含有敏感字符 |
4070 | 簽名格式不正確 |
4071 | 沒有提交備案模板 |
4072 | 短信內(nèi)容與模板不匹配 |
4073 | 短信內(nèi)容超出長度限制 |
408 | 您的帳戶疑被惡意利用,已被自動凍結,如有疑問請與客服聯(lián)系。 |
2.6 請求示例
http://api.yx.ihuyi.com/webservice/sms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機號碼&content=短信內(nèi)容【簽名】
3、余額查詢
3.1 接口描述
通過接口可以方便的查詢你的賬戶驗證碼通知短信剩余條數(shù)。
3.2 請求地址
http://api.yx.ihuyi.com/webservice/sms.php?method=GetNum
3.3 請求參數(shù)
參數(shù)名稱 | 參數(shù)值描述 | 是否必填 |
account | APIID(請登錄用戶中心【短信營銷】-【產(chǎn)品縱覽】查看) | 是 |
password | 1、APIKEY(請登錄用戶中心【短信營銷】-【產(chǎn)品縱覽】查看) 2、動態(tài)密碼(生成動態(tài)密碼方式請看該文檔末尾的說明) |
是 |
time | Unix時間戳(10位整型數(shù)字,當使用動態(tài)密碼方式時為必填) | 否 |
format | 返回格式(可選值為:xml或json,系統(tǒng)默認為xml) | 否 |
用戶通過http 或 https提交帳戶余額查詢請求到服務器后,服務器會返回一串xml格式的字符串,GetNumResult結構說明如下:
參數(shù)名稱 | 類型 | 描述 |
code | int | 狀態(tài)返回值 |
msg | string | 查詢結果描述 |
num | string | 剩余數(shù)量 |
3.4 響應示例
示例(成功)
2
查詢成功 856
示例(失?。?/p>
405
用戶名或密碼不正確 0
3.5 響應參數(shù)
code | msg |
2 | 查詢成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
3.6 GET請求示例
http://api.yx.ihuyi.com/webservice/sms.php?method=GetNum&account=APIID&password=APIKEY
4、發(fā)送回執(zhí)推送
4.1 接口描述
用戶先提供數(shù)據(jù)接收地址,然后綁定到互億無線系統(tǒng)后臺,平臺會以POST方式實時的將回執(zhí)信息推送到此地址。
4.2 推送參數(shù)
參數(shù)名稱 | 參數(shù)值描述 |
code | 狀態(tài)值(2成功 其他為失?。?/td> |
msg | 回執(zhí)狀態(tài)說明 |
mobilephone | 手機號碼 |
task_id | 流水號(對應提交時返回的task_id) |
report_time | 回執(zhí)時間 |
注意: 成功接收請輸出字符 "success" (不包含引號)結束推送,否則以接收失敗處理。每個回執(zhí)最多推送3次。每次間隔疊加60秒。
5、上行回復推送
5.1 接口描述
用戶先提供數(shù)據(jù)接收地址,然后綁定到互億無線系統(tǒng)后臺,平臺會以POST方式實時的將回復信息推送到此地址。
5.2 推送參數(shù)
參數(shù)名稱 | 參數(shù)值描述 |
mobilephone | 手機號碼 |
content | 上行內(nèi)容 |
task_id | 流水號(對應提交時返回的task_id)(僅作參考) |
reply_time | 上行時間 |
注意: 成功接收請輸出字符 "success" (不包含引號)結束推送,否則以接收失敗處理。每個回執(zhí)最多推送3次。每次間隔疊加60秒。
6、生成動態(tài)密碼方式
以PHP為例,提交短信的生成方式:
$time = time(); $password = md5($account.$apikey.$mobile.$content.$time);
例如:
APIID: test APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d 手機號:138xxxxxxxx 內(nèi)容:尊敬的會員,您好,夏季新品已上市,請關注。退訂回TD【互億無線】 time:1451544941 結果:$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx尊敬的會員,您好,夏季新品已上市,請關注。退訂回TD【互億無線】1451544941');
注意:因為短信內(nèi)容會包含中文,所以字符編碼統(tǒng)一為UTF-8
查詢剩余條數(shù)的生成方式:
$time = time(); $password = md5($account.$apikey.$time);
例如:
APIID: test APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d 手機號:138xxxxxxxx time:1451544941 結果:$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');
Unix時間戳參考地址:http://tool.chinaz.com/Tools/unixtime.aspx
短信發(fā)送錯誤碼參照:
code | msg |
0 | 提交失敗 |
2 | 提交成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
403 | 手機號碼不能為空 |
4030 | 手機號碼已被列入黑名單 |
404 | 短信內(nèi)容不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
4051 | 剩余條數(shù)不足 |
4052 | 訪問ip與備案ip不符 |
406 | 手機格式不正確 |
407 | 短信內(nèi)容含有敏感字符 |
4070 | 簽名格式不正確 |
4071 | 沒有提交備案模板 |
4072 | 短信內(nèi)容與模板不匹配 |
4073 | 短信內(nèi)容超出長度限制 |
408 | 您的帳戶疑被惡意利用,已被自動凍結,如有疑問請與客服聯(lián)系。 |
余額查詢錯誤碼參照:
code | msg |
2 | 查詢成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
代碼示例
常見問題
客戶服務
內(nèi)容 | 聯(lián)系方式 |
400熱線 | 400-880-8898 |
聯(lián)系電話 | 021-5169 8929 |
郵箱 | service@ihuyi.com |
郵政編碼 | 201203 |
市場合作/渠道代理
內(nèi)容 | 聯(lián)系方式 |
聯(lián)系電話 | 15902129325 |
郵箱 | linsn@ihuyi.com |
技術支持
內(nèi)容 | 聯(lián)系方式 |
聯(lián)系電話 | 4008 808 898 |
郵箱 | support@ihuyi.com |
公司地址
內(nèi)容 | 聯(lián)系方式 |
上??偣?/td> | 上海市浦東新區(qū)納賢路800號A座401 |
南京分公司 | 南京市秦淮區(qū)瞻園路19號 |
成都分公司 | 中國(四川)自由貿(mào)易試驗區(qū)成都高新區(qū)天府街69號 |
熱門接口
-
短信驗證碼接口
短信接口開發(fā),支持移動、聯(lián)通、電信三網(wǎng)發(fā)送,0技術基礎接入短信服務
-
語音驗證碼接口
語音短信API接口調(diào)用,三網(wǎng)合一直連通道,15分鐘即可完成接入
-
語音通知接口
語音接口開發(fā),支持移動、聯(lián)通、電信三網(wǎng)發(fā)送,0技術基礎接入語音通知服務
-
國際短信接口
國際短信API接口調(diào)用,三網(wǎng)合一直連通道,15分鐘即可完成接入
-
彩信群發(fā)接口
彩信群發(fā)API接口調(diào)用,支持移動、聯(lián)通、電信,適用于新品上線、活動促銷、企業(yè)宣傳等場景