gethttps://onlinesim.io/api/getBalance.php

GET /api/getBalance.php

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

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

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

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

apikey

BearerAuth

OAuth2Области: sms-scope

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

Схема

ResponseoneOf

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

Одно из

[0]object

responsestringОбязательный

Код выполнения запроса: 1 - при успехе

Перечисление:1

balancestringОбязательный

Текущий доступный баланс (в валюте профиля)

zbalancenumberОбязательный

Замороженный баланс — средства, зарезервированные под активные операции. Возвращаются на основной баланс при отмене операций

≥ 0

[1]allOf

Все из

[0]object

responsestringОбязательный

Код выполнения запроса: 1 - при успехе

Перечисление:1

balancestringОбязательный

Текущий доступный баланс (в валюте профиля)

zbalancenumberОбязательный

≥ 0

[1]object

incomenumberОбязательный

Доход по реферальной программе (в валюте профиля)

≥ 0

income_usdnumberОбязательный

Тот же доход, конвертированный в USD

≥ 0

[2]object

responsestringОбязательный

Код ошибки в формате UPPER_SNAKE_CASE, возвращается в поле response при HTTP-статусе 200. Список кодов не является закрытым и может пополняться. Неизвестный код следует трактовать как обобщенную ошибку и логировать для разбора.

Известные коды, сгруппированные по смыслу:

Параметры запроса

UNDEFINED_COUNTRY — некорректное значение параметра страны. Доступные значения — в списке стран;
UNDEFINED_DAYS — некорректный срок аренды или продления. Допустимые значения — в объекте days ответа tariffsRent - для базовых сроков аренды, и в объекте extend ответа getRentState - для продления;
ERROR_NO_SERVICE — некорректное значение параметра сервиса. Доступные значения — в списке сервисов.

Состояние и доступность

NO_NUMBER — нет доступных номеров с указанными параметрами. Повторите запрос позже или попробуйте другую страну;
WARNING_LOW_BALANCE — недостаточно средств на балансе.

Аккаунт и доступ

ACCOUNT_BLOCKED — аккаунт заблокирован;
API_ACCESS_DISABLED — доступ к API отключён в настройках профиля (см. тумблер API включено);
API_ACCESS_IP — IP-адрес отсутствует в allowlist (см. Доступ с IP).

Авторизация

ERROR_WRONG_KEY — некорректный API-ключ;
ERROR_NO_KEY — API-ключ отсутствует.

Лимиты запросов

INTERVAL_CONCURRENT_REQUESTS_ERROR — превышена допустимая частота или количество одновременных запросов.

Маршрутизация

REQUEST_NOT_FOUND — имя вызываемого метода некорректно или отсутствует.

Прочее

TRY_AGAIN_LATER — непредвиденная ошибка

Примеры

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
}

Примеры кода

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