Боты: как создать и подключить
Что такое бот в Syncra, как его создать, получить ключ доступа и отправить первое сообщение из своей программы.
Бот — это участник рабочего пространства, которым управляет программа, а не человек. Он есть в списке участников, состоит в каналах и пишет сообщения под своим именем. Через бота ваши сервисы сами сообщают команде о сборках, ошибках и заказах, а ещё бот может отвечать на команды и события.
Создавать и настраивать ботов могут владелец и администратор рабочего пространства. Остальные участники видят список ботов, но не видят их настройки и ключи доступа.
Как создать бота
- Откройте настройки рабочего пространства, вкладку «Боты».
- Нажмите «Новый бот».
- Заполните «Имя». Описание и ссылка на аватар необязательны.
- Нажмите «Создать бота». Сразу откроется страница нового бота.
Если включить «Ответы ИИ», бот будет отвечать встроенным ИИ, когда его упоминают и в личной переписке с ним. Тогда же появится поле «Системный промпт (необязательно)»: в нём своими словами описывают, как бот должен отвечать. Если бот только публикует сообщения от вашей программы, «Ответы ИИ» включать не нужно.
Как получить ключ
- На странице бота найдите раздел «API-токены» и нажмите «Создать токен».
- Введите «Название токена» и подтвердите. Откроется окно «Токен создан».
- Скопируйте токен сразу. Он начинается с
skb_и показывается один раз. Потом в списке видны только его первые символы, и полный токен посмотреть уже нельзя. Если вы его не сохранили, создайте новый. - Нажмите «Готово».
Токен привязан к одному боту и одному рабочему пространству. Если токен попал не туда, нажмите «Отозвать» в его строке. Отозванный токен перестаёт работать сразу.
Как добавить бота в канал
Бот читает сообщения и отвечает только в каналах, где он состоит. На странице бота в разделе «Каналы» выберите канал в списке «Добавить в канал» и нажмите «Добавить». Ваша программа может и сама добавить бота в канал через API (так называется набор запросов, которыми программы работают с Syncra), но только в открытый канал.
Первое сообщение
Отправьте запрос с токеном и идентификатором канала:
curl -X POST "https://ai-syncra.ru/api/bot/v1/messages" \
-H "Authorization: Bearer skb_..." \
-H "Content-Type: application/json" \
-d '{"channelId":"<id канала>","text":"Сборка 142 прошла"}'
Ответ {"ok":true,"messageId":"...","deduplicated":false} значит, что сообщение опубликовано. Идентификаторы каналов возвращает запрос GET /api/bot/v1/channels: в его списке открытые каналы рабочего пространства и все каналы, где бот состоит. Остальные запросы описаны в справочнике API ботов, ссылка на него в конце статьи.
Что бот умеет и чего нет
- Умеет: писать и редактировать свои сообщения, отвечать в ветках, читать историю каналов, где он состоит, открывать личные чаты, читать задачи, комментировать их, менять исполнителя, срок, приоритет и статус, отмечать задачи выполненными.
- Не умеет через API ботов: создавать задачи и страницы базы знаний, ставить реакции, искать, получать список участников рабочего пространства.
- Бот принадлежит одному рабочему пространству. Подключить одного бота сразу к нескольким пространствам нельзя.
Как выключить или удалить бота
На странице бота переключатель «Бот включён» останавливает его, не стирая настройки. Кнопка «Удалить бота» убирает его вместе с токенами, вебхуками, подписками и командами.
Что ещё почитать
Обновлено: