ANT
  • Introduction
    • Authentication
    • Number
    • Errors
    • Rate Limits
  • ANT API
    • Balance
      • Retrieve balance
    • Sms
      • Marketing SMS
        • Send Marketing SMS
        • Send Bulk Marketing SMS
        • Scheduled Marketing SMS
        • Marketing SMS CallBack
      • 🔥OTP SMS
        • Send OTP SMS
        • OTP SMS CallBack
        • ⭐OTP Backfill Interface
      • Notification SMS
        • Send Notification SMS
        • Send Bulk Notification SMS
        • Scheduled Notification SMS
        • Notification SMS CallBack
    • Voip
      • IVR
        • IVR File Upload
        • IVR Task
        • IVR Callback
      • Call
        • Call the phone
        • Call record callback
    • Phone Number Validation
      • HLR Sever
      • Check Number Status
  • Webhooks
    • Test Webhooks
  • Demo
    • Java Demo
Powered by GitBook
On this page
  1. ANT API
  2. Balance

Retrieve balance

Retrieves the current account balance.

Url

POST https://api.antgst.com/user/account/balance

Content-Type

application/json

Request Body

NameType
Description

string

Curl Example

curl --location --request POST 'https://api.antgst.com/user/account/balance' 
--header 'Content-Type: application/json' 
--data '{"authSecret": "YOUR_API_KEY"}'

Response

{
    "msg": "SUCCESS",
    "code": 200,
    "result": {
        "smsBalance": -18.383,
        "voipBalance": 0.0,
        "currency": "CNY"
    }
}
{
	"msg": "auth secret error!",
	"code": -22
}

Response parameter description

Filed
Description

msg

response result information

response status code

result

response result parameter

result.smsBalance

balance of SMS service

result.voipBalance

balance of voip service

result.currency

currency

PreviousBalanceNextSms

Last updated 12 days ago

authSecret
authSecret = AccessKey ID+ AccessKey Secret Provided by Antgst
code