عمليات التصدير
ملف zip لمساحة العمل كاملة.
أدوات التصدير
| الأداة | ما تفعله |
|---|---|
| getExportPreview | ما إذا كان التصدير يستطيع البدء الآن، ومتى يستطيع التالي، والتصدير الذي لا يزال قيد الصنع، وكم سيحتوي التصدير. |
| listExports | عمليات تصدير مساحة العمل، الأحدث أولًا، مع حالتها وتقدّمها وحجمها. |
| getExport | تصدير واحد بمعرّفه. |
| startExport | ابدأ صنع ملف zip لمساحة العمل كاملة، مرة في اليوم. يطلب رمز تحقق، وفي محادثة التطبيق يسأل دائمًا أولًا. |
لا يستطيع التصدير إلا مالك مساحة العمل، أو عضو يملك دوره كل الأذونات، عبر عميل مرتبط بكل العناوين. وكل أداة تحتاج إلى threads:read.
لا تعيد أي أداة ملف zip. نزّله من صفحة التصدير في التطبيق، أو بـ GET /exports/{id}/content عبر واجهة REST، أو بـ 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
المدخلات
لا يأخذ أي مدخلات.