для разработчиковdev

FAQ

Если у вас возникли вопросы, посмотрите раздел с ответами — мы постарались собрать здесь максимум информации

Общее

Кто может подключиться к платформе MAX для партнёров?

Подключение к платформе MAX для партнёров и её сервисам — чат-ботам, мини-приложениям, каналам — пока доступно для ограниченного списка юрлиц и ИП, которые разместили приложение в RuStore или зарегистрировались на МСП.РФ

Самозанятые, физические лица и нерезиденты пока не смогут авторизоваться или зарегистрироваться на платформе

Какие данные указывать при регистрации аккаунта в мессенджере MAX?

При регистрации в поле для имени и фамилии указывайте имя и фамилию ответственного представителя, а не название организации. Иначе данные такого аккаунта могут быть распознаны как подозрительные — это повлечёт за собой блокировку

Какой номер телефона указать при регистрации на платформе для партнёров?

Регистрируйтесь с рабочим номером телефона ответственного представителя

Номер должен быть актуальным и находиться у вас в постоянном доступе, так как на него будут приходить коды подтверждения и важные уведомления

Указанному при регистрации номеру телефона будет соответствовать один профиль организации и привязанные к нему сервисы: чат-боты, мини-приложения и каналы.
Если у вас есть канал с меткой A+ на другой платформе: ВКонтакте, Дзен, Одноклассники, Telegram — вы можете создать в MAX канал с таким же названием и ником. В этом случае при регистрации используйте номер телефона, на который создан канал на другой платформе.

Какой ИНН указывать при регистрации организации на платформе для партнёров?

Указывайте ИНН вашей организации. Не вводите тестовые ИНН или личные ИНН сотрудников

У меня проблемы при подтверждении организации на платформе, что делать?

Подробнее процесс подтверждения организации описан в подразделе «Верификация организации»

У меня остались вопросы по работе с платформой MAX для партнёров

Напишите нам на почту

В какие сроки вы отвечаете на обращения по платформе для партнёров?

Из-за большого потока обращений срок ответа составляет до 5 рабочих дней. Пожалуйста, не направляйте повторные запросы по одной и той же теме — это увеличивает общее время ожидания ответа

Чат-боты

Как создать бота?
Вы можете создать чат-бот, только если у вас есть верифицированный профиль организации. Для одной организации доступно создание 5 ботов

  1. Перейдите на платформу и выберите верифицированный профиль организации
  2. В разделе Чат-бот и мини-приложение нажмите Создать
  3. Заполните данные в настройках бота (его карточке) и нажмите Создать

После успешной модерации бот становится доступным для ваших пользователей, а вы можете доработать его под свой сценарий

Если планируете разработку на TypeScript или JavaScript, воспользуйтесь разделами «Библиотека JavaScript», «Библиотека Golang»

Как управлять ботом в MAX?
После успешной проверки чат-бота в разделе Чат-бот и мини-приложение → Настроить появится токен — уникальный идентификатор бота, с помощью которого он будет взаимодействовать с API ботов. Наличие токена означает, что бот зарегистрирован на платформе MAX для партнёров

Как изменить имя, аватар, описание и другие настройки бота?
Изменить можно все настройки, кроме ника:

  1. Перейдите на платформу MAX для партнёров
  2. Если у вас несколько ботов, в левом верхнем углу выберите нужный
  3. Справа нажмите на значок настроек
  4. Внесите изменения и нажмите Сохранить — бот будет отправлен на повторную модерацию

Как разрешить или запретить добавление бота в групповой чат

  1. Перейдите на платформу MAX для партнёров
  2. Если у вас несколько ботов, в левом верхнем углу выберите нужный
  3. Перейдите в раздел Чат-бот и мини-приложение → Настроить
  4. Включите или отключите возможность добавления бота в групповой чат и нажмите Сохранить
    По умолчанию у созданного бота стоит запрет на его добавление в групповой чат

Есть ли ограничения для ника и имени бота?
Ник генерируется автоматически по шаблону idИНН_bot. Выбрать или изменить его пока нельзя. Когда такая возможность появится, обратите внимание на требования к нику:

Как посмотреть токен бота?

  1. Перейдите на платформу MAX для партнёров
  2. Если у вас несколько ботов, в левом верхнем углу выберите нужный
  3. Перейдите в раздел Чат-бот и мини-приложение → Настроить — токен находится в поле с одноимённым названием

Как обновить токен бота

  1. Перейдите на платформу MAX для партнёров
  2. Если у вас несколько ботов, в левом верхнем углу выберите нужный
  3. Перейдите в раздел Чат-бот и мини-приложение → Настроить
  4. Справа от поля с токеном нажмите на значок обновления

