Προγραμματιστές

GET/v3/fax_file/{type}/{id}

Λήψη φαξ από τα εισερχόμενα ή τα εξερχόμενα

Ανακτήστε ένα ληφθέν φαξ με το hash του στα εισερχόμενα ή ένα παλαιότερο εξερχόμενο έγγραφο με το UUID του και διαχειριστείτε τη μορφή του αρχείου που επιστρέφεται.

Σε αυτή τη σελίδα
  1. Επιλέξτε ένα εισερχόμενο ή εξερχόμενο έγγραφο
  2. Λήψη ληφθέντος φαξ
  3. Λήψη εξερχόμενου φαξ
  4. Διαχειριστείτε χωριστά τα byte και τα σφάλματα
  5. Απόρρητο και διαθεσιμότητα

Επιλέξτε ένα εισερχόμενο ή εξερχόμενο έγγραφο

Αυτό το τελικό σημείο συμβατότητας ανακτά ένα έγγραφο φαξ που ανήκει στον λογαριασμό σας. Χρησιμοποιήστε έναν ενεργοποιημένο λογαριασμό API της MultiTEL μέσω HTTPS, με τα διαπιστευτήρια και τους περιορισμούς IP που έχουν διαμορφωθεί για αυτόν. Δεν αποστέλλει ούτε επαναποστέλλει φαξ.

Παράμετροι διαδρομής λήψης
ΠαράμετροςΥποχρεωτικήΣημασία
typeΝαιΧρησιμοποιήστε inbound ή outbound, ακριβώς όπως εμφανίζονται.
idΝαιΓια το inbound, χρησιμοποιήστε την τιμή hash που επιστρέφει το fax_inbox. Για το outbound, χρησιμοποιήστε την τιμή uuid που επιστρέφει το fax_outbox.

Αυτές οι τιμές πρέπει να τοποθετούνται στη διαδρομή. Η διαδρομή είναι /v3/fax_file/{type}/{id}, όχι το fax_download με πρόσθετα τμήματα διαδρομής. Το hash του εισερχόμενου φαξ δεν είναι το αριθμητικό αναγνωριστικό της εγγραφής ούτε αναγνωριστικό εξερχόμενης εργασίας. Αντιγράψτε το αναγνωριστικό από την κατάλληλη λίστα του γραμματοκιβωτίου· δεν υποκαθιστά τον έλεγχο ταυτότητας.

Λήψη ληφθέντος φαξ

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710

Το hash του παραδείγματος αντιστοιχεί στην υποθετική εγγραφή εισερχομένων 12. Λάβετε τη δική σας τιμή από το fax_inbox. Η λήψη μιας υπάρχουσας εισερχόμενης εγγραφής την επισημαίνει ως προβληθείσα. Αυτό συμβαίνει πριν ελεγχθεί η διαθεσιμότητα του αρχείου, επομένως ακόμη και ένα σφάλμα μη διαθέσιμου αρχείου μπορεί να αφήσει το viewed στην τιμή true. Μη χρησιμοποιείτε αυτό το τελικό σημείο μόνο για να ελέγξετε αν υπάρχει ένα ληφθέν φαξ, εάν θέλετε η κατάστασή του ως προς την προβολή να παραμείνει αμετάβλητη.

Ο χειριστής προτιμά ένα αποθηκευμένο αρχείο PDF. Διαφορετικά χρησιμοποιεί το αποθηκευμένο αρχείο TIFF και επιχειρεί μετατροπή σε PDF όταν ο μετατροπέας είναι διαθέσιμος. Εάν η μετατροπή δεν είναι διαθέσιμη ή προκαλέσει εξαίρεση που αντιμετωπίζεται από τον χειριστή, επιστρέφει το αρχείο TIFF. Ελέγχετε πάντα την τιμή Content-Type που επιστρέφεται, αντί να θεωρείτε δεδομένη τη μορφή PDF.

Λήψη εξερχόμενου φαξ

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdef

Χρησιμοποιήστε την τιμή uuid από το fax_outbox. Αυτή η λήψη συμβατότητας προτιμά ένα αποθηκευμένο δυαδικό αντικείμενο PDF, έπειτα ένα δυαδικό αντικείμενο TIFF και κατόπιν ένα διαθέσιμο αρχείο PDF, αρχείο TIFF ή αρχικό αρχείο προέλευσης. Η σειρά προτίμησής της διαφέρει από εκείνη του τρέχοντος χειριστή εξερχομένων fax_download. Για νέες ενσωματώσεις που χρησιμοποιούν το send_fax, χρησιμοποιήστε εκείνη την τρέχουσα ροή λήψης με την παράμετρο job_id.

Ένα αρχικό αρχείο προέλευσης μπορεί να επιστραφεί ως application/octet-stream αντί για PDF ή TIFF. Το όνομα του συνημμένου αρχείου μπορεί να διατηρεί την επέκταση του αρχείου προέλευσης. Η λήψη συμβατότητας για τα εξερχόμενα δεν επισημαίνει εγγραφές εισερχομένων ως προβληθείσες, δεν αλλάζει την κατάσταση της εργασίας και δεν δημιουργεί μετάδοση.

Διαχειριστείτε χωριστά τα byte και τα σφάλματα

Σε περίπτωση επιτυχίας επιστρέφονται τα ακατέργαστα byte του εγγράφου με τις κεφαλίδες Content-Type, Content-Disposition για συνημμένο και Content-Length. Δεν πρόκειται για περίβλημα JSON με δεδομένα Base64. Αποθηκεύστε τις κεφαλίδες και τα byte χωριστά όπως φαίνεται, ελέγξτε τον τύπο της απόκρισης και μόνο τότε δώστε στο αρχείο κατάλληλο όνομα ή επεξεργαστείτε το. Μια επιτρεπόμενη επέκταση αρχείου προέλευσης δεν εγγυάται έγκυρο ή μετατρεπόμενο έγγραφο.

Ο κωδικός API 400 σημαίνει ότι λείπει μια υποχρεωτική τιμή διαδρομής ή ότι το type δεν είναι έγκυρο. Ο κωδικός API 404 σημαίνει ότι η εγγραφή που ανήκει στον λογαριασμό ή το αρχείο της δεν είναι διαθέσιμα. Τα σφάλματα χρησιμοποιούν το συνηθισμένο περίβλημα JSON status/response και ενδέχεται να χρησιμοποιούν HTTP 200. Ελέγξτε την τιμή Content-Type της απόκρισης και το πεδίο status.code στο περιεχόμενο JSON, ώστε το σώμα ενός σφάλματος να μην ανοιχτεί ως έγγραφο.

Απόρρητο και διαθεσιμότητα

Το περιεχόμενο των φαξ μπορεί να περιλαμβάνει ευαίσθητες πληροφορίες. Αποθηκεύετε τα αρχεία που λαμβάνετε μόνο σε τοποθεσίες στις οποίες έχουν πρόσβαση οι προβλεπόμενοι παραλήπτες και αποφεύγετε να συμπεριλαμβάνετε όλα τα byte των εγγράφων στα αρχεία καταγραφής. Μια εγγραφή γραμματοκιβωτίου δεν εγγυάται ότι το αρχείο της θα παραμείνει διαθέσιμο. Δεν έχει καθοριστεί περίοδος διατήρησης αρχείων ούτε εγγύηση συμβατότητας για κάθε παλαιότερο αποθηκευμένο έγγραφο.