Экспорты
Zip всего рабочего пространства.
Инструменты экспорта
| Инструмент | Что делает |
|---|---|
| getExportPreview | Может ли экспорт начаться сейчас, когда сможет следующий, экспорт, который ещё собирается, и сколько попадёт в экспорт. |
| listExports | Экспорты рабочего пространства, сначала новые, с их статусом, ходом и размером. |
| getExport | Один экспорт по его id. |
| startExport | Начать сборку zip всего рабочего пространства, раз в день. Просит код подтверждения, а в чате приложения всегда сначала спрашивает. |
Экспортировать может только владелец рабочего пространства или участник, чья роль даёт все разрешения, через клиент, подключённый со всеми адресами. Каждому инструменту нужна threads:read.
Ни один инструмент не возвращает zip. Скачайте его на странице «Экспорт» в приложении, через GET /exports/{id}/content в REST API, через exports.download в SDK или через openemail exports download в командной строке.
Некоторые инструменты этого сервера вносят изменение, которое REST API защищает кодом подтверждения, и спрашивают тот же код. Пока клиент не подтвердил код за последние 60 минут и человек не выбрал для него «Разрешить изменения на 60 минут» в разделе «Аккаунт → Подключённые приложения», такой инструмент отвечает результатом, который начинается с Refused (step_up_required):, и ничего не меняет. emptyAudience никогда не спрашивает код. Страница «Аутентификация» в API перечисляет все инструменты, которые спрашивают код, и показывает, как запросить код и подтвердить его.
Справочник
getExportPreview
Whether this workspace can be exported now, when the next export can start, the export still being made, and how much an export would hold: conversations, attachments, contacts, audiences, calendar events, templates, rules, labels, notes and addresses.
Входные данные
Не принимает входных данных.
Также доступно в
listExports
The exports of this workspace, newest first, with their status, progress, size and when each is deleted. A ready one is downloaded on the Export page of the app or with GET /exports/{id}/content on the REST API.
Входные данные
limitinteger- Не меньше 1Не больше 100
offsetinteger- Не меньше 0
Также доступно в
getExport
One export by its id: its status, its progress through the conversations, its size and when it is deleted.
Входные данные
idstringОбязательно- От 1 до 128 символов
Также доступно в
startExport
Start making a zip of the whole workspace, as Export now on the Export page does. It is made in the background, one at a time and once a day, and kept for a year. Ask the person first.
- Запрашивает код подтверждения
POST /exports
Входные данные
Не принимает входных данных.