Trimiteți un fax

Înainte de trimitere

Folosiți un număr de expeditor pe care aveți dreptul să îl afișați și trimiteți către un destinatar care așteaptă faxul dumneavoastră. Această cerere creează o transmisie reală, care poate fi taxată. Folosiți un document PDF sau TIFF pregătit în prealabil pentru o detectare cât mai previzibilă a paginilor. Un răspuns care indică punerea în coadă confirmă acceptarea, nu livrarea.

Folosiți un cont activat pentru API MultiTEL. Trimiteți datele de autentificare HTTP Basic pentru un cont cu parolă sau un jeton Bearer pentru un cont cu jeton. Permisiunile contului și restricțiile IP se aplică în continuare. Nu folosiți datele de autentificare interne ale componentei de procesare.

Încărcați documentul

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

Câmpurile cererii
Câmp	Obligatoriu	Semnificație
`from_number`	Da	Numărul de expeditor pe care aveți dreptul să îl utilizați. Folosiți formatul internațional, care începe cu + și codul țării.
`to_number`	Da	Numărul de fax al destinatarului, în format internațional.
`fax_file`	Da, pentru cererile cu mai multe părți	Documentul încărcat. Lăsați curl să stabilească Content-Type și delimitatorul pentru cererea cu mai multe părți.
`webhook_url`	Nu	Adresă URL opțională pentru notificări de retur prin HTTP sau HTTPS; este de preferat HTTPS. Conținutul notificărilor de retur și garanțiile de livrare sunt încă în curs de revizuire: interogați periodic fax_status pentru a urma fluxul documentat de verificare a stării.

Se acceptă și JSON cu Content-Type: application/json, aceleași câmpuri pentru numere și câmpul opțional webhook_url, precum și file_name și file_b64. file_b64 conține octeții documentului codificați strict în Base64, fără prefixul data:. Un câmp fax_file valid dintr-o cerere cu mai multe părți are prioritate. Aceasta nu este o interfață API pentru preluarea fișierelor de la adrese URL.

Limite pentru documente și cereri de trimitere

Aplicația acceptă cel mult 15,728,640 de octeți de document decodificați (15 MiB), cu extensiile pdf, tif, tiff, jpg, jpeg, png, doc, docx sau txt. O extensie permisă nu garantează că serviciul poate număra sau converti paginile. Limitele infrastructurii pentru cereri pot fi mai mici, iar Base64 mărește dimensiunea cererii.

Pentru fiecare cont, aplicația actuală permite o singură operațiune în coadă sau în curs de trimitere către aceeași destinație, cel mult cinci cereri de trimitere către acea destinație în ultima oră și cel mult 50 de cereri de trimitere în total în ultima oră. Un răspuns de limitare a frecvenței folosește codul API 429. Așteptați înainte de a reîncerca; nu încercați să ocoliți limitele.

Păstrați identificatorul operațiunii

Citiți atât rezultatul HTTP, cât și câmpul status.code din JSON. Erorile JSON pot fi primite cu HTTP 200. Un răspuns JSON reușit conține status și response; exemplele folosesc date fictive.

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

Interogați periodic fax_status folosind response.job_id. Dacă răspunsul la trimitere se pierde, verificați mesajele de ieșire din portal înainte de a trimite din nou: cererile repetate pot crea transmisii separate. Acest gestionar de cereri nu pune la dispoziția clientului niciun parametru de idempotență.

Erori și verificări ale soldului

Codurile API includ 400 pentru câmpuri lipsă, o adresă URL nevalidă pentru notificări de retur, un document respins sau eșecul detectării paginilor; 401 pentru lipsa autentificării; 402 când costul estimat al faxului, adunat cu estimările pentru operațiunile în coadă sau în curs de trimitere, depășește soldul disponibil al contului; 429 pentru limitele de frecvență; și 500 pentru un eșec la pregătirea transmisiei. Citiți status.msg pentru motivul exact.

Coada înregistrează un cost estimat înainte de transmisie. Nu interpretați acceptarea, verificarea soldului sau această estimare drept confirmarea unei taxări efectuate. Detaliile finale privind facturarea și notificările de retur trebuie încă verificate.