API: balance/mail


概览


balance/mail 是 SUBMAIL 的邮件余额查询 API。

使用 balance/mail 可以实时获取您账户的邮件余额。



URL


<主> https://api.mysubmail.com/balance/mail
<备> https://api.submail.cn/balance/mail


支持格式


格式URL
jsonhttps://api.mysubmail.com/balance/mail.json(默认)
xmlhttps://api.mysubmail.com/balance/mail.xml


http 请求方式


请求方式content-type设置
http postmultipart/form-data、x-www-form-urlencoded、application/json


是否需要授权


参阅 API 授权和验证机制


balance/mail POST 方法 请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短信应用ID
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal )参阅 API 授权与验证机制 > 授权和验证方式
signaturestring必需应用密匙 _或 _数字签名参阅 API 授权与验证机制 > 授权和验证方式


代码示例


发送 CURL
curl -d "appid=your_appid&signature=your_appkey" http://api.mysubmail.com/balance/mail.json


返回
{
"status": "success",
"balance": 50    // API 返回的当前邮件余额
"free_balance": 50    // API 返回的当前当日免费邮件余额
}


返回值


请求成功
{
"status":"success"
}


请求失败
{
"status":"error",
"code":"1xx",
"msg":"error message"
}


错误代码


参阅 API 错误代码