API: Balance/SMS - 短信余額查詢
概覽
balance/sms 是 SUBMAIL 的短信余額查詢 API。
使用 balance/sms 可以實時獲取您賬戶的短信余額。
URL
https://api-v4.mysubmail.com/balance/sms
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/balance/sms.json（默認） |
xml | https://api-v4.mysubmail.com/balance/sms.xml |
http 請求方式
| 請求方式 | content-type設置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權
是
參閱 API 授權和驗證機制
balance/sms POST 方法 請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應用集成中創(chuàng)建的短信應用ID |
signature | string | 必需 | 無 | 應用密匙或數(shù)字簽名 參閱 API授權與驗證機制 > 授權和驗證方式 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權模式（ md5 or sha1 or normal ）參閱 API 授權與驗證機制 > 授權和驗證方式 |
代碼示例
發(fā)送 CURL請求
curl -d "appid=your_appid&signature=your_appkey" http://api.mysubmail.com/balance/sms.json返回
{
"status": "success",
"balance": "9410", // API 返回的當前通用類短信余額
"transactional_balance": "9775" // API 返回的當前事務類短信余額
}返回值
請求成功
{
"status": "success",
"balance": "9410",
"transactional_balance": "9775"
}請求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}