Pošaljite faks | MultiTEL

Prije slanja

Upotrijebite broj pošiljatelja koji ste ovlašteni prikazivati i šaljite primatelju koji očekuje vaš faks. Ovaj zahtjev pokreće stvarni prijenos koji se može naplatiti. Za najpredvidljivije prepoznavanje stranica upotrijebite pripremljeni dokument u formatu PDF ili TIFF. Odgovor da je faks stavljen u red čekanja potvrđuje prihvaćanje zahtjeva, a ne isporuku.

Upotrijebite omogućen račun za MultiTEL API. Za račun s lozinkom pošaljite vjerodajnice za HTTP Basic, a za račun s tokenom pošaljite token vrste Bearer. Dozvole računa i ograničenja IP adresa i dalje vrijede. Nemojte upotrebljavati vjerodajnice internih pozadinskih procesa.

Prenesite dokument

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

Polja zahtjeva
Polje	Obavezno	Značenje
`from_number`	Da	Broj pošiljatelja koji ste ovlašteni upotrebljavati. Upotrijebite međunarodni format koji počinje znakom + i pozivnim brojem države.
`to_number`	Da	Broj faksa primatelja u međunarodnom formatu.
`fax_file`	Da za višedijelne zahtjeve	Preneseni dokument. Prepustite alatu curl postavljanje zaglavlja Content-Type i graničnika višedijelnog zahtjeva.
`webhook_url`	Ne	Neobavezan URL za povratni poziv putem protokola HTTP ili HTTPS; preporučuje se HTTPS. Sadržaj povratnih poziva i jamstva isporuke još se pregledavaju: periodično šaljite upite na fax_status kako biste slijedili dokumentirani postupak praćenja statusa.

JSON se također prihvaća uz Content-Type: application/json, ista polja za brojeve i neobavezni webhook_url, uz dodatna polja file_name i file_b64. file_b64 sadrži bajtove dokumenta kodirane strogo prema formatu Base64, bez prefiksa data:. Valjani fax_file u višedijelnom zahtjevu ima prednost. Ovo nije API za dohvaćanje datoteka s URL-ova.

Ograničenja dokumenata i slanja zahtjeva

Aplikacija prihvaća najviše 15,728,640 dekodiranih bajtova dokumenta (15 MiB), s nastavcima pdf, tif, tiff, jpg, jpeg, png, doc, docx ili txt. Dopušteni nastavak ne jamči da usluga može prebrojiti ili pretvoriti stranice. Infrastrukturna ograničenja zahtjeva mogu biti niža, a Base64 povećava veličinu zahtjeva.

Trenutačna aplikacija po računu dopušta jedan zadatak u redu čekanja ili u tijeku slanja prema istom odredištu, najviše pet zahtjeva prema tom odredištu u prethodnom satu i najviše 50 zahtjeva ukupno u prethodnom satu. Odgovor zbog ograničenja učestalosti upotrebljava kod API-ja 429. Pričekajte prije ponovnog pokušaja; nemojte pokušavati zaobići ograničenja.

Sačuvajte ID zadatka

Pročitajte i rezultat HTTP-a i polje status.code u odgovoru JSON. Pogreške u formatu JSON mogu stići uz HTTP 200. Uspješan odgovor u formatu JSON sadrži status i response; primjeri upotrebljavaju izmišljene podatke.

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

Periodično šaljite upite na fax_status koristeći response.job_id. Ako se odgovor na slanje izgubi, provjerite izlaznu poštu na portalu prije ponovnog slanja: ponovljeni zahtjevi mogu stvoriti zasebne prijenose. Ovaj obrađivač zahtjeva ne pruža parametar za klijentsku idempotentnost.

Pogreške i provjere stanja računa

Kodovi API-ja uključuju 400 za nedostajuća polja, nevaljan URL povratnog poziva, odbijeni dokument ili neuspješno prepoznavanje stranica; 401 za nedostajuću autentifikaciju; 402 kada procijenjeni trošak faksa zajedno s procjenama troškova zadataka u redu čekanja ili u tijeku slanja premašuje raspoloživo stanje računa; 429 za ograničenja učestalosti; i 500 za neuspjeh pripreme. Pročitajte status.msg za konkretan razlog.

Red čekanja bilježi procijenjeni trošak prije prijenosa. Nemojte tumačiti prihvaćanje zahtjeva, provjeru stanja računa ili tu procjenu kao potvrdu izvršene naplate. Konačne pojedinosti o naplati i povratnim pozivima još se moraju provjeriti.