Elencare i fax ricevuti

Elencare i fax ricevuti

Usa un account MultiTEL API abilitato tramite HTTPS, con le credenziali e le restrizioni IP configurate per l'account. Questo endpoint elenca i fax ricevuti appartenenti all'account autenticato. Non invia fax né scarica il relativo documento.

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

I limiti delle date sono inclusivi e seguono l'interpretazione delle date del server API, non un fuso orario richiesto dall'utente. Le stringhe di data non valide possono essere ignorate anziché rifiutate; convalidale prima dell'invio. In assenza di filtri per data, il gestore non impone alcun intervallo di date predefinito. I risultati sono ordinati per ora di ricezione, dai più recenti. L'endpoint non fornisce un'istantanea stabile tra le pagine: i nuovi arrivi possono spostare i record da una pagina all'altra.

Leggere una pagina della casella fax

Controlla il risultato HTTP e il campo status.code nel contenuto JSON. Gli errori in altre parti dell'API possono essere restituiti in una struttura di errore JSON anche quando lo stato HTTP è 200. Una risposta riuscita contiene response.faxes e response.pagination. Questo esempio usa valori fittizi.

{
  "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 è l'identificativo numerico del record nella posta in arrivo. hash è la sua rappresentazione MD5 per il flusso preesistente dei documenti in entrata; non è l'identificativo di un'attività send_fax né una credenziale di autorizzazione. Non usarlo con l'endpoint fax_status per i fax in uscita.

received_timestamp è la marca temporale Unix memorizzata. received_at è una marca temporale formattata dal server senza indicazione dello scostamento dal fuso orario, oppure null se non è registrata alcuna ora di ricezione; usa il valore Unix per visualizzare gli orari nel tuo fuso orario. cost è un numero JSON, non un preventivo né la prova di un addebito separato completato.

status assume il valore success solo se il codice di stato memorizzato è zero; gli altri valori diventano failed. status_text contiene il messaggio di elaborazione memorizzato, con OK o Failed come valore di ripiego. emailed mantiene il valore memorizzato anziché un valore booleano. viewed è un valore booleano. Non dedurre che l'email sia stata recapitata correttamente basandoti soltanto sullo stato del fax.

Gestire gli elenchi vuoti e le variazioni dell'elenco

Una casella vuota restituisce un array faxes vuoto, total pari a 0 e total_pages pari a 0. Anche una pagina successiva all'ultima può restituire un array vuoto. Interrompi la lettura in base ai campi di paginazione, senza presumere che esista almeno una pagina. Non sono disponibili né un cursore né un ordinamento secondario per identificativo del record. Conserva gli identificativi dei record quando riconcili pagine sovrapposte.

Accesso ai documenti e riservatezza

Le voci della casella contengono metadati telefonici e documentali riservati. Limita l'accesso nella tua applicazione ed evita di registrare nei log le risposte complete. L'elenco non contrassegna i documenti come visualizzati. Usa fax_file per scaricare i documenti in entrata tramite la funzione di compatibilità, tenendo presente che contrassegna un record in entrata esistente come visualizzato anche se il relativo file non è disponibile. È possibile accedere ai documenti anche dalla posta in arrivo del portale. Non è stata stabilita alcuna garanzia di conservazione dei file.