اختيار مستند وارد أو صادر
تسترجع نقطة النهاية هذه المخصصة للتوافق مستند فاكس تابعًا لحسابك. استخدم حساب MultiTEL مفعّلًا لواجهة API عبر HTTPS، مع بيانات الاعتماد وقيود عناوين IP المضبوطة له. وهي لا ترسل فاكسًا ولا تعيد إرساله.
| المعلمة | مطلوبة | المعنى |
|---|---|---|
type | نعم | استخدم inbound أو outbound كما هو موضح تمامًا. |
id | نعم | بالنسبة إلى inbound، استخدم قيمة hash التي تعيدها fax_inbox. وبالنسبة إلى outbound، استخدم قيمة uuid التي تعيدها fax_outbox. |
يجب وضع هذه القيم في المسار. والمسار هو /v3/fax_file/{type}/{id}، وليس fax_download مع مقاطع مسار إضافية. قيمة تجزئة الفاكس الوارد ليست المعرّف الرقمي للسجل، وليست معرّف مهمة صادرة. انسخ المعرّف من قائمة الصندوق المناسب؛ فهو لا يغني عن المصادقة.
تنزيل فاكس مستلم
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710تمثل قيمة التجزئة في المثال سجلًا وهميًا في صندوق الوارد رقمه 12. احصل على القيمة الخاصة بك من fax_inbox. يؤدي تنزيل سجل وارد موجود إلى تعليمه على أنه تمت مشاهدته. ويحدث ذلك قبل التحقق من توفر الملف، لذا قد تظل قيمة viewed مضبوطة على true حتى عند حدوث خطأ يفيد بعدم توفر الملف. لا تستخدم نقطة النهاية هذه لمجرد التحقق من وجود فاكس مستلم إذا أردت إبقاء حالة مشاهدته دون تغيير.
يعطي المعالج الأولوية لملف PDF مخزّن. وإلا فإنه يستخدم ملف TIFF المخزّن ويحاول تحويله إلى PDF عندما يكون المحوّل متاحًا. إذا تعذر التحويل أو نتج عنه استثناء يتولى المعالج التعامل معه، فإنه يعيد ملف TIFF بدلًا من ذلك. افحص دائمًا Content-Type المُعاد بدلًا من افتراض أن الملف بتنسيق PDF.
تنزيل فاكس صادر
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdefاستخدم قيمة uuid من fax_outbox. يعطي تنزيل التوافق هذا الأولوية لكتلة بيانات ثنائية مخزّنة بتنسيق PDF، ثم كتلة بيانات ثنائية بتنسيق TIFF، ثم ملف متاح بتنسيق PDF أو ملف بتنسيق TIFF أو الملف المصدر الأصلي. ويختلف ترتيب الأولوية فيه عن ترتيب المعالج الحالي لتنزيل الفاكس الصادر fax_download. بالنسبة إلى عمليات التكامل الجديدة التي تستخدم send_fax، استخدم سير عمل التنزيل الحالي ذاك مع معلمته job_id.
قد يُعاد الملف المصدر الأصلي بالنوع application/octet-stream بدلًا من PDF أو TIFF. وقد يحتفظ اسم الملف المرفق بامتداد الملف المصدر. لا يؤدي تنزيل الفاكس الصادر المخصص للتوافق إلى تعليم سجل في صندوق الوارد على أنه تمت مشاهدته، ولا إلى تغيير حالة المهمة، ولا إلى إنشاء عملية إرسال.
التعامل مع البايتات والأخطاء كلٌّ على حدة
عند النجاح، تُعاد بايتات المستند الخام مع الترويسات Content-Type وContent-Disposition التي تشير إلى مرفق وContent-Length. وليست الاستجابة غلافًا بتنسيق JSON يحتوي على بيانات بترميز Base64. احفظ الترويسات والبايتات كلًّا على حدة كما هو موضح، وافحص نوع الاستجابة، ثم بعد ذلك فقط أعطِ الملف اسمًا مناسبًا أو عالجه. وجود امتداد مسموح به للملف المصدر لا يضمن أن المستند صالح أو أنه قد تم تحويله.
يعني الرمز 400 في API أن قيمة مطلوبة في المسار مفقودة أو أن type غير صالح. ويعني الرمز 404 في API أن السجل التابع للحساب أو ملفه غير متاح. تستخدم الأخطاء غلاف status/response المعتاد بتنسيق JSON، وقد تستخدم HTTP 200. افحص Content-Type في الاستجابة وقيمة status.code في JSON حتى لا يُفتح محتوى استجابة الخطأ على أنه مستند.
الخصوصية والتوفر
قد يحتوي الفاكس على معلومات حساسة. لا تخزّن الملفات المنزّلة إلا في أماكن يستطيع المستلمون المقصودون الوصول إليها، وتجنب تضمين بايتات المستند كاملةً في السجلات. لا يضمن وجود سجل في الصندوق بقاء ملفه متاحًا. لم تُحدَّد أي مدة للاحتفاظ بالملفات، ولم يُقرَّر أي ضمان للتوافق يشمل جميع المستندات القديمة المخزّنة.