Lejupielādējiet faksu no iesūtnes vai izsūtnes

Izvēlieties ienākošo vai izejošo dokumentu

Šis saderībai paredzētais galapunkts izgūst jūsu kontam piederošu faksa dokumentu. Izmantojiet iespējotu MultiTEL API kontu, izveidojot savienojumu ar HTTPS un ievērojot kontam konfigurētos akreditācijas datus un IP ierobežojumus. Tas nesūta un atkārtoti nenosūta faksu.

Šīs vērtības jānorāda ceļā. Maršruts ir /v3/fax_file/{type}/{id}, nevis fax_download ar papildu ceļa segmentiem. Ienākošā faksa jaucējvērtība nav ieraksta skaitliskais identifikators un nav izejošā uzdevuma identifikators. Nokopējiet identifikatoru no atbilstošā pastkastes saraksta; tas neaizstāj autentifikāciju.

Lejupielādējiet saņemtu faksu

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

Piemērā norādītā jaucējvērtība atbilst izdomātam iesūtnes ierakstam 12. Savam ierakstam atbilstošo vērtību iegūstiet no fax_inbox. Lejupielādējot esošu ienākošo ierakstu, tas tiek atzīmēts kā skatīts. Tas notiek pirms faila pieejamības pārbaudes, tādēļ pat kļūdas gadījumā, kad fails nav pieejams, lauka viewed vērtība var palikt true. Neizmantojiet šo galapunktu tikai tam, lai pārbaudītu, vai saņemts fakss pastāv, ja vēlaties saglabāt tā skatīšanas stāvokli nemainītu.

Apstrādātājs dod priekšroku saglabātam PDF failam. Pretējā gadījumā tas izmanto saglabāto TIFF failu un mēģina to pārveidot PDF formātā, ja pārveidotājs ir pieejams. Ja pārveidošana nav pieejama vai izraisa apstrādātu izņēmumu, tā vietā tiek atgriezts TIFF fails. Vienmēr pārbaudiet atgriezto Content-Type galveni, nevis pieņemiet, ka formāts ir PDF.

Lejupielādējiet izejošo faksu

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

Izmantojiet uuid, ko atgriež fax_outbox. Šī saderībai paredzētā lejupielāde vispirms izvēlas saglabātu PDF bināro datu objektu, pēc tam TIFF bināro datu objektu, tad pieejamu PDF failu, TIFF failu vai sākotnējo avota failu. Tās izvēles prioritāšu secība atšķiras no pašreizējā izejošo faksu fax_download apstrādātāja secības. Jaunām integrācijām, kurās izmanto send_fax, izmantojiet šo pašreizējo lejupielādes darbplūsmu ar tās parametru job_id.

Sākotnējais avota fails var tikt atgriezts kā application/octet-stream, nevis PDF vai TIFF. Pielikuma faila nosaukumā var saglabāties avota faila paplašinājums. Saderībai paredzētā izejošā faksa lejupielāde neatzīmē iesūtnes ierakstu kā skatītu, nemaina uzdevuma statusu un neizveido pārraidi.

Apstrādājiet baitus un kļūdas atsevišķi

Veiksmīgas izpildes gadījumā tiek atgriezti neapstrādāti dokumenta baiti ar galvenēm Content-Type, Content-Disposition pielikumam un Content-Length. Tā nav Base64 kodējumu saturoša JSON aploksne. Saglabājiet galvenes un baitus atsevišķi, kā parādīts, pārbaudiet atbildes tipu un tikai tad piešķiriet failam atbilstošu nosaukumu vai apstrādājiet to. Atļauts avota faila paplašinājums negarantē derīgu vai pārveidotu dokumentu.

API kods 400 nozīmē, ka trūkst obligātas ceļa vērtības vai type vērtība nav derīga. API kods 404 nozīmē, ka konta tvērumā esošais ieraksts vai tā fails nav pieejams. Kļūdām tiek izmantota parastā JSON status/response aploksne, un tās var tikt atgrieztas ar HTTP 200. Pārbaudiet atbildes Content-Type galveni un JSON lauku status.code, lai kļūdas atbildes pamatdaļa netiktu atvērta kā dokuments.

Privātums un pieejamība

Faksa saturs var ietvert sensitīvu informāciju. Glabājiet lejupielādētos failus tikai vietās, kur tiem var piekļūt paredzētie saņēmēji, un neiekļaujiet žurnālos visus dokumenta baitus. Pastkastes ieraksts negarantē, ka tā fails arī turpmāk būs pieejams. Nav noteikts failu glabāšanas termiņš vai saderības garantija katram agrāk saglabātajam dokumentam.