Dërgoni një faks

Përpara dërgimit

Përdorni një numër dërguesi që jeni të autorizuar ta shfaqni dhe dërgojani faksin një marrësi që e pret atë. Kjo kërkesë krijon një transmetim real, i cili mund të faturohet. Përdorni një dokument PDF ose TIFF të përgatitur paraprakisht që zbulimi i faqeve të jetë sa më i parashikueshëm. Një përgjigje që tregon vendosjen në radhë konfirmon pranimin, jo dorëzimin.

Përdorni një llogari të aktivizuar për API të MultiTEL. Dërgoni kredencialet HTTP Basic për një llogari me fjalëkalim ose një token Bearer për një llogari me token. Lejet e llogarisë dhe kufizimet e IP-së vazhdojnë të zbatohen. Mos përdorni kredencialet e brendshme të komponentit të përpunimit.

Ngarkoni dokumentin

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --form-string from_number=+12125550123 \
  --form-string to_number=+12125550124 \
  --form fax_file=@./document.pdf \
  https://api.multitel.net/v3/send_fax

Fushat e kërkesës
Fusha	E detyrueshme	Kuptimi
`from_number`	Po	Numri i dërguesit që jeni të autorizuar të përdorni. Përdorni formatin ndërkombëtar që fillon me + dhe kodin e shtetit.
`to_number`	Po	Numri i faksit të marrësit, në format ndërkombëtar.
`fax_file`	Po, për kërkesat me shumë pjesë	Dokumenti i ngarkuar. Lëreni curl të caktojë Content-Type dhe ndarësin për kërkesën me shumë pjesë.
`webhook_url`	Jo	Adresë URL opsionale për njoftimet e kthimit përmes HTTP ose HTTPS; parapëlqehet HTTPS. Përmbajtja e njoftimeve të kthimit dhe garancitë e dorëzimit janë ende në shqyrtim: kërkoni periodikisht te fax_status për të ndjekur rrjedhën e dokumentuar të kontrollit të gjendjes.

Pranohet edhe JSON me Content-Type: application/json, të njëjtat fusha të numrave dhe fushën opsionale webhook_url, si dhe file_name dhe file_b64. file_b64 përmban bajtet e dokumentit të koduara në përputhje të rreptë me Base64, pa parashtesën data:. Një fushë e vlefshme fax_file në një kërkesë me shumë pjesë ka përparësi. Kjo nuk është një ndërfaqe API për marrjen e skedarëve nga adresa URL.

Kufijtë e dokumenteve dhe të kërkesave për dërgim

Aplikacioni pranon jo më shumë se 15,728,640 bajte të dekoduara të dokumentit (15 MiB), me prapashtesat pdf, tif, tiff, jpg, jpeg, png, doc, docx ose txt. Një prapashtesë e lejuar nuk garanton që shërbimi mund t'i numërojë ose t'i konvertojë faqet. Kufijtë e infrastrukturës për kërkesat mund të jenë më të ulët dhe Base64 e rrit madhësinë e kërkesës.

Për çdo llogari, aplikacioni aktual lejon një detyrë në radhë ose në dërgim drejt të njëjtit destinacion, jo më shumë se pesë kërkesa dërgimi drejt atij destinacioni gjatë orës së fundit dhe jo më shumë se 50 kërkesa dërgimi gjithsej gjatë orës së fundit. Një përgjigje për kufizimin e shpeshtësisë përdor kodin API 429. Prisni përpara se të provoni përsëri; mos u përpiqni t'i anashkaloni kufijtë.

Ruani identifikuesin e detyrës

Lexoni si rezultatin HTTP, ashtu edhe fushën status.code në JSON. Gabimet JSON mund të mbërrijnë me HTTP 200. Një përgjigje e suksesshme JSON përmban status dhe response; shembujt përdorin të dhëna të trilluara.

{
  "status": {
    "code": 200,
    "msg": "Fax queued"
  },
  "response": {
    "job_id": "0123456789abcdef0123456789abcdef"
  }
}

Kërkoni periodikisht te fax_status duke përdorur response.job_id. Nëse përgjigjja e dërgimit humbet, kontrolloni dosjen e dërgesave dalëse në portal përpara se të dërgoni përsëri: kërkesat e përsëritura mund të krijojnë transmetime të veçanta. Ky trajtues kërkesash nuk vë në dispozicion të klientit asnjë parametër idempotence.

Gabimet dhe kontrollet e gjendjes së llogarisë

Kodet API përfshijnë 400 për fusha që mungojnë, adresë URL të pavlefshme për njoftimet e kthimit, dokument të refuzuar ose dështim të zbulimit të faqeve; 401 kur mungon autentikimi; 402 kur kostoja e përllogaritur e faksit, së bashku me përllogaritjet për detyrat në radhë ose në dërgim, tejkalon shumën e disponueshme në llogari; 429 për kufijtë e shpeshtësisë; dhe 500 për një dështim gjatë përgatitjes së transmetimit. Lexoni status.msg për arsyen konkrete.

Radha regjistron një kosto të përllogaritur përpara transmetimit. Mos e interpretoni pranimin, kontrollin e gjendjes së llogarisë ose këtë përllogaritje si konfirmim të një tarifimi të kryer. Detajet përfundimtare të faturimit dhe të njoftimeve të kthimit mbeten për t'u verifikuar.