統一咨詢熱線:400-6889-015
普通短信發送 個性短信發送 狀态報告發送 上行回複 餘額查詢

AIP接口

Api Interface

API接口是面向有一定技術開發能力的企業用戶而單獨研 發的短信(sms)接口,可以方便的對接到企業用 戶公司内部系 統中。本接口采用了通用的HTTP協議,可以支持各種操作系統和 開發語言。在您購買了API版短信平台并通過簡單的測試後,即可把 短信接口嵌入到您公司自己的系統中,快速擁有短信發送應用, 完善您的企業服務。

用戶通過HTTP的POST方式提交短信發送請求。編碼采用UTF-8編碼。

短信提交地址

URL地址爲:http://xxx:port/sms/apiSend/add

參數定義
序号 參數 說明
1 account (必填參數)用戶賬号
2 password (必填參數)接口密碼:web 平台中的接口密碼
3 content (必填參數)發送内容(1-500 個漢字)UTF-8編碼
4 mobiles (必填參數)手機号碼。多個以英文逗号隔開
5 sendTime (可選參數)發送時間,填寫時按照此時間發送,不填時爲當前時間發送
6 productId (必填參數)産品編碼
短信提交響應

用戶短信通過http請求提交到服務器後,服務器返回響應結果,響應碼的格式如下:

result: {
"ok": true,
"message": "ok",
"result": {
"blackCount": 1, // 黑名單号碼數
"batchNo": "201908261135000000465", // 批次号
"balance": 2, // 餘額
"normalCount": 1, // 正常号碼數
"unidentifiedCount": 0, // 不能識别運營商号碼數
}}

1.1.1 格式說明

短信提交後的響應結果爲JSON串數據,ok爲true時表示提交成功,爲false時表示提交失敗,message爲具體原因。接口方式提交建議每次請求提交的号碼量不超過兩萬, 請求成功後服務端成功接收到該批号碼和内容信息,并返回一個唯一批次号,當用戶提交失敗時,ok爲false,服務端無批次号信息返回。

1.1.2響應狀态值說明

參數 說明
ok true 表示接收成功;false 表示接收失敗
message 服務端接收成功時爲OK,接收失敗時爲具體失敗原因
blackCount 黑名單号碼數
batchNo 批次号,每次請求成功接口都會返回一 個唯一的批次号
balance 此産品的餘額
unidentifiedCount 不能識别運營商号碼數
normalCount 正常号碼數量
普通短信發送 個性短信發送 狀态報告 上行回複 餘額查詢