查询账户余额
更新时间：2023-07-12
1.功能说明
1.1.该接口可以查询指定账户的当前短信余额情况。
1.2.查询余额调用地址：http(s)://api.guoyangyun.com/api/sms/smsBalance.htm
1.3.请求方式：以HTTP POST请求的方式（推荐使用post方式）。
1.4.汉字字符集：UTF-8，请注意参数的大小写。
1.2.查询余额调用地址：http(s)://api.guoyangyun.com/api/sms/smsBalance.htm
1.3.请求方式：以HTTP POST请求的方式（推荐使用post方式）。
1.4.汉字字符集：UTF-8，请注意参数的大小写。
2.输入参数
| 参数 | 名称 | 类型 | 必须 | 描述 |
| 公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
3.调用示例
http(s)://api.guoyangyun.com/api/sms/smsBalance.htm?appkey=123456&appsecret=20a1eb330d41d0d4da
4.Json返回
4.1.返回参数
| 参数 | 名称 | 类型 | 描述 |
| code | 错误码 | Int | 提交返回结果。0：表示成功，其他：失败。（状态码详见：《公共错误代码定义》） |
| msg | 返回信息 | String | 返回信息。 |
 data |
余额信息 | List | 返回已开通产品账户余额信息 |
| instanceId | 产品账户ID | String | 返回产品账户ID |
| balance | 产品账户余额 | String | 返回账户余额 |
| TotalUsage | 产品账户累计消耗 | String | 返回累计消耗 |
| productName | 产品账户名称 | String | 返回产品账户名称 |
| status | 产品账户状态 | String | 返回产品账户状态，ENABLE：启用，DISABLE：禁用 |
4.2.调用成功样例
{
"code":"0",
"msg":"成功",
"data":[ // 仅显示已开通产品的账户余额
{
"instanceId":"431241233", // 产品账户ID
"balance":129, // 产品账户余额
"totalUsage":3, // 产品账户累计消耗
"productName":"身份证实名认证", // 产品账户名称
"status": "ENABLE" // 产品账户状态
},
{
"instanceId":"431243214",
"balance":28,
"totalUsage":2,
"productName":"运营商实名认证",
"status": "ENABLE"
},
{
"instanceId":"432141243",
"balance":975,
"totalUsage":77,
"productName":"国内验证码通知短信",
"status": "ENABLE"
},
{
"instanceId":"432141244",
"balance":562,
"totalUsage":72,
"productName":"国内会员营销短信",
"status": "ENABLE"
},
{
"instanceId":"431242155",
"balance":200,
"totalUsage":33,
"productName":"银行卡实名认证",
"status": "DISABLE"
}
]
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容”
}