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

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

Заказ выгрузки сообщений пространства за период. Архив готовится в фоне.

Личные переписки выгружаются с текстом и тредами, когда поле export_personal_chats метода GETИнформация о пространстве равно true. Иначе в content их сообщений приходит -, а их треды не выгружаются.

Период выгрузки — не больше 45 дней, с chat_ids — до 366 дней, а end_at не может быть раньше start_at. Другой период отвечает 422 с кодом invalid_date_range. Больше 50 chat_ids отвечают 422 с кодом too_long, а дата не в формате YYYY-MM-DD — 422 с кодом invalid по ключу этого поля.

С заголовком Prefer: return=representation ответ приходит со статусом 202 и идентификатором экспорта в data.id. Без заголовка ответ пустой, со статусом 204. По идентификатору архив отдаёт метод GETСкачать архив экспорта, когда сборка закончится.

Когда архив готов, на адрес из webhook_url приходит вебхук с идентификатором в поле export_id. Заказавший получает письмо и уведомление в Пачке со ссылкой вида /full_exports/{id} — число в ней и есть идентификатор.

Следующую выгрузку пространство может заказать через 90 секунд после предыдущей, даже если та ещё собирается. Более ранний запрос отвечает 422 с кодом rate_limit. Запрос, отклонённый из-за периода, списка чатов или формата даты, паузу не запускает.

Адрес в webhook_url должен быть доступен из интернета по http или https, иначе метод отвечает 422 с кодом invalid_webhook_url и экспорт не запускается. Адрес с ошибкой в записи, без хоста, с другой схемой или с IP-адресом из приватного диапазона отклоняется до паузы, и исправленный запрос можно отправить сразу. Имя хоста, которое не резолвится или ведёт на приватный адрес (например, localhost), проверяется уже после того, как запрос запустил паузу, поэтому исправленный запрос получится отправить только после неё.

Заголовки запроса

Prefer
string
Просьба вернуть идентификатор экспорта в ответе. Без заголовка ответ приходит пустым, со статусом 204.
Возможные значения
Пример:return=representation

Тело запроса

application/json
start_at
string, (date)
*
Дата начала для экспорта в формате YYYY-MM-DD. Если прислать дату со временем, время молча отбрасывается — экспорт всегда идёт по календарным дням.
Пример:2025-03-20
end_at
string, (date)
*
Дата окончания для экспорта в формате YYYY-MM-DD, включительно. Если прислать дату со временем, время молча отбрасывается.
Пример:2025-03-20
webhook_url
string
Адрес, на который придёт вебхук с номером готовой выгрузки, когда архив будет собран. Номер приходит в поле export_id, а всё тело вебхука описано в разделе Экспорт.
Пример:https://example.com/webhooks/export
chat_ids[]
array of integers, (int32)
Массив идентификаторов чатов. Указывается, если нужно получить сообщения только некоторых чатов. Тред выгружается вместе с чатом родительского сообщения, поэтому идентификатор треда в списке ничего не добавляет, а самостоятельный тред не выгружается. Что попадает в архив, сказано в разделе Экспорт.
Пример:[1381521]
Количество:
<= 50 элементов
skip_chats_file
boolean
Пропуск формирования файла со списком чатов (chats.json)
Пример:false
По умолчанию:
false

Ответ

202
The request has been accepted for processing, but processing has not yet completed.
data
object
*
Заказанный экспорт сообщений
id
integer, (int32)
*
Идентификатор экспорта
Пример:22322
Экспорт сообщений
pachca chats request-export \  --start-at=2025-03-01 \  --end-at=2025-03-20 \  --chat-ids='[1381521]' \  --json \  --token YOUR_ACCESS_TOKEN