Руководство разработчика
Добро пожаловать в документацию Znakora Bot API 3.0. Это HTTP-интерфейс, который позволяет подключать ботов к нашей системе обмена сообщениями. Боты могут отправлять текстовые сообщения, медиафайлы, использовать интерактивные кнопки и реагировать на действия пользователей.
Базовый URL для всех запросов:
Все запросы должны выполняться методом POST. Параметры можно передавать как JSON.
Авторизация
Каждый бот идентифицируется токеном, который выдается при его создании. Токен выглядит примерно так: 123456:AAHE....
Как получить токен:
- Откройте приложение Znakora.
- Нажмите кнопку создания чата (+).
- Выберите тип "Бот".
- Укажите имя и уникальную ссылку (должна заканчиваться на
_bot). - Скопируйте токен из первого системного сообщения.
Полный пример (Python)
Простой Echo-бот, который отвечает на команды и пересылает текст обратно. Использует библиотеку requests.
Методы: Сообщения
Используйте этот метод для отправки текстовых сообщений.
| Параметр | Тип | Описание |
|---|---|---|
| chat_id | Int | Уникальный идентификатор чата или пользователя. |
| text | String | Текст отправляемого сообщения (до 4096 символов). |
| reply_markup | JSON | Объект клавиатуры (Inline или Reply). |
Используйте этот метод для отправки фотографий.
| Параметр | Тип | Описание |
|---|---|---|
| chat_id | Int | ID чата. |
| photo | String | URL фотографии или файл (при использовании multipart/form-data). |
| caption | String | Подпись к фотографии (опционально). |
Используйте этот метод для редактирования текста сообщений, отправленных ботом.
| Параметр | Тип | Описание |
|---|---|---|
| message_id | String | Идентификатор сообщения для редактирования. |
| text | String | Новый текст сообщения. |
Используйте этот метод для удаления сообщения.
| Параметр | Тип | Описание |
|---|---|---|
| message_id | String | Идентификатор сообщения. |
Методы: Обновления
Используйте этот метод для получения входящих обновлений с помощью Long Polling. Запрос будет удерживаться сервером до 30 секунд, если нет новых данных.
Укажите URL, на который сервер будет отправлять HTTPS POST запросы при поступлении новых сообщений (Push-модель).
| Параметр | Тип | Описание |
|---|---|---|
| url | String | HTTPS URL вашего сервера. |
Используйте этот метод, чтобы удалить интеграцию с Webhook и переключиться обратно на getUpdates (Long Polling).
Отправляет ответ на нажатие Inline-кнопки (callback_query). Этот метод убирает индикатор "загрузки" на кнопке у пользователя.
| Параметр | Тип | Описание |
|---|---|---|
| callback_query_id | String | ID запроса, полученный в объекте Update. |
| text | String | Текст всплывающего уведомления (опционально). |
API