GET`https://onlinesim.io/api/getBalance.php`

Получить информацию о балансе аккаунта

Возвращает текущий баланс профиля, замороженный баланс и — опционально — доход по реферальной программе.

Вы можете использовать данный запрос для проверки баланса профиля для создания уведомлений о необходимости пополнения, например для обработки исключения WARNING_LOW_BALANCE

Безопасность

apikey

BearerAuth

OAuth2

sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Параметры

query2

Название	Тип	Описание
`income`	`boolean`	Информация о доходе по реферальной программе
`lang`	`string`	Язык ответа: `fr` - французский, `de` - немецкий, `ru` - русский, `en` - английский, `zh` - китайский. Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке Перечисление:`frderuenzh`По умолчанию:`ru`

Ответы

200

Успешный ответ на запрос getBalance: сервер возвращает информацию о текущем статусе Вашего баланса или выбрасывает исключение

Content-Typeapplication/json

Схема

schemaoneOf

Успешный ответ (базовый или с деталями дохода по реферальной прогремме — в зависимости от параметра запроса income) или общая ошибка

Одно из

[0]object

[1]allOf

[2]object

Примеры

Basic successful response

Успешный ответ о текущем и замороженном балансе профиля

{
  "response": "1",
  "balance": "106.32",
  "zbalance": 0
}

Successful response with details on referral program income

Успешный ответ о текущем, замороженном балансе, а также балансе профиля реферальной программы

{
  "response": "1",
  "balance": "106.32",
  "zbalance": 0,
  "income": 12.5,
  "income_usd": 13.2
}

Примеры кода

Генерация примеров...