GetAccountInfo

POST

https://api.voximplant.com/platform_api/GetAccountInfo

POST

/platform_api/GetAccountInfo

curl -X POST https://api.voximplant.com/platform_api/GetAccountInfo \
     -H "Authorization: Bearer <token>"

200Account's info

{
  "result": {
    "account_id": 3456750,
    "account_name": "ivan123",
    "account_email": "ivan123@mail.ru",
    "created": "2020-08-07 12:00:53",
    "language_code": "en",
    "location": "Europe/Moscow",
    "min_balance_to_notify": 300,
    "account_notifications": true,
    "tariff_changing_notifications": true,
    "news_notifications": true,
    "active": true,
    "frozen": false,
    "balance": 19772.347212,
    "credit_limit": 0,
    "currency": "RUR",
    "support_robokassa": false,
    "support_bank_card": true,
    "support_invoice": true,
    "send_js_error": false,
    "billing_limits": {
      "bank_card": {
        "min_amount": 500,
        "currency": "RUR",
        "max_day_payment": 7642.17
      },
      "invoice": {
        "min_amount": 1000,
        "currency": "RUR"
      }
    },
    "a2p_sms_enabled": false,
    "max_sip_registrations": 0,
    "fixed_balance": 20169.93192,
    "money_on_hold": 397.584708,
    "bank_card_provider": "ALFABANK",
    "enabled_3ds": true,
    "record_storage_id": 125,
    "mobile_phone": "",
    "allow_invoice": true,
    "is_bank_card_auto_charge_prohibited": true,
    "taxpayer_type": "default",
    "custom_pricing": false,
    "grace_credit": 0,
    "record_storage_name": "my-storage",
    "credit_limit_aware_balance_notifications": false,
    "live_balance": 19772.347212
  },
  "api_address": "api-node1.voximplant.com",
  "debugger_address": "api-node1.voximplant.com"
}

Gets the account’s info such as account_id, account_name, account_email etc.

Example request: Get the account’s info.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

return_live_balancebooleanOptionalDefaults to true

Whether to get the account's live balance

Response

Successful response

resultobjectOptional

Account's info as the [AccountInfoType] object instance

api_addressstringOptional

The preferred address for the Management API requests

debugger_addressstringOptional