הורדת מסמך של פקס יוצא

בקשת המסמך

השתמשו בחשבון פעיל של MultiTEL API. עבור חשבון המבוסס על סיסמה, שלחו פרטי הזדהות מסוג HTTP Basic, ועבור חשבון המבוסס על אסימון, שלחו אסימון מסוג Bearer. הרשאות החשבון והגבלות כתובות הרשת עדיין חלות. אל תשתמשו בפרטי ההזדהות של רכיב העיבוד הפנימי.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode job_id=0123456789abcdef0123456789abcdef \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_download

השתמשו באותו ערך חובה של job_id, המורכב מ-32 תווים הקסדצימליים, כמו בבקשה ל-fax_status. בקשת הלקוח מוגבלת לבעלים שזהותם אומתה. דוגמה זו שומרת בנפרד את כותרות התגובה ואת הבתים שלה, כדי ששגיאת API לא תזוהה בטעות כמסמך PDF.

טיפול בקובץ או בשגיאה בפורמט JSON

בהצלחה מוחזרים הבתים הגולמיים של המסמך עם כותרות Content-Type ו-Content-Disposition המציינות קובץ מצורף, ולא מעטפת JSON. בדקו את הכותרות האלה לפני מתן שם לקובץ שנשמר, פתיחתו או עיבודו. התגובה עשויה להיות בפורמט PDF, בפורמט TIFF או בפורמט המקורי שהועלה, בהתאם למסמך הזמין. משימה הממתינה בתור עשויה להחזיר את קובץ המקור שלה לפני ההמרה.

בכישלון מוחזרת מעטפת JSON הרגילה של status/response. קוד API שערכו 400 מציין כי job_id חסר או אינו במבנה תקין; 401 מציין שחסר אימות זהות; 404 מציין שהמשימה או הקובץ שלה אינם זמינים לחשבון זה. בדקו את Content-Type ואת status.code גם כאשר קוד המצב של HTTP הוא 200.

זמינות ופרטיות

קיומה של רשומת משימה אינו מבטיח שהקובץ יהיה זמין להורדה לעד; תקופת השמירה לא אומתה. בעת הצורך, שמרו מסמכים שיש לכם הרשאה לגשת אליהם באחסון שבשליטתכם. הקובץ המוחזר עשוי להכיל מידע פרטי על הנמען. הורדות אינן משדרות פקס חדש.