Hosted PBX API: εγγραφές φαξ και αποστολή

Χρησιμοποιήστε HTTPS και έλεγχο ταυτότητας HTTP Basic με εγκεκριμένα διαπιστευτήρια API. Φυλάσσετε τα διαπιστευτήρια στον διακομιστή της εφαρμογής σας. Αυτά τα τελικά σημεία του Hosted 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Η αναφορά εγγράφου που αναμένει αυτή η ροή εργασίας φαξ· δεν είναι τυχαία διαδρομή τοπικού αρχείου.

Παρακολούθηση ολοκλήρωσης

Μετά την υποβολή, ελέγξτε την κατάσταση, τις απόπειρες και το σφάλμα της εγγραφής του φαξ. Επιβεβαιώστε την παράδοση αντί να θεωρείτε την αποδοχή ως παράδοση. Η αναφορά φαξ της πύλης (portal) τεκμηριώνει την τρέχουσα ροή μεταφόρτωσης και αποστολής· οι διαδρομές και ο έλεγχος ταυτότητάς της είναι ξεχωριστά από το endpoint που αναφέρεται παραπάνω.

Αναζήτηση τεκμηρίωσης