Как добавить, изменить или удалить команды чат-бота через API MAX
Список команд с косой чертой (/), который пользователи видят в поле ввода при общении с ботом, настраивается через HTTP API методом PATCH /me/commands.
Где отображаются команды бота
Заголовок раздела «Где отображаются команды бота»По данным документации MAX API:
- В личных диалогах с ботом на iOS, Android и в приложении для компьютера подсказки появляются при вводе символа
/. На iOS меню команд также открывается по отдельной кнопке/в правом нижнем углу поля ввода. - В групповых чатах с участием бота быстрые команды доступны на iOS и Android при вводе
/. - В каналах команды чат-ботов не поддерживаются.
О стандартных командах рассказано в статье есть ли у чат-ботов в MAX команды по умолчанию.
Как добавить или обновить список команд
Заголовок раздела «Как добавить или обновить список команд»Метод PATCH https://platform-api.max.ru/me/commands полностью заменяет текущий список команд бота новым массивом commands. В массиве можно передать до 32 элементов типа BotCommand.
Для авторизации передайте токен бота в заголовке Authorization: <access_token> (как получить или перевыпустить токен: как обновить токен бота).
curl -X PATCH "https://platform-api.max.ru/me/commands" \ -H "Authorization: <access_token>" \ -H "Content-Type: application/json" \ -d '{ "commands": [ { "name": "start", "description": "Запустить бота" }, { "name": "help", "description": "Показать справку" }, { "name": "settings", "description": "Настройки уведомлений" } ] }'При успешном выполнении сервер возвращает {"success": true}.
Как проверить текущие команды бота
Заголовок раздела «Как проверить текущие команды бота»Чтобы посмотреть, какие команды уже зарегистрированы у бота, вызовите метод GET https://platform-api.max.ru/me с тем же заголовком Authorization: <access_token>. В объекте BotInfo вернётся поле commands со списком активных команд (до 32 элементов BotCommand).
Как удалить все команды из меню
Заголовок раздела «Как удалить все команды из меню»Чтобы полностью очистить меню команд бота, отправьте запрос PATCH /me/commands с пустым массивом commands (документация MAX API):
curl -X PATCH "https://platform-api.max.ru/me/commands" \ -H "Authorization: <access_token>" \ -H "Content-Type: application/json" \ -d '{"commands": []}'Если нужно удалить только одну команду, передайте в commands оставшиеся команды, которые должны сохраниться.
Похожие материалы
Заголовок раздела «Похожие материалы»- Есть ли у чат-ботов в MAX команды по умолчанию, предзаданные платформой?
- Первый чат-бот MAX через API
- Как получить и сохранить ID чата или канала (chat_id) в API MAX