REST API → Боты

GET /api/v1/bots

Список всех ботов, принадлежащих владельцу ключа.

Scope: read

curl "https://capybara.maxbotstat.ru/api/v1/bots" \
     -H "X-API-Key: $MBS_KEY"

Ответ

{
  "data": [
    {
      "id": "5d4e3a2b-7c6f-4b8e-9d1a-2c3b4e5f6a7b",
      "name": "MyShop bot",
      "provider": "telegram",
      "active": true,
      "created_at": "2025-09-15T10:00:00Z",
      "last_proxy_at": "2026-04-30T15:23:01Z",
      "bot_display_name": "MyShop bot",
      "contacts_count": 412,
      "messages_24h": 87
    }
  ]
}

Поля

Поле	Тип	Описание
id	string (UUID)	публичный идентификатор бота
name	string	имя, заданное в кабинете
provider	telegram | max	платформа бота
active	boolean	активен ли бот (если выключен — прокси возвращает 404 на webhook)
created_at	ISO 8601	когда добавлен
last_proxy_at	ISO 8601 | null	время последнего апдейта через прокси
bot_display_name	string	отображаемое имя бота из Telegram/Max
contacts_count	int	общее число контактов
messages_24h	int	сообщений за последние 24 часа

GET /api/v1/bots/{id}

Расширенная карточка бота. id — публичный UUID.

curl "https://capybara.maxbotstat.ru/api/v1/bots/5d4e3a2b-7c6f-4b8e-9d1a-2c3b4e5f6a7b" \
     -H "X-API-Key: $MBS_KEY"

Ответ

{
  "id": "5d4e3a2b-7c6f-4b8e-9d1a-2c3b4e5f6a7b",
  "name": "MyShop bot",
  "provider": "telegram",
  "active": true,
  "created_at": "2025-09-15T10:00:00Z",
  "last_proxy_at": "2026-04-30T15:23:01Z",
  "bot_display_name": "MyShop bot",
  "bot_avatar_url": "https://api.telegram.org/file/bot.../photo.jpg",
  "target_url": "https://yourapp.com/tg-webhook",
  "poll_offset": 0,
  "poll_last_at": null,
  "poll_last_error": null,
  "contacts_count": 412
}

Без bot_token

Поле bot_token через REST API никогда не возвращается — даже владельцу. Если вам нужно увидеть токен, посмотрите его в кабинете один раз при добавлении.

Ошибки

HTTP	Когда
404	Бот с таким UUID не существует или принадлежит другому пользователю
401	См. Аутентификацию

Что нельзя через REST API

• Создать бота (POST /bots) — только через кабинет (требует подтверждения email и проверки токена).
• Удалить бота (DELETE /bots/{id}) — только через кабинет.
• Изменить target_url — только через кабинет.

Эти операции требуют дополнительного интерактивного UX и админ-проверок, поэтому в публичном API их нет. Если нужна автоматизация — пишите в поддержку.