К содержанию
MGRAMБаза знаний

API статистики и управления ботом

Данные бота, заказы, доход и настройки через Bot API key.

Обновлено 16 октября 20262 мин чтения3 просмотра

С Bot API key ваш сервер может получать статистику бота и менять его настройки — без захода в @mgram_robot. Удобно, если у вас много ботов или своя панель управления.

Ключ

  • Bot API key находится в карточке бота: «Настройки» → «API-ключ».
  • Каждый запрос отправляется с заголовком Authorization: Bearer ВАШ_BOT_API_KEY.
  • POST /key/regenerate выпускает новый ключ. Полный ключ показывается только один раз, старый сразу перестаёт работать.

Что можно получить

МетодЧто возвращает
GET /botИнформация о боте
GET /audienceАудитория без ID пользователей: всего, Premium, верифицированные, с аватаром, описанием и подарками, заблокировавшие, гео
GET /ordersЗаказы рассылок, в которых участвовал бот
GET /orders/{id} и /orders/{id}/reportДетали и отчёт рассылки
GET /reply-ads/ordersЗаказы Показов в боте
GET /stats/mailings и /stats/mailings/todayРассылки по дням и за сегодня
GET /stats/reply-adsСтатистика Показов
GET /stats/income и /stats/income/todayДоход по дням и за сегодня
GET /earningsЗаработок: сегодня, ожидается, всего
GET /balanceБаланс владельца

Что можно изменить

МетодЧто делает
POST /bot/settingsСлоты, скорость, каталог, свои заказы, участие в рассылках, цена в каталоге, Показы
GET /bot/time_slotsДоступные слоты и текущий выбор
POST /bot/stop_mailingОтключает участие в новых рассылках; назначенные заказы продолжаются
POST /bot/tokenЗаменяет токен Telegram-бота — только на токен того же бота

Менять можно только настройки, доступные владельцу в интерфейсе MGRAM, и только допустимыми значениями.

Ошибки

Все ошибки приходят в одном формате. Основные коды:

КодЧто значит
400Некорректный запрос — проверьте параметры
401Ключ не принят
403Нет доступа к операции
404Не найдено
409Конфликт запроса
429Слишком много запросов — повторите позже
5xxВременная ошибка сервиса — повторите позже

Храните Bot API key только на сервере. Не вставляйте его в код Mini App, сайта или клиентского приложения.

Параметры и примеры ответов каждого метода — на api.mgram.biz.