Обзор
Администрирование состава участников пространства и их профилей через API · Интеграции на основе API для создания чатов и отправки сообщений в указанные чаты · Входящие вебхуки для упрощенной отправки сообщений без API · Получение информации в реальном времени при помощи исходящих вебхуков · и многое другое
Полезные форматы для работы с AI:
llms.txt — краткая версия всей документации в markdown
llms-full.txt — полный markdown-файл с оглавлением
Также вы можете получить markdown-версию любой страницы, добавив .md к её адресу или используя меню «Скопировать» под заголовком страницы.
Руководства
Методы API
Боты
Боты в Пачке являются основным способом создания автоматизаций. С помощью ботов вы можете использовать входящие и исходящие вебхуки, а также использовать API.
О том, как создать бота, добавить его в чаты и получить access_token, вы можете прочитать в
статье Чат-боты через Webhook/API
Webhook
Входящий Webhook
Входящий вебхук позволяет вам от имени бота отправлять сообщения в чаты, в которых бот состоит. При этом вам не требуется использовать API, а гибкость работы с принимаемыми данными вы можете настроить с помощью шаблонизаторов Liquid и Mustache. Это удобно, если вы используете бота только для получения каких-то простых внешних событий и сами указываете, в какие чаты бот добавлен (возможно, всего в один).
Входящий вебхук не дает возможности отправить личное сообщение или в указанный чат. Сообщение будет отправлено во все групповые чаты, где состоит бот. Чтобы отправить личное сообщение или указать конкретный чат - воспользуйтесь API методом POSTНовое сообщение.
Подробнее о работе с шаблонизаторами вы можете прочитать в статье Как правильно заполнить шаблон Webhook
Исходящий Webhook
Исходящий вебхук позволяет вам получать уведомления о различных событиях на указанный вами URL.
Вы можете как получать события о всех новых сообщениях, так и только тех, которые начинаются с указанных команд.
API
Каждый созданный бот имеет свой уникальный токен для работы с API. Если вам нужно создавать чаты, управлять составом участников чатов, отправлять сообщения в указанные чаты и создавать интерактивное взаимодействие пользователя с ботом - вам необходимо использовать API.
Всю документацию по доступным методам и правилам работы с API вы можете найти в меню слева
Формы
Формы в Пачке позволяют вам отображать пользователям представления с указанным вами набором полей. Представления отображаются в виде модального окна, а результат заполнения формы вы можете получить на свой сервер. Модальное окно может быть вызвано, например, через кнопки в сообщении бота.
Администрирование
Вы можете автоматизировать управление составом участников пространства и наполнением их профилей. Каждый сотрудник в компании с ролью «Администратор» и «Владелец» имеет свой уникальный токен, который позволяет ему использовать уникальные методы API, недоступные ботам.
Список уникальных методов API:
- POSTНовый сотрудник
- PUTРедактирование сотрудника
- DELETEУдаление сотрудника
- POSTНовый тег
- PUTРедактирование тега
- DELETEУдаление тега
- DELETEУдаление сообщения
Получить access_token для работы с API вы можете в интерфейсе продукта, в разделе «Автоматизации» → «API» (данный раздел доступен только пользователям с ролью «Администратор» и «Владелец»)
Аналитика
На тарифе «Корпорация» владелец пространства может запросить экспорт через API, тем самым автоматизировать выгрузку сообщений и построение аналитики (или регулярное создание личных бекапов сообщений пространства).
Дополнительно, на любом тарифе можно получить сообщения доступных чатов через метод Список сообщений чата.
Unfurl
Дополнительным исходящим вебхуком является возможность отслеживать отправленные пользователями ссылки и дополнять их своими данными, полученными из других систем.
Подробнее о разворачивании ссылок вы можете прочитать в статье Unfurling ссылок в Пачке
Документация по работе с методом разворачивания ссылок доступна в разделе Unfurl (разворачивание ссылок)
