Send en fax | MultiTEL

Før du sender

Brug et afsendernummer, som du har tilladelse til at vise, og send til en modtager, der forventer din fax. Denne anmodning opretter en faktisk transmission, som kan medføre betaling. Brug et klargjort dokument i PDF- eller TIFF-format for den mest forudsigelige registrering af sider. Et svar om, at faxen er sat i kø, bekræfter modtagelsen af anmodningen, ikke leveringen.

Brug en aktiveret konto til MultiTEL API. Send legitimationsoplysninger med HTTP Basic for en konto med adgangskode eller et Bearer-token for en konto med token. Kontoens tilladelser og IP-begrænsninger gælder stadig. Brug ikke legitimationsoplysninger til interne baggrundsprocesser.

Upload 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

Anmodningens felter
Felt	Påkrævet	Betydning
`from_number`	Ja	Dit godkendte afsendernummer. Brug internationalt format, der begynder med + og landekoden.
`to_number`	Ja	Modtagerens faxnummer i internationalt format.
`fax_file`	Ja ved flerdelte anmodninger	Det uploadede dokument. Lad curl angive Content-Type og afgrænseren for den flerdelte anmodning.
`webhook_url`	Nej	Valgfri URL til tilbagekald via HTTP eller HTTPS; HTTPS anbefales. Tilbagekaldenes dataindhold og leveringsgarantier er stadig under gennemgang: forespørg regelmæssigt på fax_status for at følge den dokumenterede arbejdsgang for status.

JSON accepteres også med Content-Type: application/json, de samme nummerfelter og det valgfrie webhook_url samt file_name og file_b64. file_b64 indeholder dokumentets byte kodet strengt efter Base64-formatet uden præfikset data:. Et gyldigt fax_file i en flerdelt anmodning har forrang. Dette er ikke en API til at hente filer fra URL'er.

Grænser for dokumenter og indsendelser

Applikationen accepterer højst 15,728,640 afkodede dokumentbyte (15 MiB) med filendelserne pdf, tif, tiff, jpg, jpeg, png, doc, docx eller txt. En tilladt filendelse garanterer ikke, at tjenesten kan tælle eller konvertere siderne. Infrastrukturens grænser for anmodninger kan være lavere, og Base64 øger anmodningens størrelse.

Den nuværende applikation tillader pr. konto ét job i kø eller under afsendelse til samme modtager, højst fem indsendelser til den pågældende modtager inden for den seneste time og højst 50 indsendelser i alt inden for den seneste time. Et svar om overskridelse af frekvensgrænsen bruger API-kode 429. Vent, før du prøver igen; forsøg ikke at omgå grænserne.

Gem jobbets ID

Læs både HTTP-resultatet og status.code i JSON. Fejl i JSON kan modtages med HTTP 200. Et vellykket JSON-svar indeholder status og response; eksemplerne bruger fiktive data.

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

Forespørg regelmæssigt på fax_status ved hjælp af response.job_id. Hvis svaret på afsendelsen går tabt, skal du kontrollere portalens udbakke, før du sender igen: gentagne anmodninger kan oprette særskilte transmissioner. Denne anmodningsbehandler stiller ingen parameter til rådighed for klientstyret idempotens.

Fejl og saldokontroller

API-koderne omfatter 400 ved manglende felter, ugyldig URL til tilbagekald, afvist dokument eller fejl ved registrering af sider; 401 ved manglende autentificering; 402 når den anslåede faxpris plus de anslåede omkostninger for job i kø eller under afsendelse overstiger kontoens tilgængelige saldo; 429 ved frekvensbegrænsninger; og 500 ved fejl under klargøring. Læs status.msg for den konkrete årsag.

Køen registrerer en anslået omkostning før transmissionen. Fortolk ikke modtagelsen af anmodningen, saldokontrollen eller dette estimat som bekræftelse på en gennemført opkrævning. De endelige oplysninger om fakturering og tilbagekald skal stadig verificeres.