Laai ’n faks uit die inkassie of uitkassie af

Kies ’n inkomende of uitgaande dokument

Hierdie versoenbaarheidseindpunt haal ’n faksdokument op wat aan jou rekening behoort. Gebruik ’n geaktiveerde MultiTEL API-rekening oor HTTPS met die aanmeldbesonderhede en IP-beperkings wat daarvoor opgestel is. Dit stuur nie ’n faks nie en stuur ook nie een weer nie.

Hierdie waardes hoort in die pad. Die roete is /v3/fax_file/{type}/{id}, nie fax_download met ekstra padsegmente nie. Die inkomende hash is nie die numeriese rekord-ID nie en is ook nie ’n uitgaande taak-ID nie. Kopieer die identifiseerder uit die toepaslike posbuslys; dit vervang nie outentisering nie.

Laai ’n ontvangde faks af

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

Die voorbeeldhash verteenwoordig die denkbeeldige inkassierekord 12. Kry jou eie waarde by fax_inbox. Wanneer jy ’n bestaande inkomende rekord aflaai, word dit as bekyk gemerk. Dit gebeur voordat die lêer se beskikbaarheid nagegaan word, dus kan ’n fout wat aandui dat die lêer nie beskikbaar is nie steeds viewed op true laat staan. Moenie hierdie eindpunt bloot gebruik om te toets of ’n ontvangde faks bestaan as jy wil hê dat sy bekykstatus onveranderd moet bly nie.

Die hanteerder gee voorkeur aan ’n gestoorde PDF. Anders gebruik dit die gestoorde TIFF en probeer dit na PDF omskakel wanneer die omskakelaar beskikbaar is. As omskakeling nie beskikbaar is nie of ’n uitsondering veroorsaak wat deur die program hanteer word, stuur dit eerder die TIFF terug. Gaan altyd die teruggestuurde Content-Type na eerder as om PDF te veronderstel.

Laai ’n uitgaande faks af

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

Gebruik die uuid van fax_outbox. Hierdie versoenbaarheidsaflaai gee voorkeur aan ’n gestoorde PDF-binêre objek, dan ’n TIFF-binêre objek, en dan ’n beskikbare PDF-lêer, TIFF-lêer of oorspronklike bronlêer. Die voorkeurvolgorde daarvan verskil van dié van die huidige uitgaande fax_download-hanteerder. Vir nuwe integrasies wat gebruik maak van send_fax, gebruik daardie huidige aflaaiwerkvloei met sy job_id-parameter.

’n Oorspronklike bronlêer kan as application/octet-stream teruggestuur word eerder as PDF of TIFF. Die aanhegsel se lêernaam kan die bronlêer se uitbreiding behou. Die versoenbaarheidsaflaai vir uitgaande fakse merk nie ’n inkassierekord as bekyk nie, verander nie die taakstatus nie en skep nie ’n versending nie.

Hanteer grepe en foute afsonderlik

By sukses word die rou dokumentgrepe teruggestuur met die Content-Type-kopveld, die Content-Disposition-kopveld wat ’n aanhegsel aandui en die Content-Length-kopveld. Dit is nie ’n Base64-gekodeerde JSON-omhulsel nie. Stoor die kopvelde en grepe afsonderlik soos aangedui, gaan die antwoordtipe na en gee die lêer eers daarna ’n gepaste naam of verwerk dit. ’n Toegelate bronlêeruitbreiding waarborg nie ’n geldige of omgeskakelde dokument nie.

API-kode 400 beteken dat ’n verpligte padwaarde ontbreek of dat type ongeldig is. API-kode 404 beteken dat die rekord binne die rekening se bestek of sy lêer nie beskikbaar is nie. Foute gebruik die gewone JSON-omhulsel met status/response en kan HTTP 200 gebruik. Gaan die antwoord se Content-Type en die JSON-waarde status.code na sodat ’n foutantwoord se inhoud nie as ’n dokument oopgemaak word nie.

Privaatheid en beskikbaarheid

Faksinhoud kan sensitiewe inligting bevat. Stoor afgelaaide lêers slegs waar jou beoogde ontvangers toegang daartoe het, en vermy dit om al die dokumentgrepe in logboeke op te neem. ’n Posbusrekord waarborg nie dat sy lêer beskikbaar sal bly nie. Geen lêerbewaringstydperk of versoenbaarheidswaarborg vir elke histories gestoorde dokument is vasgestel nie.