Kūrėjams

GET/v3/fax_download?job_id={job_id}

Atsisiųskite siunčiamo fakso dokumentą

Gaukite prieinamą vienos iš savo fakso siuntimo užduočių dokumentą.

Šiame puslapyje
  1. Pateikite dokumento užklausą
  2. Apdorokite failą arba JSON formato klaidą
  3. Prieinamumas ir privatumas

Pateikite dokumento užklausą

Naudokite įgalintą MultiTEL API paskyrą. Jei paskyra naudoja slaptažodį, siųskite HTTP Basic prisijungimo duomenis, o jei paskyra naudoja prieigos raktą – Bearer prieigos raktą. Paskyros teisės ir IP apribojimai vis tiek taikomi. Nenaudokite vidinio foninio vykdymo komponento prisijungimo duomenų.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode job_id=0123456789abcdef0123456789abcdef \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_download

Naudokite tą patį privalomą 32 simbolių šešioliktainį job_id, kaip ir fax_status užklausoje. Kliento užklausą gali pateikti tik autentifikuotas užduoties savininkas. Šiame pavyzdyje atsakymo antraštės ir baitai išsaugomi atskirai, kad API klaida nebūtų palaikyta PDF dokumentu.

Apdorokite failą arba JSON formato klaidą

Sėkmės atveju grąžinami neapdoroti dokumento baitai su priedo antraštėmis Content-Type ir Content-Disposition, o ne JSON atsakymo apvalkalas. Patikrinkite šias antraštes prieš suteikdami išsaugotam failui pavadinimą, jį atidarydami ar apdorodami. Priklausomai nuo to, kuris dokumentas prieinamas, atsakymas gali būti PDF, TIFF arba pradinio įkelto formato. Eilėje esanti užduotis prieš konvertavimą gali grąžinti savo pradinį failą.

Nesėkmės atveju grąžinamas įprastas JSON atsakymo apvalkalas su status/response struktūra. API kodas 400 reiškia, kad trūksta job_id arba jo formatas netinkamas; 401 reiškia, kad nėra autentifikavimo; 404 reiškia, kad užduotis arba jos failas šiai paskyrai neprieinamas. Patikrinkite Content-Type ir status.code net tada, kai HTTP būsena yra 200.

Prieinamumas ir privatumas

Užduoties įrašas negarantuoja, kad failą bus galima atsisiųsti visada; saugojimo laikotarpis nepatvirtintas. Prireikus išsaugokite dokumentus, kuriuos turite teisę pasiekti, savo kontroliuojamoje saugykloje. Grąžintame faile gali būti privačios gavėjo informacijos. Atsisiunčiant naujas faksas nesiunčiamas.