Как удалить бота?

ℹ️ После удаления ваши клиенты не смогут пользоваться ботом. Удалённого бота нельзя восстановить

Чтобы удалить:

  1. Перейдите на платформу MAX для партнёров
  2. Если у вас несколько ботов, в левом верхнем углу выберите нужный
  3. Справа нажмите на значок настроек
  4. Нажмите Удалить бота и подтвердите удаление

Можно ли поменять владельца бота?
Поменять владельца или передать права на управление ботом пока нельзя

Где я могу найти примеры кода?
Ищите примеры кода в разделе «Библиотека MAX Bot API» или в репозитории на GitHub. Используйте нашу официальную библиотеку, если пишете ботов на TypeScript или JavaScript

Можно ли сделать непубличного бота?
В настоящее время пользователи могут найти любого бота в MAX по ссылке или по нику через поиск приложения

Есть ли у чат-ботов в MAX команды по умолчанию, предзаданные платформой?
Нет, разработчики могут самостоятельно задавать любые команды ботов

Как узнать, получают ли пользователи уведомления от чат-бота?
Возможность отслеживать у пользователей настройки уведомлений в чат-боте для разработчиков не предусмотрена

Можно ли форматировать текст в сообщениях бота?
Можно. Платформа поддерживает два типа форматирования — Markdown и HTML. Чтобы выделить информацию в сообщениях бота, например, жирным шрифтом или курсивом, отправьте параметр запроса format (enum TextFormat Nullable) — текст будет отформатирован в соответствии с указанной разметкой

Мини-приложения

Можно ли добавить мини-приложение в MAX без чат-бота?
Нет, подключить дополнительные сервисы к MAX, управлять ими и запускать можно только с помощью чат-бота. Через него мини-приложения взаимодействуют с API ботов

Как подключить мини-приложение к MAX?

  1. Перейдите в профиль организации на платформе MAX для партнёров
  2. Перейдите в раздел Чат-бот и мини-приложение → Настроить
  3. Вставьте URL мини-приложения в поле для ссылки
  4. Выберите вид кнопки открытия мини-приложения (Открыть, Старт или Играть) и нажмите Сохранить

Требования к URL мини-приложения:

Подробнее об интеграции мини-приложений — в разделе «Как добавить мини-приложение в MAX»

Как обновить ссылку на приложение

  1. Перейдите в профиль организации на платформе MAX для партнёров
  2. Если у вас несколько ботов, в левом верхнем углу выберите нужный
  3. Перейдите в раздел Чат-бот и мини-приложение → Настроить
  4. Обновите URL мини-приложения в поле для ссылки и нажмите Сохранить

Как изменить кнопку открытия приложения

  1. Перейдите в профиль организации на платформе MAX для партнёров
  2. Если у вас несколько ботов, в левом верхнем углу выберите нужный
  3. Перейдите в раздел Чат-бот и мини-приложение → Настроить
  4. Выберите нужный вид кнопки и нажмите Сохранить

Как удалить приложение

  1. Перейдите в профиль организации на платформе MAX для партнёров
  2. Если у вас несколько ботов, в левом верхнем углу выберите нужный
  3. Перейдите в раздел Чат-бот и мини-приложение → Настроить
  4. Удалите URL мини-приложения из поля для ссылки и нажмите Сохранить

Можно ли обновлять опубликованное мини-приложение?
Да, вы можете вносить изменения, если у мини-приложения статичный URL. После деплоя пользователи просто запустят обновлённую версию
Если ссылка поменялась, на платформе MAX для партнёров выберите нужную организацию, перейдите в раздел Чат-бот и мини-приложение → Настроить, укажите новую ссылку и нажмите Сохранить

Есть ли ограничения на контент для мини-приложений?
Ограничения есть. Внимательно изучите Правила платформы перед размещением мини-приложения в MAX и убедитесь, что оно безопасно для пользователей и соответствует требованиям к содержанию и функциональности

Можно ли открыть несколько мини-приложений одновременно?
Нет, при открытии нового мини-приложения текущее закроется. Мы работаем над поддержкой одновременной работы нескольких мини-приложений

В чём разница между функциями openLink и openMaxLink?
openLink откроет любую ссылку во внешнем браузере. openMaxLink откроет только ссылку на мини-приложение вида https://max.ru/<botName>?startapp внутри приложения MAX — в новой шторке, без перехода во внешний браузер

Каналы

Какие каналы можно создать

Если у вас есть ресурсы с меткой А+ на одной из платформ: ВКонтакте, Дзен, Одноклассники, Telegram — вы можете создать в MAX каналы с такими же названиями и никами через бота Каналы в МАХ. Можно добавить столько каналов, сколько у вас есть ресурсов с меткой А+ на указанных платформах

