Public API v2¶

Доступно начиная с тарифа Plus

Public API v2 доступен пользователям тарифов Plus и Pro.

Public API v2 предоставляет программный доступ к основным функциям Hotline для интеграции с CRM, внутренними сервисами, аналитикой и инструментами автоматизации.

Актуальная интерактивная документация, полный набор методов, модели данных и примеры запросов доступны в Scalar-интерфейсе Hotline API.

Scalar-интерфейс позволяет:

просматривать актуальные методы и модели запросов и ответов
авторизоваться через Instance-Id и Instance-Token
выполнять тестовые запросы из браузера
смотреть примеры запросов для Shell, Python и Node.js

Для проверки методов используйте тестовое подключение и не запускайте изменяющие или массовые операции на рабочем подключении без предварительной проверки параметров.

Открыть Hotline API v2

Основные возможности¶

Методы API сгруппированы по основным объектам и сценариям Hotline:

Instance — получение информации о подключении и связанных Telegram-профилях, запуск, остановка и перезапуск подключения
Dialog — поиск и получение диалогов, создание новых диалогов и изменение их статуса
Message — отправка сообщений в диалоги и бекенд-группу, получение информации о сообщениях
Say — создание, просмотр, переименование и удаление быстрых ответов, отправка быстрых ответов в диалоги
Mark — управление метками, их параметрами и назначениями в диалогах
Sending — управление шаблонами и рассылками, получателями, запуском и состоянием рассылки, получение отчётов
Export — запуск экспорта данных, проверка статуса и скачивание готового отчёта

Набор методов постоянно развивается. При проектировании интеграции всегда сверяйтесь с актуальной документацией в интерфейсе API.

Адрес и авторизация¶

Базовый адрес Public API v2:

https://api.production.hotline.tg/api/v2/

Все запросы к API используют HTTP Basic:

Поле HTTP Basic	Данные подключения Hotline
`Username`	`Instance-Id`
`Password`	`Instance-Token`

В установочном боте @hotlinetg_bot откройте нужное подключение. В его карточке:

Instance ID используется как Instance-Id
API key используется как Instance-Token

Пример запроса информации о подключении:

curl --user "$INSTANCE_ID:$INSTANCE_TOKEN" \
  https://api.production.hotline.tg/api/v2/instance

Храните Instance-Token в секрете

Не публикуйте Instance-Token в коде, логах и открытых репозиториях. Храните его в переменных окружения или secret-хранилище.

После сброса API key в установочном боте прежний токен перестаёт действовать — обновите credentials во всех интеграциях этого подключения.