Vyberte příchozí nebo odchozí dokument
Tento koncový bod pro zpětnou kompatibilitu načte faxový dokument patřící k vašemu účtu. Použijte aktivovaný účet MultiTEL API přes HTTPS s nastavenými přihlašovacími údaji a omezeními IP adres. Fax neodesílá ani znovu neodesílá.
| Parametr | Povinný | Význam |
|---|---|---|
type | Ano | Použijte inbound nebo outbound, přesně v uvedeném tvaru. |
id | Ano | Pro inbound použijte hodnotu hash vrácenou funkcí fax_inbox. Pro outbound použijte hodnotu uuid vrácenou funkcí fax_outbox. |
Tyto hodnoty patří do cesty. Cesta je /v3/fax_file/{type}/{id}, nikoli fax_download s dalšími segmenty cesty. Hash příchozího faxu není číselným ID záznamu ani ID odchozí úlohy. Identifikátor zkopírujte z výpisu příslušné poštovní schránky; nenahrazuje ověření totožnosti.
Stažení přijatého faxu
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/c20ad4d76fe97759aa27a0c99bff6710Hash v příkladu představuje smyšlený záznam přijaté pošty 12. Vlastní hodnotu získejte z fax_inbox. Stažení existujícího příchozího záznamu jej označí jako zobrazený. K tomu dojde před kontrolou dostupnosti souboru, takže i při chybě nedostupnosti souboru může viewed zůstat nastaveno na true. Pokud chcete zachovat stav zobrazení přijatého faxu beze změny, nepoužívejte tento koncový bod pouze ke zjištění, zda fax existuje.
Obslužná funkce upřednostňuje uložený soubor PDF. Jinak použije uložený soubor TIFF a pokusí se o převod do PDF, pokud je převodník k dispozici. Pokud převod není dostupný nebo vyvolá zachycenou výjimku, vrátí místo něj soubor TIFF. Vždy zkontrolujte vrácenou hlavičku Content-Type a nepředpokládejte, že jde o PDF.
Stažení odchozího faxu
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/0123456789abcdef0123456789abcdefPoužijte hodnotu uuid z fax_outbox. Toto stahování pro zpětnou kompatibilitu upřednostňuje uložený binární objekt PDF, poté binární objekt TIFF a následně dostupný soubor PDF, soubor TIFF nebo původní zdrojový soubor. Toto pořadí priorit se liší od pořadí v aktuální obslužné funkci pro odchozí faxy fax_download. U nových integrací využívajících send_fax, použijte uvedený aktuální postup stahování s jeho parametrem job_id.
Původní zdrojový soubor může být vrácen jako application/octet-stream namísto PDF nebo TIFF. Název souboru přílohy si může ponechat původní příponu. Stahování odchozího faxu pro zpětnou kompatibilitu neoznačuje záznam přijaté pošty jako zobrazený, nemění stav úlohy ani nevytváří přenos.
Zpracovávejte bajty a chyby odděleně
Při úspěchu se vrátí nezpracované bajty dokumentu s hlavičkami Content-Type, Content-Disposition určující přílohu a Content-Length. Nejde o obálku s daty v kódování Base64 ve formátu JSON. Uložte hlavičky a bajty odděleně podle příkladu, zkontrolujte typ odpovědi a teprve potom soubor vhodně pojmenujte nebo zpracujte. Povolená přípona zdrojového souboru nezaručuje, že je dokument platný nebo převedený.
Kód API 400 znamená, že chybí povinná hodnota v cestě nebo je type neplatný. Kód API 404 znamená, že záznam v rámci daného účtu nebo jeho soubor není dostupný. Chyby používají běžnou obálku JSON se strukturou status/response a mohou používat HTTP 200. Zkontrolujte hlavičku odpovědi Content-Type a hodnotu status.code ve formátu JSON, aby se tělo chybové odpovědi neotevřelo jako dokument.
Soukromí a dostupnost
Obsah faxu může zahrnovat citlivé informace. Stažené soubory ukládejte pouze tam, kde k nim mají přístup zamýšlení příjemci, a do protokolů nezahrnujte úplná bajtová data dokumentu. Záznam v poštovní schránce nezaručuje, že jeho soubor zůstane dostupný. Nebyla stanovena doba uchovávání souborů ani záruka kompatibility pro každý dříve uložený dokument.