残高照会

EngageLab SMSアカウントの利用可能残高をリアルタイムに取得する必要がある場合は、このAPIを呼び出せます。アカウントの一般残高、付与残高、合計残高が返されます。

リクエストURL

GET https://smsapi.engagelab.com/v1/balance

呼び出し認証

APIリクエストの認証方法については、呼び出し認証を参照してください。

リクエスト例

リクエストヘッダー

              
              GET /v1/balance  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

リクエストボディ

なし

リクエストパラメータ

なし

レスポンスパラメータ

成功レスポンス

HTTPステータスコードは200で、レスポンスボディには次のフィールドが含まれます。

              
              {
    "balance10000": 123456,
    "gift_balance10000": 20000,
    "balance": 12.3456,
    "gift_balance": 2,
    "total_balance10000": 143456,
    "total_balance": 14.3456
}

            

開発上の推奨 浮動小数点の精度の問題を避けるため、呼び出し側では balance10000、gift_balance10000、total_balance10000 フィールドを優先的に使用し、残高を自身でフォーマットすることをおすすめします。

エラーレスポンス

HTTPステータスコードは4xxまたは5xxで、レスポンスボディには次のフィールドが含まれます。

              
              {
    "code": 2001,
    "message": "invalid token"
}

            

エラーコード