GET /api/client/info

Метод для получения информации о текущем клиенте и балансе.

примечание

Сущность клиента можно рассматривать как организацию.

Чаще всего одному клиенту соответствует ровно один пользователь.

При использовании субаккаунтов у одного клиента может быть несколько пользователей, имеющих разные полномочия.

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

Полный URL запроса

https://cp.redsms.ru/api/client/info

Структура ответа

Пример тела ответа:

{
  "info": {
    "login": "some_username",
    "balance": 81347.47,
    "active": true,
    "monthLimitAmount": "420000",
    "currentMonthAmount": 500.02,
    "restOfMonthLimit": 419499.98,
    "overdraft": 20000,
    "overdraftExpiration": 1703019602
  },
  "success": true
}

Описание полей объекта info

Поля, тип которых начинается с символа ?, могут отсутствовать в ответе. Их наличие зависит от настроек клиента.

Поле	Тип	Описание
login	string	Логин клиента
balance	float	Текущий баланс клиента в рублях
active	boolean	Флаг, указывающий на то, что клиент имеет подтверждённый договор и полный доступ к функционалу
monthLimitAmount	?string	Размер лимита расходов в месяц, установленного в настройках в личном кабинете
currentMonthAmount	?float	Количество расходов в текущем календарном месяце в рублях
restOfMonthLimit	?float	Остаток от лимита расходов в текущем календарном месяце в рублях
overdraft	?float	Овердрафт
overdraftExpiration	?timestamp	Время до которого предоставлен овердрафт

Возможные коды ответа

Код	Описание
200	Успешный ответ, всё хорошо
401	Недействительная авторизация – проверьте значения заголовков и наличие ограничений белого списка IP в личном кабинете
404	Некорректный URL запроса – убедитесь, что путь запроса не заканчивается на /