Документация

Быстрый старт по EasyTgAPI: ключи, инстансы, сообщения и webhook.

Быстрый старт

  1. Зарегистрируйтесь и создайте API-ключ в личном кабинете.
  2. Создайте инстанс: Personal-аккаунт или Telegram-бот.
  3. Подключите авторизацию: QR/телефон для Personal или токен BotFather для бота.
  4. Отправьте первое сообщение через REST API.

Справочник API

Основные ресурсы:

МетодEndpointОписание
GET/api/v1/instancesСписок инстансов
POST/api/v1/instancesСоздать инстанс
GET/api/v1/instances/{id}Информация об инстансе
DELETE/api/v1/instances/{id}Удалить инстанс
POST/api/v1/instances/{id}/messagesОтправить сообщение
POST/api/v1/instances/{id}/messages/batchМассовая отправка
POST/api/v1/instances/{id}/messages/mediaОтправить медиа
GET/api/v1/instances/{id}/chatsСписок чатов
GET/api/v1/instances/{id}/chats/{chat_id}/historyИстория чата
GET/api/v1/instances/{id}/contactsСписок контактов
POST/api/v1/instances/{id}/groupsСоздать группу
POST/api/v1/webhooksСоздать webhook
GET/api/v1/webhooksСписок webhook
DELETE/api/v1/webhooks/{id}Удалить webhook

Параметры отправки сообщения

ПараметрТипОбязательныйОписание
chat_idintegerДаID чата
textstringДаТекст сообщения

Коды ошибок

КодОписание
200Успех
400Неверный запрос (проверьте параметры)
401Не авторизован (неверный или отсутствует API-ключ)
403Доступ запрещён (недостаточно прав)
404Инстанс или ресурс не найден
429Превышен лимит запросов (rate limit)
500Внутренняя ошибка сервера

Rate limits

Лимит по умолчанию — 120 запросов в минуту. Тариф может задать другой лимит. При превышении возвращается 429.

Авторизация

Передавайте ключ в заголовке X-Api-Key или Authorization: Bearer. Для совместимости также поддерживается ключ в URL.

Webhook

События доставляются на ваш URL с HMAC-подписью, retry и журналом доставок. Один инстанс может отправлять события в несколько систем.

Поддержка

Для вопросов по интеграции пишите в Telegram: @easytgapi.