Valitse saapuva tai lähtevä asiakirja
Tämä yhteensopivuutta varten tarkoitettu päätepiste noutaa tiliisi kuuluvan faksiasiakirjan. Käytä käyttöön otettua MultiTEL API -tiliä HTTPS-yhteyden kautta tilille määritetyillä tunnistetiedoilla ja IP-rajoituksilla. Päätepiste ei lähetä faksia eikä lähetä sitä uudelleen.
| Parametri | Pakollinen | Merkitys |
|---|---|---|
type | Kyllä | Käytä arvoa inbound tai outbound täsmälleen tässä esitetyssä muodossa. |
id | Kyllä | Kun arvona on inbound, käytä fax_inbox-toiminnon palauttamaa hash-arvoa. Kun arvona on outbound, käytä fax_outbox-toiminnon palauttamaa uuid-arvoa. |
Nämä arvot kuuluvat polkuun. Reitti on /v3/fax_file/{type}/{id}, ei fax_download ylimääräisillä polkuosilla. Saapuvan faksin tiiviste ei ole tietueen numeerinen tunniste eikä lähtevän työn tunniste. Kopioi tunniste oikean postilaatikon luettelosta; se ei korvaa todennusta.
Lataa vastaanotettu faksi
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/c20ad4d76fe97759aa27a0c99bff6710Esimerkin tiiviste vastaa kuvitteellista saapuneiden kansion tietuetta 12. Nouda oma arvosi toiminnolla fax_inbox. Olemassa olevan saapuvan tietueen lataaminen merkitsee sen katsotuksi. Tämä tapahtuu ennen tiedoston saatavuuden tarkistamista, joten tiedoston puuttumisesta ilmoittava virhekin voi jättää kentän viewed arvoksi true. Älä käytä tätä päätepistettä pelkästään vastaanotetun faksin olemassaolon tarkistamiseen, jos haluat sen katselutilan säilyvän ennallaan.
Käsittelijä valitsee ensisijaisesti tallennetun PDF-tiedoston. Muussa tapauksessa se käyttää tallennettua TIFF-tiedostoa ja yrittää muuntaa sen PDF-muotoon, jos muunnin on käytettävissä. Jos muunnos ei ole käytettävissä tai aiheuttaa käsitellyn poikkeuksen, se palauttaa sen sijaan TIFF-tiedoston. Tarkista aina palautettu Content-Type-otsake sen sijaan, että olettaisit tiedoston olevan PDF-muodossa.
Lataa lähtevä faksi
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/0123456789abcdef0123456789abcdefKäytä uuid-arvoa, jonka palauttaa fax_outbox. Tämä yhteensopivuutta varten tarkoitettu lataus valitsee ensisijaisesti tallennetun PDF-binääriobjektin, sitten TIFF-binääriobjektin ja sen jälkeen saatavilla olevan PDF-tiedoston, TIFF-tiedoston tai alkuperäisen lähdetiedoston. Sen valintajärjestys eroaa nykyisestä lähtevien faksien fax_download-käsittelijästä. Uusissa integraatioissa, joissa käytetään toimintoa send_fax, käytä kyseistä nykyistä lataustyönkulkua ja sen job_id-parametria.
Alkuperäinen lähdetiedosto voidaan palauttaa muodossa application/octet-stream eikä muodossa PDF tai TIFF. Liitteen tiedostonimessä voi säilyä lähdetiedoston tiedostopääte. Yhteensopivuutta varten tarkoitettu lähtevän faksin lataus ei merkitse saapuneiden kansion tietuetta katsotuksi, muuta työn tilaa eikä luo lähetystä.
Käsittele tavut ja virheet erikseen
Onnistunut kutsu palauttaa asiakirjan raakatavut sekä otsakkeet Content-Type, Content-Disposition arvolla attachment ja Content-Length. Vastaus ei ole Base64-koodatun sisällön JSON-kääre. Tallenna otsakkeet ja tavut erikseen esimerkin mukaisesti, tarkista vastauksen tyyppi ja anna vasta sitten tiedostolle sopiva nimi tai käsittele sitä. Lähdetiedoston sallittu tiedostopääte ei takaa, että asiakirja on kelvollinen tai muunnettu.
API-koodi 400 tarkoittaa, että pakollinen polkuarvo puuttuu tai type on virheellinen. API-koodi 404 tarkoittaa, että tiliin kuuluva tietue tai sen tiedosto ei ole saatavilla. Virheet käyttävät tavallista JSON-muotoista status/response-käärettä, ja ne voidaan palauttaa tilakoodilla HTTP 200. Tarkista vastauksen Content-Type sekä JSON-sisällön status.code, jotta virhevastauksen runkoa ei avata asiakirjana.
Tietosuoja ja saatavuus
Faksin sisältö voi sisältää arkaluonteisia tietoja. Tallenna ladatut tiedostot vain paikkaan, jossa tarkoitetut vastaanottajat pääsevät niihin käsiksi, ja vältä asiakirjan kaikkien tavujen sisällyttämistä lokeihin. Postilaatikon tietue ei takaa, että sen tiedosto pysyy saatavilla. Tiedostoille ei ole määritetty säilytysaikaa eikä kaikille aiemmin tallennetuille asiakirjoille ole vahvistettu yhteensopivuustakuuta.