Αποστολή φαξ

Πριν από την αποστολή

Χρησιμοποιήστε έναν αριθμό αποστολέα που έχετε εξουσιοδότηση να εμφανίζετε και στείλτε το φαξ σε παραλήπτη που το αναμένει. Αυτό το αίτημα δημιουργεί πραγματική μετάδοση, η οποία ενδέχεται να χρεωθεί. Χρησιμοποιήστε ένα έτοιμο έγγραφο PDF ή TIFF για την πιο προβλέψιμη ανίχνευση σελίδων. Μια απόκριση ένταξης στην ουρά επιβεβαιώνει την αποδοχή, όχι την παράδοση.

Χρησιμοποιήστε έναν ενεργοποιημένο λογαριασμό API της MultiTEL. Στείλτε διαπιστευτήρια HTTP Basic για λογαριασμό με κωδικό πρόσβασης ή διακριτικό Bearer για λογαριασμό με διακριτικό. Τα δικαιώματα του λογαριασμού και οι περιορισμοί διευθύνσεων IP εξακολουθούν να ισχύουν. Μη χρησιμοποιείτε τα εσωτερικά διαπιστευτήρια της διεργασίας επεξεργασίας.

Μεταφόρτωση του εγγράφου

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --form-string from_number=+12125550123 \
  --form-string to_number=+12125550124 \
  --form fax_file=@./document.pdf \
  https://api.multitel.net/v3/send_fax

Πεδία αιτήματος
Πεδίο	Υποχρεωτικό	Σημασία
`from_number`	Ναι	Ο αριθμός αποστολέα που έχετε εξουσιοδότηση να χρησιμοποιείτε. Χρησιμοποιήστε διεθνή μορφή που αρχίζει με + και τον κωδικό χώρας.
`to_number`	Ναι	Ο αριθμός φαξ του παραλήπτη, σε διεθνή μορφή.
`fax_file`	Ναι για αιτήματα πολλαπλών μερών	Το έγγραφο που μεταφορτώθηκε. Αφήστε το curl να ορίσει το Content-Type και το διαχωριστικό των μερών για το αίτημα πολλαπλών μερών.
`webhook_url`	Όχι	Προαιρετικό URL για ειδοποιήσεις επανάκλησης μέσω HTTP ή HTTPS· προτιμάται το HTTPS. Το περιεχόμενο των ειδοποιήσεων και οι εγγυήσεις παράδοσης εξακολουθούν να εξετάζονται: υποβάλλετε περιοδικά ερωτήματα στο fax_status για την τεκμηριωμένη ροή παρακολούθησης της κατάστασης.

Γίνεται επίσης δεκτό JSON με Content-Type: application/json, τα ίδια πεδία αριθμών και το προαιρετικό webhook_url, καθώς και τα file_name και file_b64. Το file_b64 περιέχει τα byte του εγγράφου με αυστηρή κωδικοποίηση Base64, χωρίς πρόθεμα data:. Ένα έγκυρο fax_file σε αίτημα πολλαπλών μερών έχει προτεραιότητα. Αυτό δεν είναι API ανάκτησης αρχείων μέσω URL.

Όρια εγγράφων και υποβολών

Η εφαρμογή δέχεται έως 15,728,640 αποκωδικοποιημένα byte εγγράφου (15 MiB), με επεκτάσεις pdf, tif, tiff, jpg, jpeg, png, doc, docx ή txt. Μια επιτρεπόμενη επέκταση δεν εγγυάται ότι η υπηρεσία μπορεί να μετρήσει ή να μετατρέψει τις σελίδες. Τα όρια αιτημάτων της υποδομής ενδέχεται να είναι χαμηλότερα και η κωδικοποίηση Base64 αυξάνει το μέγεθος του αιτήματος.

Για κάθε λογαριασμό, η τρέχουσα εφαρμογή επιτρέπει μία εργασία στην ουρά ή σε αποστολή προς τον ίδιο προορισμό, έως πέντε υποβολές προς αυτόν τον προορισμό κατά την προηγούμενη ώρα και έως 50 υποβολές συνολικά κατά την προηγούμενη ώρα. Μια απόκριση περιορισμού συχνότητας χρησιμοποιεί τον κωδικό API 429. Περιμένετε πριν δοκιμάσετε ξανά· μην επιχειρείτε να παρακάμψετε τα όρια.

Κρατήστε το αναγνωριστικό της εργασίας

Ελέγξτε τόσο το αποτέλεσμα HTTP όσο και το status.code στο JSON. Οι αποτυχίες JSON ενδέχεται να επιστρέφονται με HTTP 200. Μια επιτυχής απόκριση JSON περιέχει status και response· τα παραδείγματα χρησιμοποιούν εικονικά δεδομένα.

{
  "status": {
    "code": 200,
    "msg": "Fax queued"
  },
  "response": {
    "job_id": "0123456789abcdef0123456789abcdef"
  }
}

Υποβάλλετε περιοδικά ερωτήματα στο fax_status χρησιμοποιώντας το response.job_id. Αν χαθεί η απόκριση αποστολής, ελέγξτε τα εξερχόμενα της πύλης πριν στείλετε ξανά: τα επαναλαμβανόμενα αιτήματα μπορούν να δημιουργήσουν ξεχωριστές μεταδόσεις. Αυτός ο χειριστής δεν παρέχει καμία παράμετρο ιδιοδυναμίας για τον πελάτη.

Σφάλματα και έλεγχοι υπολοίπου

Οι κωδικοί API περιλαμβάνουν τον 400 για πεδία που λείπουν, μη έγκυρο URL επανάκλησης, απόρριψη εγγράφου ή αποτυχία ανίχνευσης σελίδων· τον 401 για έλλειψη ελέγχου ταυτότητας· τον 402 όταν το εκτιμώμενο κόστος του φαξ μαζί με τις εκτιμήσεις για τις εργασίες στην ουρά ή σε αποστολή υπερβαίνει το διαθέσιμο υπόλοιπο του λογαριασμού· τον 429 για περιορισμούς συχνότητας· και τον 500 για αποτυχία προετοιμασίας της μετάδοσης. Διαβάστε το status.msg για τη συγκεκριμένη αιτία.

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