查询账户余额

用于查询账户当前余额,分为现金余额和代金券余额,调用时需要计算 数字签名

URL

  1. https://sms.wilddog.com/api/v1/{:appId}/getBalance

返回数据格式

  1. JSON

HTTP 请求方式

  1. GET

参数说明

参数 类型 必选 说明
signature string 数字签名 ,合法性验证,其中参与数字签名计算的参数包括timestamp
timestamp string UNIX 时间戳,精度为毫秒

注意:

  • 生成数字签名时不要使用 urlencode,在调用 API 时,才需要对参数做 urlencode
  • 返回账户余额单位为厘,1 元 = 1000 厘。
  • 返回说明

    正常返回如下:

    1. "Content-Type": "application/json; charset=utf-8"
    2. {
    3. "status":"ok",
    4. "data":"{
    5. "balance" : 10000000 // 现金余额
    6. "voucherBalance" : 10000000// 代金券余额
    7. }
    8. }

    异常返回如下:

    1. {
    2. "errcode": 7xxxx,
    3. "message": "xxxxxx"
    4. }

    其中 errcode 对应信息在此处查询 短信错误码

    示例代码

    1. curl -X GET https://sms.wilddog.com/api/v1/{appId}/getBalance -d "signature=$signature&timestamp=$timestamp"