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