בחירת מסמך נכנס או יוצא
נקודת קצה זו, המיועדת לתאימות, מאחזרת מסמך פקס השייך לחשבון שלכם. השתמשו בחשבון API פעיל של MultiTEL דרך HTTPS, עם פרטי ההזדהות והגבלות כתובות הרשת שהוגדרו עבורו. היא אינה שולחת פקס ואינה שולחת אותו מחדש.
| פרמטר | חובה | משמעות |
|---|---|---|
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. שמרו את הכותרות ואת הבתים בנפרד כפי שמוצג, בדקו את סוג התגובה, ורק אז תנו לקובץ שם מתאים או עבדו אותו. סיומת מקור מותרת אינה מבטיחה מסמך תקין או מסמך שעבר המרה.
קוד API מספר 400 מציין שחסר ערך חובה בנתיב או שהערך של type אינו תקין. קוד API מספר 404 מציין שהרשומה המשויכת לחשבון או הקובץ שלה אינם זמינים. שגיאות משתמשות במעטפת status/response הרגילה בתבנית JSON, ועשויות להשתמש ב־HTTP 200. בדקו את Content-Type של התגובה ואת status.code ב־JSON, כדי שגוף תגובה של שגיאה לא ייפתח כמסמך.
פרטיות וזמינות
תוכן פקס עשוי לכלול מידע רגיש. אחסנו קבצים שהורדו רק במקום שבו הנמענים המיועדים שלכם יכולים לגשת אליהם, והימנעו מהכללת מלוא הבתים של המסמך ביומני רישום. רשומה בתיבת הדואר אינה מבטיחה שהקובץ שלה יישאר זמין. לא נקבעה תקופת שמירה לקבצים ולא ניתנה הבטחת תאימות לכל מסמך היסטורי מאוחסן.