API

Экспорт сообщений

ВНИМАНИЕ
Доступно только на тарифе Корпорация
ПРИМЕЧАНИЕ
Экспорт сообщений доступен только с access_token владельца пространства. Подробнее о том, как получить такой токен — в разделе Запросы и ответы.
Бот пока не может работать с подобными методами и взаимодействует с API на уровне обычного участника пространства.

Экспорт сообщений — это архив c файлами в формате JSON, где собраны все сообщения из всех чатов, которые были созданы в вашем пространстве.

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

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

На основе выгрузки можно замерять количество сообщений и реакций в общих чатах. Так можно рассчитать Engagment Rate и улучшать корп. культуру/коммуникацию среди сотрудников. Ещё можно подсчитывать количество активных чатов и смотреть, насколько много в компании ведется обсуждений.

Запрос экспорта

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

При запросе экспорта важно учитывать следующие ограничения:

  • выгружаются все чаты, в том числе архивные и личные без контента сообщений
  • не выгружаются треды в личных сообщениях
  • не учитываются вложения
  • не отражаются пересланные сообщения
  • максимальный период одной выгрузки: 45 дней (при запросе с указанием конкретных чатов - 366 дней)
  • максимальный количество запрашиваемых чатов (при указании): 50
  • новый запрос на экспорта вы сможете сделать после завершения текущего

Для запроса экспорта используйте метод Экспорт сообщений.

Экспорт выполняется асинхронно. На указанный webhook_url будет отправлен JSON с информацией о готовом экспорте.

Пример JSON вебхука об успешном завершении экспорта

Скачивание готового архива

Получив JSON с информацией о готовом экспорте, вам необходимо взять значение поля export_id и выполнить запрос на скачивание архива сообщений, указав его в URL запроса.

Для скачивания архива используйте метод Скачать архив экспорта.

Архив сообщений

Архив представляет собой папки, где каждая папка соответствует чату в вашем пространстве. Название папки состоит из имени чата и его ID, например: Design_12925828. Внутри папки будут JSON-файлы, которые соответствуют дате переписки. Каждый день — отдельный файл.

Дополнительно, рядом с папками будет находиться список чатов, которые попали в экспорт. Список чатов представлен файлом chats.json. Список не создается, если при запросе экспорта было указано skip_chats_file как true.

Структура данных в JSON-файлах сообщенийobject

Список в файле chats.json представляет собой массив объектов чатов. Структура каждого объекта чата описана ниже.

Структура объекта чата в массиве файла chats.jsonobject