خروجی‌ها
یک zip از کل فضای کاری.
ابزارهای خروجی
| ابزار | چه می‌کند |
|---|---|
| getExportPreview | اینکه آیا خروجی همین حالا می‌تواند شروع شود، خروجی بعدی کی می‌تواند، خروجی‌ای که هنوز در حال ساخت است، و یک خروجی چقدر در بر می‌گیرد. |
| listExports | خروجی‌های فضای کاری، تازه‌ترین‌ها اول، با وضعیت، پیشرفت و اندازه‌شان. |
| getExport | یک خروجی با شناسه‌اش. |
| 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
ورودی‌ها
هیچ ورودی‌ای نمی‌گیرد.