FAQ
Если у вас возникли вопросы, посмотрите раздел с ответами — мы постарались собрать здесь максимум информации
Чат-боты
Как создать бота?
- Без разработки
Создайте бота по шаблонам конструкторов, с которыми работает цифровая платформа MAX. Следуйте пошаговой инструкции в разделе «Бот без разработки» или воспользуйтесь услугами наших партнёров. Они соберут бота для проекта любой сложности и помогут подключить его к приложению - С разработкой
Вы можете написать бота самостоятельно — перейдите в раздел «Бот с разработкой», чтобы зарегистрировать его в MAX и подключить к API приложения. Если вы планируете писать бота на TypeScript или JavaScript, воспользуйтесь официальной библиотекой MAX Bot API
Как добавить бота в MAX?
Чтобы добавить бота в MAX, найдите в поиске приложения @MasterBot и начните с ним чат:
- Нажмите команду /create
- Придумайте для чат-бота ник и название
- Получите от @MasterBot токен — уникальный идентификатор, с помощью которого бот будет взаимодействовать с API цифровой платформы
Теперь ваш бот в MAX! Управляйте его настройками в чате с @MasterBot
Есть ли ограничения для ника и имени бота?
Ограничения есть — @MasterBot принимает ники и имена ботов по следующим правилам:
- Начните ник с латинской буквы, дальше можно добавить цифры. Закончить ник нужно словом «bot» или «_bot». Минимум символов в нике с учетом окончания — 11. Готовый ник должен выглядеть примерно так: nicknamebot или nickname_bot
- Для имени можно использовать латинские и русские буквы — не более 16 символов, включая пробелы. Чтобы изменить имя бота, отправьте @MasterBot команду /set_name
Как посмотреть и изменить токен бота?
Чтобы посмотреть действующий токен бота, отправьте @MasterBot команду /get_token
Если вы опасаетесь, что уникальный идентификатор бота могли узнать посторонние люди, отзовите его командой /revoke и сгенерируйте новый через /refresh_token
Можно ли поменять владельца бота?
Владелец бота может передать права любому пользователю MAX, который уже взаимодействовал с ним. С передачей бота доступ к управлению переходит новому владельцу, это действие нельзя отменить. Чтобы поменять владельца, отправьте @MasterBot команду /transfer_bot
Обратите внимание, что первым владельцем бота является пользователь, который регистрировал его в @MasterBot. Если бот принадлежит компании, рекомендуем добавлять его в MAX с профилем, привязанным к корпоративному номеру телефона
Как изменить имя и описание бота?
Чтобы изменить имя бота, отправьте @MasterBot команду /set_name или /list → Изменить имя. Напишите новый вариант латинскими или русскими буквами — не более 16 символов, включая пробелы. Обратите внимание, что ник бота останется прежним, его нельзя изменить
Чтобы изменить описание бота, отправьте @MasterBot команду /set_description или /list → Изменить описание. Напишите любую информацию о боте — не более 512 символов
Как удалить бота из приложения?
Удалённого бота нельзя восстановить, его ник смогут взять другие пользователи
Чтобы удалить своего бота из MAX, перейдите в чат с @MasterBot, отправьте команду /delete и подтвердите действие
Где я могу найти примеры кода?
Ищите примеры кода в разделе «Библиотека MAX Bot API» или в репозитории на GitHub. Используйте нашу официальную библиотеку, если пишете ботов на TypeScript или JavaScript
Можно ли сделать непубличного бота?
В настоящее время пользователи могут найти любого бота в MAX по ссылке или по нику через поиск приложения
Есть ли у чат-ботов в MAX команды по умолчанию, предзаданные платформой?
Нет, разработчики могут самостоятельно задавать любые команды ботов
Как узнать, получают ли пользователи уведомления от чат-бота?
Возможность отслеживать у пользователей настройки уведомлений в чат-боте для разработчиков не предусмотрена
Можно ли форматировать текст в сообщениях бота?
Можно. Платформа поддерживает два типа форматирования — Markdown и HTML. Чтобы выделить информацию в сообщениях бота, например, жирным шрифтом или курсивом, отправьте параметр запроса format (enum TextFormat Nullable) — текст будет отформатирован с соответствие с указанной разметкой
События
Как получать события?
MAX поддерживает 2 метода получения обновлений о действиях в чат-боте — через Webhook и Long Polling. Входящие уведомления могут храниться на сервере до 8 часов
Чтобы получать события одним из методов, выполните запрос /updates для Long polling или /subscriptions для Webhook-подписок. Последние можно также подключить в чате с @MasterBot командой /set_webhook
Чем Long Polling отличается от Webhook-подписок, и какой метод выбрать?
Long polling и Webhook отличаются способом взаимодействия с сервером и продолжительностью отклика. Webhook после новых действий в чат-боте сам отправляет запрос на сервер, а Long Polling делает периодические запросы без триггера в боте
Выбор метода зависит от масштабов проекта. Webhook может обеспечить более эффективную обработку сообщений при высокой нагрузке, когда важна мгновенная реакция на события. Long polling — проще в настройке и подойдет для небольших задач, в которых нет повышенных требований ко времени ответа на запрос
Какие преимущества и недостатки у метода Long Polling?
Long Polling не требует внешнего сервера с защищённым соединением https и статичного IP. Бот будет самостоятельно отправлять запросы на сервер и ждать ответа о новых сообщениях
Метод не особенно эффективен при высокой интенсивности обновлений. Задержка ответов из-за ожиданий и таймаутов может накапливать очередь открытых соединений, которые будут создавать дополнительную нагрузку на сервер MAX и требовать дополнительных настроек
Какие преимущества и недостатки у Webhook-подписок?
Webhook-подписки позволяют мгновенно получать уведомления о действиях в боте, не нагружая сервер MAX периодическими опросами — обновления приходят автоматически с появлением новых данных
Чтобы работать с Webhook, необходимо настроить публичный сервер с защищённым соединением https и статичным IP-адресом. Метод эффективен при высокой интенсивности обновлений, но полностью зависит от доступности сервера и потребует защиты данных
Почему не приходят уведомления Webhook?
Webhook не может присылать уведомления, если не работает сервер бота или есть проблемы с сетью. Попробуйте повторять доставку через короткий промежуток времени — от 30 до 60 секунд — пока не появится код статуса «200 OK». Любой другой ответ сервера считается неудачной попыткой. Если бот не отвечает на уведомления более 8 часов, Webhook-подписка отменяется
Мини-приложения
Можно ли добавить мини-приложение в MAX без чат-бота?
Нет, подключить дополнительные сервисы к MAX, управлять ими и запускать можно только с помощью чат-бота. Через него мини-приложения взаимодействуют с API цифровой платформы
Как подключить мини-приложение к MAX?
Подключить мини-приложение в MAX можно только с помощью чат-бота:
- Найдите через поиск в MAX @MasterBot и начните с ним общение
- Отправьте в чат /create, чтобы создать бота, и следуйте подсказкам @MasterBot
- Выберите в настройках вашего бота Мини-приложение → Добавить или изменить
- Отправьте ссылку на мини-приложение с https:// → Готово
Подробнее об интеграции мини-приложений на платформу в разделе «Как добавить мини-приложение в MAX»
Можно ли обновлять опубликованное мини-приложение?
Да, вы можете вносить изменения, если у мини-приложения статичный URL. После деплоя пользователи просто запустят обновлённую версию
Если ссылка поменялась, обновите её через @MasterBot: /list → Выберите бота → Настройки → Мини-приложение → Добавить или изменить → Отправьте боту новую ссылку
Есть ли ограничения на контент?
Ограничения есть. Внимательно изучите Правила платформы перед размещением мини-приложения в MAX и убедитесь, что оно безопасно для пользователей и соответствует требованиям к содержанию и функциональности