Также, независимо от наличия ресурсов с меткой А+ и регистрации в Роскомнадзоре, вы можете создать ещё один канал через платформу MAX для партнёров. Название канала вы выбираете сами, а ник генерируется автоматически. Чтобы добавить такой канал, потребуется зарегистрироваться на платформе и верифицировать организацию.

Профиль в MAX должен быть создан на тот же номер телефона, что вы использовали при регистрации на платформе

Как создать канал с выбранным вами названием и автогенерированным ником через платформу MAX для партнёров

  1. Откройте платформу
  2. Перейдите в Каналы → Создать
  3. Выберите Создать новый канал для бизнеса
  4. Отсканируйте QR-код или нажмите кнопку — вы перейдёте в бота для создания каналов в MAX Каналы в MAX для бизнеса: @business_channel_bot
  5. Нажмите Начать, затем выберите Создать
  6. Поделитесь номером телефона
  7. Дождитесь обработки заявки — вам придёт уведомление
  8. Введите название канала
  9. Получите название и автогенерированный ник idИНН_biz
  10. Нажмите Создать канал. Готово!

Как создать канал с таким же ником и названием, как у ресурса с меткой А+ на других платформах
Доступно, если у вас есть канал или сообщество с меткой А+ на одной из платформ — ВКонтакте, Одноклассники, Дзен, Telegram
Обратите внимание: профиль в MAX должен быть создан на тот же номер телефона, что вы использовали для регистрации ресурса с меткой А+ в Роскомнадзоре

  1. Перейдите в чат-бот Каналы в MAX: @channel_bot → Начать
  2. Нажмите Создать
  3. Выберите платформу, где у вас есть метка А+. От этого зависят дальнейшие шаги:
    • Для ВКонтакте, Одноклассники, Дзен
      1. Поделитесь номером телефона
      2. Отправьте ссылку на ваш ресурс с меткой А+
      3. Отправьте ссылку на регистрацию ресурса с меткой А+ в Роскомнадзоре. После проверки бот пришлёт вам соответствующее уведомление
      4. Нажмите Создать. Готово!
    • Для Telegram
      1. Отправьте ссылку на регистрацию канала с меткой А+ в Роскомнадзоре — бот пришлёт вам хештег
      2. Добавьте хештег в описание канала в Telegram — после создания канала его можно будет удалить
      3. Перейдите в бот Каналы в МАХ и нажмите Проверить. После проверки бот пришлёт вам соответствующее уведомление
      4. Нажмите Создать канал. Готово!

Как изменить название, описание и аватар канала

  1. Перейдите в МАХ и выберите нужный канал в списке чатов
  2. Нажмите на название канала — так вы перейдёте в Профиль канала
  3. Чтобы открыть настройки канала, в правом верхнем углу нажмите на значок редактирования с карандашом
  4. Внесите необходимые изменения и сохраните их

Можно ли изменить ссылку на канал?
Сейчас ссылку на канал — короткое имя канала, то есть его ник — изменить нельзя.

Почему заблокирован канал?
Канал может быть заблокирован, если нарушены права на товарный знак или поступили жалобы на канал, например на его публикации, тематику, название, описание

События

Как получать события?
MAX поддерживает два метода получения обновлений о действиях в чат-боте — через Webhook и Long Polling. Использовать одновременно их нельзя — выберите один из типов
 Входящие уведомления могут храниться на сервере до 8 часов
Чтобы подключить уведомления, отправьте к API POST-запрос /subscriptions с URL, на который хотите получать уведомления

Чтобы получать события одним из методов, используйтн GET-запросы /updates для Long Polling или /subscriptions для 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 не может присылать уведомления, если не работает сервер бота или есть проблемы с сетью

Диплинки

Что такое диплинки в MAX?
Диплинки (deep links) — это специальные ссылки, которые позволяют открывать чат-ботов или мини-приложения MAX с передачей дополнительных параметров. С их помощью можно передавать контекстную информацию, отслеживать источники переходов или автоматически выполнять определённые действия при запуске

Какие версии клиентов MAX поддерживают диплинки?

Механизм диплинков поддерживается в следующих версиях клиентов MAX:

Как создать диплинк для чат-ботов?

Используйте следующий формат ссылки:

Код
Скопировать
https://max.ru/<botName>?start=<payload>

Где:

Подробнее о диплинках ботов читайте в разделе «Бот без разработки»

Как создать диплинк для мини-приложения?

Используйте следующий формат ссылки:

Код
Скопировать
https://max.ru/<botName>?startapp=<payload>

Где:

Подробнее о диплинках приложений читайте в разделе «Подключение мини-приложения»