API pentru PBX găzduit: istoricul faxurilor și trimiterea acestora

Folosiți HTTPS și autentificarea HTTP Basic cu credențiale API aprobate. Păstrați credențialele pe serverul aplicației dvs. Aceste endpoint-uri Hosted PBX folosesc /hpbx/ pe api.multitel.net; nu inserați /v3. Verificați atât rezultatul HTTP, cât și starea aplicației din răspunsul JSON.

Citirea înregistrărilor de fax

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"

Înlocuiți codul de facturare cu cel al PBX-ului dumneavoastră. Înregistrările returnate includ ora faxului, direcția, sursa, destinația, starea livrării, încercările, erorile și numărul de pagini. Livrarea poate fi încă în așteptare atunci când o cerere de trimitere este acceptată.

Parametri de trimitere

Punctul final de trimitere este POST /hpbx/fax/send/{billing_code}. Trimiterea execută o operațiune reală. Pregătiți fișierul și destinația autorizată de cont înainte de trimitere; nu reîncercați orbește o trimitere incertă.

CâmpSemnificație
numberNumărul de fax de destinație.
cidnumIdentificatorul apelantului autorizat pentru trimitere.
scheduleOra de trimitere programată, atunci când este utilizată.
faxquality / pagesize / pagerotateOpțiuni acceptate pentru calitate, dimensiunea hârtiei și rotație.
statusemailAdresă autorizată pentru notificările de livrare.
deleteaftersendIndică dacă fișierul încărcat și stocat trebuie eliminat după trimitere.
filenameReferința de document așteptată de acest flux de lucru pentru fax; nu este o cale arbitrară către un fișier local.

Urmărirea finalizării

După trimitere, verificați starea înregistrării faxului, încercările și eroarea. Confirmați livrarea; acceptarea cererii nu înseamnă livrare. Ghidul de referință pentru fax din portal documentează fluxul actual de încărcare și trimitere; căile și autentificarea acestuia sunt separate de punctul de acces API de mai sus.

Căutați documentație