Bejövő vagy kimenő fax letöltése

Válasszon bejövő vagy kimenő dokumentumot

Ez a kompatibilitási végpont az Ön fiókjához tartozó faxdokumentumot kér le. Használjon engedélyezett MultiTEL API-fiókot HTTPS kapcsolaton keresztül, a fiókhoz beállított hitelesítő adatokkal és IP-korlátozásokkal. A végpont nem küld és nem küld újra faxot.

Ezeket az értékeket az útvonalban kell megadni. Az útvonal: /v3/fax_file/{type}/{id}, nem pedig a fax_download további útvonalszegmensekkel kiegészítve. A bejövő fax kivonatértéke nem a rekord numerikus azonosítója, és nem is egy kimenő feladat azonosítója. Másolja ki az azonosítót a megfelelő postafiók listájából; ez nem helyettesíti a hitelesítést.

Fogadott fax letöltése

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

A példában szereplő kivonatérték a bejövő postafiók kitalált, 12 számú rekordját jelöli. Saját értékét innen kérje le: fax_inbox. Egy meglévő bejövő rekord letöltése megtekintettként jelöli meg a rekordot. Ez a fájl elérhetőségének ellenőrzése előtt történik, ezért a viewed értéke akkor is true maradhat, ha a fájl elérhetetlenségét jelző hiba lép fel. Ha változatlanul szeretné hagyni egy fogadott fax megtekintési állapotát, ne használja ezt a végpontot pusztán annak ellenőrzésére, hogy a fax létezik-e.

A kezelő előnyben részesíti a tárolt PDF-fájlt. Ennek hiányában a tárolt TIFF-fájlt használja, és ha az átalakító elérhető, megpróbálja PDF formátumra alakítani. Ha az átalakítás nem érhető el, vagy kezelt kivételt vált ki, helyette a TIFF-fájlt adja vissza. Mindig ellenőrizze a visszaadott Content-Type fejlécet, ne feltételezze, hogy a formátum PDF.

Kimenő fax letöltése

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

Használja a uuid értéket ebből a forrásból: fax_outbox. Ez a kompatibilitási letöltés elsőként a tárolt PDF bináris adatobjektumot, utána a TIFF bináris adatobjektumot, majd az elérhető PDF-fájlt, TIFF-fájlt vagy eredeti forrásfájlt részesíti előnyben. Ez a sorrend eltér a jelenlegi kimenő letöltéseket végző fax_download kezelő sorrendjétől. Azoknál az új integrációknál, amelyek ezt használják: send_fax, a jelenlegi letöltési munkafolyamatot használja annak job_id paraméterével.

Az eredeti forrásfájl application/octet-stream típussal is visszaadható PDF vagy TIFF helyett. A melléklet fájlneve megtarthatja a forrás kiterjesztését. A kompatibilitási kimenő letöltés nem jelöl meg bejövő postafiókbeli rekordot megtekintettként, nem módosítja a feladat állapotát, és nem hoz létre átvitelt.

A bájtokat és a hibákat külön kezelje

Siker esetén a válasz a dokumentum nyers bájtjait tartalmazza, Content-Type, mellékletet jelző Content-Disposition és Content-Length fejlécekkel. Nem Base64 kódolású JSON-burkolatot ad vissza. A bemutatott módon külön mentse a fejléceket és a bájtokat, ellenőrizze a válasz típusát, és csak ezután adjon megfelelő nevet a fájlnak, vagy dolgozza fel. Az engedélyezett forráskiterjesztés nem garantálja, hogy a dokumentum érvényes vagy átalakított.

A 400 API-kód azt jelenti, hogy hiányzik egy kötelező útvonalérték, vagy a type érvénytelen. A 404 API-kód azt jelenti, hogy a fiókhoz tartozó rekord vagy annak fájlja nem érhető el. A hibák a szokásos JSON status/response burkolatot használják, és HTTP 200 állapotkóddal is érkezhetnek. Ellenőrizze a válasz Content-Type fejlécét és a JSON status.code értékét, nehogy a hibaüzenet törzsét dokumentumként nyissa meg.

Adatvédelem és elérhetőség

A faxok tartalma érzékeny információkat is tartalmazhat. A letöltött fájlokat csak olyan helyen tárolja, ahol a kívánt címzettek férhetnek hozzájuk, és kerülje a dokumentum teljes bájttartalmának naplózását. A postafiókbeli rekord megléte nem garantálja, hogy a hozzá tartozó fájl továbbra is elérhető marad. Nincs meghatározott fájlmegőrzési idő, és nincs minden korábban tárolt dokumentumra kiterjedő kompatibilitási garancia.