השתמשו ב-HTTPS ובאימות HTTP Basic עם פרטי גישה מאושרים ל-API. שמרו את פרטי הגישה בשרת היישום שלכם. נקודות הקצה האלה של מרכזיית PBX מתארחת משתמשות ב-/hpbx/ ב-api.multitel.net; אל תוסיפו /v3. בדקו גם את תוצאת ה-HTTP וגם את סטטוס היישום בתגובת ה-JSON.
קריאת רשומות פקס
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"השתמש בקוד החיוב של ה-PBX שלך. הרשומות המוחזרות כוללות את זמן הפקס, הכיוון, המקור, היעד, מצב המסירה, הניסיונות, השגיאות ומספר העמודים. המסירה עשויה עדיין להיות בהמתנה גם לאחר שבקשת השליחה התקבלה.
שליחת פרמטרים
נקודת הקצה לשליחה היא POST /hpbx/fax/send/{billing_code}. פעולה זו שולחת בפועל. הכינו את הקובץ ואת היעד המורשה בחשבון לפני ההגשה; אל תנסו לשלוח שוב בלי לבדוק כאשר לא ברור אם ניסיון השליחה הקודם הצליח.
| שדה | משמעות |
|---|---|
| number | מספר הפקס של היעד. |
| cidnum | זיהוי מתקשר מאושר לשליחה. |
| schedule | מועד שליחה מתוזמן, כאשר נעשה בו שימוש. |
| faxquality / pagesize / pagerotate | אפשרויות נתמכות של איכות, גודל נייר וסיבוב. |
| statusemail | כתובת מורשית עבור הודעות מסירה. |
| deleteaftersend | האם להסיר את הקובץ שהועלה ונשמר לאחר שליחתו. |
| filename | הפניית המסמך שזרימת העבודה של הפקס מצפה לה; אין זה נתיב קובץ מקומי שרירותי. |
מעקב אחר השלמה
לאחר הגשת הבקשה, בדקו את מצב רשומת הפקס, מספר הניסיונות והשגיאה. ודאו שהפקס נמסר בפועל; אל תפרשו את קבלת הבקשה כאישור מסירה. מדריך הפקס בפורטל מתעד את תהליך ההעלאה והשליחה הנוכחי, שהנתיבים והאימות שלו נפרדים מנקודת הקצה שלעיל.