國際短信
國際驗證碼API接口文檔下載: 點擊下載
1、概要
1.1 文檔說明
本文檔主要提供給達信通的用戶對接接口的使用說明,開發者可以利用達信通提供的 HTTP 接口,調用達信通的國際驗證碼服務。
1.2 接口內容
本文檔包含國際短信發送、余額查詢、發送回執推送等。
1.3 提交方式
GET / POST
1.4 加密方式
1、采用HTTPS協議提交請求
2、通過MD5動態簽名方式加密
1.5 API ID / API KEY
登錄用戶中心,進入【國際驗證碼】模塊,在【產品總攬】頁面右上角,如下圖所示
1.6 國際驗證碼模版
國際驗證碼模板是對您將要發送的短信進行相似性提取后的內容。舉個例子,
A用戶在您平臺注冊會員,需要發送一條短信,內容如下:
您好,您的驗證碼是:666666
同時,B用戶也在您的平臺注冊會員,發送了如下短信:
您好,您的驗證碼是:888888
我們提取相似度以后,可以制作以下短信模板:
您好,您的驗證碼是:【變量】
其中,變量是可變的,可以是 數字、字母、漢字。
2、國際短信發送
2.1 接口描述
通過POST、 GET 方式進行短信提交,數據編碼采用utf-8格式,24小時全天發送。
2.2 請求地址
http://api.isms.wx96.com/webservice/isms.php?method=Submit
2.3 請求參數
參數名稱 | 參數值描述 | 必填 |
account | APIID(請登錄用戶中心【國際驗證碼】-【產品縱覽】查看) | 是 |
password | 1、APIKEY(請登錄用戶中心【國際驗證碼】-【產品縱覽】查看) 2、動態密碼(生成動態密碼方式請看該文檔末尾的說明) |
是 |
mobile | 接收手機號碼, 只能提交一個號碼。(格式為:國家號+空格+手機號) | 是 |
content | 短信內容 | 是 |
time | Unix時間戳(10位整型數字,當使用動態密碼方式時為必填) | 否 |
format | 返回格式(可選值為:xml或json,系統默認為xml) | 否 |
用戶通過http 或 https提交發送短信請求到服務器后,服務器會返回一串xml格式的字符串,SubmitResult結構說明如下:
參數名稱 | 類型 | 描述 |
code | int | 返回值為2時,表示提交成功 |
smsid | string | 當提交成功后,此字段為流水號,否則為0 |
msg | string | 提交結果描述 |
2.4 響應示例
示例(成功)
2
提交成功 60495654
示例(失敗)
405
用戶名或密碼不正確 0
2.5 響應參數
code | msg |
0 | 提交失敗 |
2 | 提交成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
403 | 手機號碼不能為空 |
4030 | 手機號碼已被列入黑名單 |
404 | 短信內容不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
4051 | 剩余條數不足 |
4052 | 訪問ip與備案ip不符 |
406 | 手機格式不正確 |
407 | 短信內容含有敏感字符 |
4071 | 沒有提交備案模板 |
4072 | 你提交過來短信內容必須與報備過的模板格式相匹配 |
40722 | 變量內容超過指的的長度 |
4073 | 短信內容超出長度限制 |
408 | 您的帳戶疑被惡意利用,已被自動凍結,如有疑問請與客服聯系。 |
2.6 請求示例
http://api.isms.wx96.com/webservice/isms.php?method=Submit&account=APIID&password=APIKEY&mobile=手機號碼&content=Your verification code is 1125
3、余額查詢
3.1 接口描述
通過接口可以方便的查詢你的賬戶國際驗證碼剩余條數。
3.2 請求地址
http://api.isms.wx96.com/webservice/isms.php?method=GetNum
3.3 請求參數
參數名稱 | 參數值描述 | 是否必填 |
account | APIID(請登錄用戶中心【國際驗證碼】-【產品縱覽】查看) | 是 |
password | 1、APIKEY(請登錄用戶中心【國際驗證碼】-【產品縱覽】查看) 2、動態密碼(生成動態密碼方式請看該文檔末尾的說明) |
是 |
time | Unix時間戳(10位整型數字,當使用動態密碼方式時為必填) | 否 |
format | 返回格式(可選值為:xml或json,系統默認為xml) | 否 |
用戶通過http 或 https提交帳戶余額查詢請求到服務器后,服務器會返回一串xml格式的字符串,GetNumResult結構說明如下:
參數名稱 | 類型 | 描述 |
code | int | 狀態返回值 |
msg | string | 查詢結果描述 |
num | string | 剩余數量 |
3.4 響應示例
示例(成功)
2
提交成功 0
示例(失敗)
405
用戶名或密碼不正確 0
3.5 響應參數
code | msg |
2 | 查詢成功 |
400 | 非法ip訪問 |
401 | 帳號不能為空 |
402 | 密碼不能為空 |
405 | 用戶名或密碼不正確 |
4050 | 賬號被凍結 |
3.6 GET請求示例
http://api.isms.wx96.com/webservice/isms.php?method=GetNum&account=APIID&password=APIKEY
4、發送回執推送
4.1 接口描述
用戶先提供數據接收地址,然后綁定到達信通系統后臺,平臺會以POST方式實時的將回執信息推送到此地址。
4.2 推送參數
參數名稱 | 參數值描述 |
code | 狀態值(2成功 其他為失敗) |
msg | 回執狀態說明 |
mobilephone | 手機號碼 |
ismsid | 流水號(對應提交時返回的ismsid) |
reply_time | 回執時間 |
注意: 成功接收請輸出字符 "success" (不包含引號)結束推送,否則以接收失敗處理。每個回執最多推送3次。每次間隔疊加60秒。
5、生成動態密碼方式
以PHP為例,提交語音驗證碼的生成方式:
$time = time(); $password = md5($account.$apikey.$mobile.$content.$time);
例如:
APIID: test APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d 手機號:138xxxxxxxx 內容:Your verification code is 1125 time:1451544941 結果:$password=md5('test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxxYour verification code is 11251451544941');
注意:因為短信內容會包含unicode字符,所以字符編碼統一為UTF-8。
查詢剩余條數的生成方式:
$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