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