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

Чат-боты

Создание

Как создать бота?

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

Количество доступных для создания ботов зависит от типа профиля: для одного ИП или юрлица доступно 5 ботов, для самозанятого — 2 бота

Чтобы создать:

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

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

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

Можно ли сделать непубличного бота?

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

Настройка и управление

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

Вы можете изменить настройки бота только после прохождения модерации. Если вы не хотите дожидаться её окончания, удалите бота и создайте нового с теми настройками, которые вам нужны

Изменить можно все настройки, кроме ника:

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

Ник генерируется автоматически:

  • Для юрлиц и ИП — по шаблону idИНН_bot, где ИНН — номер вашей организации или ИП
  • Для самозанятых — по шаблону se(orgid)_bot, где orgid — идентификатор профиля на платформе

Выбрать или изменить его пока нельзя. Когда такая возможность появится, обратите внимание на требования к нику:

  • Должен начинаться с маленькой буквы, без @
  • Должен заканчиваться на «_bot» или «bot». Если не указать, к введённому вами имени бота автоматически будет добавлено «_bot»
  • Длина: 11 — 60 символов, включая «_bot» / «bot»
  • Допустимые символы: латиница, цифры и _
Как разрешить или запретить добавление бота в групповой чат?
  1. Перейдите на платформу MAX для партнёров в раздел Чат-боты
  2. Если у вас несколько ботов, в панели управления ботом нажмите на имя текущего бота и выберите нужный из списка
  3. Перейдите в раздел Расширенные настройки → Настроить
  4. Включите или отключите возможность добавления бота в групповой чат и нажмите Сохранить По умолчанию у созданного бота стоит запрет на его добавление в групповой чат
Как управлять ботом в MAX?

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

Можно ли поменять владельца бота?

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

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

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

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

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

Токен бота

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

Разработка

Где я могу найти примеры кода?

Ищите примеры кода в разделах «Библиотека Javascript», «Библиотека Golang» или в репозитории на GitHub: JavaScript, Golang

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

Нет, разработчики могут самостоятельно задавать любые команды ботов

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

Пока разработчики не могут отслеживать пользовательские настройки уведомлений в чат-боте

Можно ли форматировать текст в сообщениях бота?

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



Выбрать другую тему вопроса