מפתחים

GET/v3/fax_inbox

הצגת פקסים שהתקבלו

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

בעמוד זה
  1. הצגת פקסים שהתקבלו
  2. קריאת עמוד בתיבת הדואר
  3. טיפול ברשימות ריקות ומשתנות
  4. גישה למסמכים ופרטיות

הצגת פקסים שהתקבלו

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

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox
פרמטרים לשאילתת תיבת הדואר הנכנס
פרמטרחובהמשמעות
pageלאמספר העמוד, החל מ־1. ברירת המחדל: 1.
limitלאמספר הרשומות בכל עמוד. ברירת המחדל: 25; המספר המרבי: 100. השתמשו במספר שלם חיובי.
searchלאמחפש במספר השולח, במספר הפקס המקבל ובמזהה התחנה המרוחקת. רווחים בתחילת הטקסט ובסופו מוסרים. ההבחנה בין אותיות גדולות לקטנות תלויה בכללי השוואת הטקסט של מסד הנתונים.
date_fromלאכולל פקסים מתחילת היום הזה לפי השעה המקומית של השרת. השתמשו בתבנית YYYY-MM-DD.
date_toלאכולל פקסים עד סוף היום הזה לפי השעה המקומית של השרת. השתמשו בתבנית YYYY-MM-DD.

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

קריאת עמוד בתיבת הדואר

קראו את תוצאת ה־HTTP ואת השדה status.code ב־JSON. כשלים במקומות אחרים ב־API עשויים להשתמש במעטפת שגיאה מסוג JSON גם כאשר סטטוס ה־HTTP הוא 200. תגובה מוצלחת מכילה את response.faxes ואת response.pagination. בדוגמה זו נעשה שימוש בערכים בדויים.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id הוא המזהה המספרי של הרשומה בתיבת הדואר הנכנס. hash הוא ייצוג ה־MD5 שלה עבור תהליך העבודה הישן של מסמכים נכנסים; הוא אינו מזהה משימה של send_fax ואינו פרט גישה המקנה הרשאה. אל תשתמשו בו עם נקודת הקצה לפקסים יוצאים fax_status.

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

status הוא success רק כאשר קוד הסטטוס השמור הוא אפס; ערכים אחרים הופכים ל־failed. status_text מכיל את הודעת העיבוד השמורה, עם OK או Failed כערכי גיבוי. emailed משמר את הערך השמור במקום ערך בוליאני. viewed הוא ערך בוליאני. אין להסיק שהודעת הדואר האלקטרוני נמסרה בהצלחה על סמך סטטוס הפקס בלבד.

טיפול ברשימות ריקות ומשתנות

תיבת דואר ריקה מחזירה מערך faxes ריק, total בערך 0 ו־total_pages בערך 0. גם בקשת עמוד שמעבר לעמוד האחרון עשויה להחזיר מערך ריק. הפסיקו בהתאם לשדות החלוקה לעמודים במקום להניח שקיים לפחות עמוד אחד. לא נחשפים סמן לדפדוף או מיון משני לפי מזהה רשומה. שמרו את מזהי הרשומות בעת התאמת הנתונים בין עמודים חופפים.

גישה למסמכים ופרטיות

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