Stuur 'n faks | MultiTEL

Voordat jy stuur

Gebruik 'n versendernommer wat jy gemagtig is om te vertoon, en stuur aan 'n ontvanger wat jou faks verwag. Hierdie versoek skep 'n werklike oordrag waarvoor koste gehef kan word. Gebruik 'n voorbereide PDF- of TIFF-dokument vir die mees voorspelbare bladsyherkenning. 'n Antwoord dat die faks in die tou geplaas is, bevestig aanvaarding, nie aflewering nie.

Gebruik 'n geaktiveerde MultiTEL API-rekening. Stuur HTTP Basic-aanmeldbesonderhede vir 'n wagwoordrekening, of 'n Bearer-token vir 'n tokenrekening. Rekeningtoestemmings en IP-beperkings geld steeds. Moenie die aanmeldbesonderhede van interne werkprosesse gebruik nie.

Laai die dokument op

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

Versoekvelde
Veld	Verpligtend	Betekenis
`from_number`	Ja	Jou gemagtigde versendernommer. Gebruik die internasionale formaat wat met + en die landkode begin.
`to_number`	Ja	Die ontvanger se faksnommer, in internasionale formaat.
`fax_file`	Ja, vir meerdelige versoeke	Die opgelaaide dokument. Laat curl die Content-Type en die skeidingsgrens vir die meerdelige versoek instel.
`webhook_url`	Nee	Opsionele HTTP- of HTTPS-terugroepadres; HTTPS word verkies. Die terugroep se datainhoud en afleweringswaarborge word steeds nagegaan: doen periodieke navrae by fax_status volgens die gedokumenteerde statuswerkvloei.

JSON word ook aanvaar met Content-Type: application/json, dieselfde nommervelde en die opsionele webhook_url, asook file_name en file_b64. file_b64 bevat die dokument se grepe in streng Base64-kodering, sonder 'n data:-voorvoegsel. 'n Geldige fax_file in 'n meerdelige versoek geniet voorrang. Dit is nie 'n API wat lêers vanaf lêeradresse ophaal nie.

Perke vir dokumente en indienings

Die toepassing aanvaar hoogstens 15,728,640 gedekodeerde dokumentgrepe (15 MiB), met pdf-, tif-, tiff-, jpg-, jpeg-, png-, doc-, docx- of txt-uitbreidings. 'n Toegelate uitbreiding waarborg nie dat die diens die bladsye kan tel of omskakel nie. Die infrastruktuur se perke vir versoeke kan laer wees, en Base64 vergroot die versoek.

Die huidige toepassing laat per rekening een taak na dieselfde bestemming toe wat in die tou is of besig is om te stuur, hoogstens vyf indienings na daardie bestemming gedurende die voorafgaande uur, en hoogstens 50 indienings in totaal gedurende die voorafgaande uur. 'n Antwoord oor 'n frekwensiebeperking gebruik API-kode 429. Wag voordat jy weer probeer; moenie die perke probeer omseil nie.

Bewaar die taak se identifiseerder

Lees sowel die HTTP-resultaat as die JSON-veld status.code. JSON-foute kan met HTTP 200 aankom. 'n Suksesvolle JSON-antwoord bevat status en response; die voorbeelde gebruik fiktiewe data.

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

Doen periodieke navrae by fax_status met response.job_id. As die antwoord op die stuurversoek verlore raak, gaan die portaal se uitkassie na voordat jy weer stuur: herhaalde versoeke kan afsonderlike oordragte skep. Hierdie hanteerder stel geen idempotensieparameter vir die kliënt beskikbaar nie.

Foute en saldokontroles

API-kodes sluit in: 400 vir ontbrekende velde, 'n ongeldige terugroepadres, 'n afgekeurde dokument of mislukte bladsyherkenning; 401 vir ontbrekende outentisering; 402 wanneer die beraamde fakskoste plus die ramings vir take in die tou of take wat besig is om te stuur, die beskikbare rekeningsaldo oorskry; 429 vir frekwensiebeperkings; en 500 vir 'n fout tydens voorbereiding vir versending. Lees status.msg vir die spesifieke rede.

Die tou teken 'n beraamde koste voor die oordrag aan. Moenie aanvaarding, die saldokontrole of hierdie raming as bevestiging beskou dat 'n heffing voltooi is nie. Besonderhede oor die finale fakturering en terugroepe moet nog geverifieer word.