Skicka ett fax | MultiTEL

Innan du skickar

Använd ett avsändarnummer som du har rätt att visa och en mottagare som väntar på ditt fax. Den här begäran skapar en verklig överföring som kan medföra en kostnad. Använd ett färdigställt dokument i formatet PDF eller TIFF för att ge så förutsägbar sididentifiering som möjligt. Ett svar om att faxet har köats bekräftar att det har tagits emot för behandling, inte att det har levererats.

Använd ett aktiverat API-konto hos MultiTEL. Skicka inloggningsuppgifter med HTTP Basic för ett lösenordskonto, eller en Bearer-token för ett tokenkonto. Kontots behörigheter och IP-begränsningar gäller fortfarande. Använd inte interna inloggningsuppgifter för bakgrundsprocesser.

Ladda upp 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

Fält i begäran
Fält	Obligatoriskt	Betydelse
`from_number`	Ja	Ditt avsändarnummer som du har rätt att använda. Använd internationellt format som börjar med + och landskod.
`to_number`	Ja	Mottagarens faxnummer i internationellt format.
`fax_file`	Ja, för flerdelade begäranden	Det uppladdade dokumentet. Låt curl ange Content-Type och delgränsen för den flerdelade begäran.
`webhook_url`	Nej	Valfri återanropsadress med HTTP eller HTTPS; HTTPS rekommenderas. Återanropens datainnehåll och leveransgarantier granskas fortfarande: gör upprepade anrop till fax_status för att följa det dokumenterade statusflödet.

JSON accepteras också med Content-Type: application/json, samma nummerfält och det valfria fältet webhook_url, samt file_name och file_b64. file_b64 innehåller dokumentets byte strikt kodade med Base64, utan prefixet data:. Ett giltigt fax_file i en flerdelad begäran har företräde. Detta är inte ett API för att hämta filer från webbadresser.

Gränser för dokument och inskickade begäranden

Programmet accepterar högst 15,728,640 avkodade dokumentbyte (15 MiB), med filändelserna pdf, tif, tiff, jpg, jpeg, png, doc, docx eller txt. En tillåten filändelse garanterar inte att tjänsten kan räkna eller konvertera sidorna. Infrastrukturens storleksgränser för begäranden kan vara lägre, och Base64 ökar begärans storlek.

För varje konto tillåter det nuvarande programmet ett köat eller pågående sändningsjobb till samma mottagarnummer, högst fem inskickade begäranden till det numret under den senaste timmen och högst 50 inskickade begäranden totalt under den senaste timmen. Ett svar om anropsbegränsning använder API-koden 429. Vänta innan du försöker igen; försök inte kringgå gränserna.

Spara jobbets ID

Läs både HTTP-resultatet och status.code i JSON-svaret. Fel i JSON-svaret kan förekomma tillsammans med HTTP 200. Ett lyckat JSON-svar innehåller status och response; exemplen använder fiktiva uppgifter.

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

Gör upprepade anrop till fax_status med response.job_id. Om svaret på sändningsbegäran går förlorat ska du kontrollera portalens utkorg innan du skickar igen: upprepade begäranden kan skapa separata överföringar. Den här hanteraren tillhandahåller ingen idempotensparameter för klienten.

Fel och saldokontroller

API-koderna omfattar 400 för saknade fält, ogiltig återanropsadress, avvisat dokument eller misslyckad sididentifiering; 401 för saknad autentisering; 402 när den uppskattade faxkostnaden tillsammans med kostnadsuppskattningarna för köade och pågående sändningar överstiger kontots tillgängliga saldo; 429 för anropsbegränsningar; och 500 för fel vid förberedelse av överföringen. Läs status.msg för den specifika orsaken.

Kön registrerar en uppskattad kostnad före överföringen. Tolka inte mottagandet för behandling, saldokontrollen eller denna uppskattning som en bekräftelse på att en debitering har genomförts. Uppgifterna om slutlig fakturering och återanrop behöver fortfarande verifieras.