AIP接口
Api Interface
API接口是面向有一定技術開發(fā)能力的企業(yè)用戶而單獨研 發(fā)的短信（sms）接口，可以方便的對接到企業(yè)用 戶公司內部系 統(tǒng)中。本接口采用了通用的HTTP協(xié)議，可以支持各種操作系統(tǒng)和 開發(fā)語言。在您購買了API版短信平臺并通過簡單的測試后，即可把 短信接口嵌入到您公司自己的系統(tǒng)中，快速擁有短信發(fā)送應用， 完善您的企業(yè)服務。
用戶通過HTTP的POST方式提交短信發(fā)送請求。編碼采用UTF-8編碼。
| 序號 | 參數(shù) | 說明 |
|---|---|---|
| 1 | account | （必填參數(shù)）用戶賬號 |
| 2 | password | （必填參數(shù)）接口密碼：web 平臺中的接口密碼 |
| 3 | content | （必填參數(shù)）發(fā)送內容（1-500 個漢字）UTF-8編碼 |
| 4 | mobiles | （必填參數(shù)）手機號碼。多個以英文逗號隔開 |
| 5 | sendTime | （可選參數(shù)）發(fā)送時間，填寫時按照此時間發(fā)送，不填時為當前時間發(fā)送 |
| 6 | productId | （必填參數(shù)）產品編碼 |
用戶短信通過http請求提交到服務器后，服務器返回響應結果，響應碼的格式如下：
result： {
"ok": true,
"message": "ok",
"result": {
"blackCount": 1, // 黑名單號碼數(shù)
"batchNo": "201908261135000000465", // 批次號
"balance": 2, // 余額
"normalCount": 1, // 正常號碼數(shù)
"unidentifiedCount": 0, // 不能識別運營商號碼數(shù)
}}
1.1.1 格式說明
短信提交后的響應結果為JSON串數(shù)據(jù)，ok為true時表示提交成功，為false時表示提交失敗，message為具體原因。接口方式提交建議每次請求提交的號碼量不超過兩萬， 請求成功后服務端成功接收到該批號碼和內容信息，并返回一個唯一批次號，當用戶提交失敗時，ok為false，服務端無批次號信息返回。
1.1.2響應狀態(tài)值說明
| 參數(shù) | 說明 |
|---|---|
| ok | true 表示接收成功；false 表示接收失敗 |
| message | 服務端接收成功時為OK，接收失敗時為具體失敗原因 |
| blackCount | 黑名單號碼數(shù) |
| batchNo | 批次號，每次請求成功接口都會返回一 個唯一的批次號 |
| balance | 此產品的余額 |
| unidentifiedCount | 不能識別運營商號碼數(shù) |
| normalCount | 正常號碼數(shù)量 |
普通短信發(fā)送
個性短信發(fā)送
狀態(tài)報告
上行回復
余額查詢
皖公網(wǎng)安備 34019202000774號