Dezvoltatori

GET/v3/fax_inbox

Listarea faxurilor primite

Consultați căsuța de faxuri primite, cu paginare, căutare după număr și filtre după data primirii.

Pe această pagină
  1. Listarea faxurilor primite
  2. Consultarea unei pagini din căsuța de faxuri
  3. Gestionarea listelor goale și a celor care se modifică
  4. Accesul la documente și confidențialitatea

Listarea faxurilor primite

Utilizați un cont API MultiTEL activat, prin HTTPS, cu datele de autentificare și restricțiile IP configurate pentru acesta. Acest punct de acces listează faxurile primite care aparțin contului autentificat. Nu trimite un fax și nu descarcă documentul acestuia.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox
Parametrii de interogare a căsuței de faxuri primite
ParametruObligatoriuSemnificație
pageNuNumărul paginii, începând de la 1. Valoare implicită: 1.
limitNuÎnregistrări pe pagină. Valoare implicită: 25; valoare maximă: 100. Utilizați un număr întreg pozitiv.
searchNuCaută în numărul expeditorului, numărul de fax al destinatarului și identificatorul stației la distanță. Spațiile de la început și de la sfârșit sunt eliminate. Diferențierea literelor mari de cele mici depinde de regulile de comparare ale bazei de date.
date_fromNuInclude faxurile începând cu începutul acestei zile, conform orei locale a serverului. Utilizați YYYY-MM-DD.
date_toNuInclude faxurile până la sfârșitul acestei zile, conform orei locale a serverului. Utilizați YYYY-MM-DD.

Limitele de dată sunt incluse și folosesc interpretarea datelor de către serverul API, nu un fus orar solicitat de utilizator. Șirurile de dată nevalide pot fi ignorate în loc să fie respinse; validați-le înainte de trimitere. În absența filtrelor de dată, componenta care procesează cererea nu impune un interval de date implicit. Rezultatele sunt ordonate după momentul primirii, cele mai recente fiind primele. Punctul de acces nu oferă o imagine stabilă a datelor între pagini: faxurile nou primite pot deplasa înregistrările de pe o pagină pe alta.

Consultarea unei pagini din căsuța de faxuri

Verificați rezultatul HTTP și câmpul status.code din JSON. Erorile din alte părți ale API pot fi returnate într-o structură de eroare JSON chiar și atunci când codul de stare HTTP este 200. Un răspuns reușit conține response.faxes și response.pagination. Acest exemplu folosește valori fictive.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id este identificatorul numeric al înregistrării din căsuța de faxuri primite. hash este reprezentarea sa MD5 pentru fluxul vechi de gestionare a documentelor primite; nu este un identificator de sarcină send_fax și nici o credențială de autorizare. Nu o utilizați cu punctul de acces fax_status pentru faxurile de ieșire.

received_timestamp este marca temporală Unix stocată. received_at este o marcă temporală formatată de server, fără un decalaj de fus orar, sau null dacă nu este înregistrat momentul primirii; utilizați valoarea Unix când afișați orele în propriul fus orar. cost este un număr JSON, nu o ofertă de preț și nici dovada unei debitări separate finalizate.

status are valoarea success numai dacă codul de stare stocat este zero; celelalte valori devin failed. status_text conține mesajul de procesare stocat, folosind OK sau Failed ca valoare de rezervă. emailed păstrează valoarea stocată, în locul unei valori booleene. viewed este o valoare booleană. Nu deduceți că livrarea prin e-mail a reușit doar pe baza stării faxului.

Gestionarea listelor goale și a celor care se modifică

O căsuță de faxuri goală returnează un tablou faxes gol, total 0 și total_pages 0. O pagină de după ultima pagină poate returna, de asemenea, un tablou gol. Opriți parcurgerea conform câmpurilor de paginare, fără a presupune că există cel puțin o pagină. Nu este pus la dispoziție niciun cursor și nicio sortare secundară după identificatorul înregistrării. Păstrați identificatorii înregistrărilor când reconciliați pagini cu înregistrări comune.

Accesul la documente și confidențialitatea

Înregistrările din căsuța de faxuri conțin metadate private despre numere de telefon și documente. Restricționați accesul în aplicația dumneavoastră și evitați înregistrarea răspunsurilor complete în jurnale. Listarea nu marchează un document ca vizualizat. Utilizați fax_file pentru descărcarea documentelor primite prin mecanismul de compatibilitate, ținând cont că acesta marchează o înregistrare existentă de fax primit ca vizualizată chiar dacă fișierul său nu este disponibil. Documentele pot fi accesate și din căsuța de faxuri primite din portal. Nu a fost stabilită nicio garanție privind păstrarea fișierelor.