Send en faks | MultiTEL

Før du sender

Bruk et avsendernummer du har tillatelse til å vise, og send til en mottaker som forventer faksen din. Denne forespørselen oppretter en faktisk overføring som kan medføre kostnader. Bruk et klargjort dokument i PDF- eller TIFF-format for mest mulig forutsigbar sidegjenkjenning. Et svar om at faksen er lagt i kø, bekrefter at den er mottatt for behandling, ikke at den er levert.

Bruk en aktivert konto for MultiTEL API. Send påloggingsopplysninger for HTTP Basic hvis kontoen bruker passord, eller et Bearer-token hvis kontoen bruker token. Kontotillatelser og IP-begrensninger gjelder fortsatt. Ikke bruk interne påloggingsopplysninger for bakgrunnsprosesser.

Last opp dokumentet

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

Felter i forespørselen
Felt	Påkrevd	Betydning
`from_number`	Ja	Avsendernummeret du har tillatelse til å bruke. Bruk internasjonalt format som begynner med + og landskode.
`to_number`	Ja	Mottakerens faksnummer i internasjonalt format.
`fax_file`	Ja for flerdelte forespørsler	Dokumentet som lastes opp. La curl angi Content-Type og grenseskillet mellom delene i den flerdelte forespørselen.
`webhook_url`	Nei	Valgfri URL for tilbakekall via HTTP eller HTTPS; HTTPS anbefales. Innholdet i tilbakekall og garantier for levering er fortsatt under vurdering: spør fax_status regelmessig i henhold til den dokumenterte fremgangsmåten for statusoppfølging.

JSON godtas også med Content-Type: application/json, de samme feltene for telefonnumre og det valgfrie feltet webhook_url, samt file_name og file_b64. file_b64 inneholder dokumentets byte kodet strengt i henhold til Base64, uten prefikset data:. Et gyldig fax_file-felt i en flerdelt forespørsel har forrang. Dette er ikke et API for å hente filer fra URL-er.

Grenser for dokumenter og innsendinger

Applikasjonen godtar maksimalt 15,728,640 byte med dekodede dokumentdata (15 MiB), med filtypene pdf, tif, tiff, jpg, jpeg, png, doc, docx eller txt. En tillatt filtype garanterer ikke at tjenesten kan telle eller konvertere sidene. Infrastrukturens grenser for forespørselsstørrelse kan være lavere, og Base64 øker størrelsen på forespørselen.

For hver konto tillater den nåværende applikasjonen én jobb i kø eller under sending til samme mottakernummer, maksimalt fem innsendinger til dette nummeret i løpet av den siste timen og maksimalt 50 innsendinger totalt i løpet av den siste timen. Et svar om overskredet frekvensgrense bruker API-kode 429. Vent før du prøver igjen; ikke forsøk å omgå grensene.

Ta vare på jobb-ID-en

Les både HTTP-resultatet og status.code i JSON-svaret. Feil i JSON kan komme med HTTP 200. Et vellykket JSON-svar inneholder status og response; eksemplene bruker fiktive data.

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

Spør regelmessig fax_status ved hjelp av response.job_id. Hvis svaret på sendingen går tapt, kontroller utboksen i portalen før du sender på nytt: gjentatte forespørsler kan opprette separate overføringer. Denne forespørselsbehandleren tilbyr ingen klientparameter for idempotens.

Feil og saldokontroller

API-kodene omfatter 400 ved manglende felter, ugyldig URL for tilbakekall, avvist dokument eller feil ved sidegjenkjenning; 401 ved manglende autentisering; 402 når den estimerte fakskostnaden sammen med estimatene for jobber i kø og under sending overstiger tilgjengelig kontosaldo; 429 ved overskredne frekvensgrenser; og 500 ved feil under klargjøring til sending. Les status.msg for den konkrete årsaken.

Køen registrerer en estimert kostnad før overføringen. Ikke tolk mottak for behandling, saldokontrollen eller dette estimatet som bekreftelse på at en belastning er gjennomført. Endelig fakturering og detaljer om tilbakekall må fortsatt verifiseres.