Stream di timeline

Configurazione DEFAULT filterValues per stream di eventi di timeline

Configurando uno stream senza specificare alcun elemento in filterValues verranno riportati quelli di DEFAULT, ovvero quelli che hanno ripercussione sul cambiamento di stato del workflow o che riportano dati di interesse per il mittente, sia di carattere legale (es: legal facts) sia di business (es: numero della raccomandata).

Se oltre a questi eventi si vogliono aggiungere altri di interesse (es: SEND_COURTESY_MESSAGE per sapere se sono stati inviati messaggi di cortesia ai destinatari) è sufficiente indicare nel filtro DEFAULT e le categorie di eventi ulteriori.

Questa nuova API espone l'elemento timestamp che rappresenta l'istante in cui la piattaforma ha ricevuto l'informazione. Mentre per gli eventi che si verificano all'esterno della piattaforma (es: consegna della raccomandata) la data in cui si è verificata è indicata in un elemento all'interno dell'oggetto details (es: negli eventi della categoria SEND_ANALOG_FEEDBACK il timestamp è il momento in cui SEND ha ricevuto l'informazione dell'esito della notifica cartacea, mentre elemento notificationDate all'interno dell'oggetto detailsindica la data di consegna della raccomandata).

Nelle tabelle sottostanti sono riportati per ogni categoria di eventi la drescrione, se hanno collegato degli atti a volore legale (LegalFact) e i dettagli di maggior interesse contenuti nell'oggetto details.

NOTA: le date sono espresse nel formato standard ISO 8601, anche detta "Zulu time", che esprime la data UTC (es: 2024-02-29T11:44:17.511990926Z corrisponde alle 12:44:17s del 29/02/2024).

Eventi di timeline nella configurazione DEFAULT

In questa sezione sono indicati gli eventi di timeline inclusi nella configurazione "DEFAULT" e sono stati suddivisi per fase e tipologia del workflow.

Eventi di accettazione/rifiuto notifica

Gli eventi descritti nella tabella sottostante sono relativi al processo di accettazione della notifica.

REQUEST_REFUSED

Indica che la richiesta di notifica è stata rifiutata per un fallimento in fase di validazione

details

  • notificationCost: costo in euro-cents della notifica rifiutata per il mittente

  • refusalReasons:

    • detail: motivo del rifiuta della notifica (es: Validation failed, address is not valid. Error=Invalid Address, Cap, City and Province)

    • errorCode: codice identificati dell'errore (es: NOT_VALID_ADDRESS)

REQUEST_ACCEPTED

Indica che la richiesta di notifica è stata accettata a seguito dei controlli di validazione

legalFactsIds

Attestazione di presa in carico della notifica Con category = "SENDER_ACK" e key il riferimento per il download.

Eventi del workflow digitale

Gli eventi descritti nella tabella sottostante sono relativi al processo del workflow digitale, compreso l'eventuale invio dell'AAR tramite raccomandata semplice.

SEND_DIGITAL_DOMICILE

Indica un tentativo di invio digitale della notifica

details

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress: indirizzo digitale del destinatario

    • type: PEC

    • address: indirizzo PEC

  • digitalAddressSource: tipologia del domicilio digitale (PLATFORM, SPECIAL, GENERAL)

  • retryNumber: numero di tentativo (con primo tentativo = 0)

SEND_DIGITAL_FEEDBACK

Indica la ricezione di un esito ad un invio a domicilio digitale

legalFactsIds

Con category = "PEC_RECEIPT" e key il riferimento per il download del file in formato EML che attesta la consegna della PEC.

details

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress:

    • type: tipo di domicilio digitale (PEC/CERCQ)

    • address: indirizzo domicilio digitale

  • responseStatus: esito dell'invio digitale (es: OK)

  • notificationDate: data di consegna o mancata consegna.

  • deliveryFailureCause: Eventuali errori

  • deliveryDetailCode: Codice di consegna

Per i dettagli delle codifiche di deliveryFailureCause e deliveryDetailCode si rimanda alla pagina Decodifiche SEND_DIGITAL.

DIGITAL_SUCCESS_WORKFLOW

Indica il completamento con successo il workflow di invio digitale.

legalFactsIds

Con category = "DIGITAL_DELIVERY" e keyil riferimento per il download dell'attestazione generata alla conclusione dei tentativi di invio sui domicili digitali disponibili, nel caso si siano completati con un evento di consegna

details

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress: indirizzo digitale del destinatario

    • type: tipo di domicilio digitale (PEC/CERCQ)

    • address: indirizzo domicilio digitale

DIGITAL_FAILURE_WORKFLOW

Indica il completamento con fallimento il workflow di invio digitale:tutti i tentativi di invio ai domicili digitali sono falliti

legalFactsIds

Con category = "DIGITAL_DELIVERY" e keyil riferimento per il download dell'attestazione generata alla conclusione dei tentativi di invio sui domicili digitali disponibili, nel caso si siano completati con una mancata consegna

details

  • recIndex: indica l'indice dell'array del destinatario per il quale è fallito l'invio digitale

SEND_SIMPLE_REGISTERED_LETTER

Indica l'invio di raccomandata semplice

details

  • recIndex: posizione del destinatario nell'array recipients

  • analogCost: costo dell’invio cartaceo

  • physicalAddress: indirizzo fisico della spedizione

  • productType: "RS" (Raccomandata Semplice)

  • analogCost: costo in euro-cents (iva esclusa)

  • numberOfPages: numero di pagine

  • envelopeWeight: peso in grammi

SEND_SIMPLE_REGISTERED_LETTER_PROGRESS

Indica la ricezione di informazioni relative all'invio della raccomandata semplice

details

  • recIndex: posizione del destinatario nell'array recipients

  • registeredLetterCode : codice della lettera raccomandata

  • deliveryDetailCode: codice del dettaglio dell'evento di progress

Eventi del workflow Analogico

SEND_ANALOG_DOMICILE

Invio cartaceo dell’avviso di notifica

details

  • recIndex: posizione del destinatario nell'array recipients

  • serviceLevel : servizio richiesto REGISTERED_LETTER_890/REGISTERED_LETTER_AR

  • productType: tipologia del prodotto inviato 890/AR

  • analogCost: costo in euro-cents (iva esclusa)

  • numberOfPages: numero di pagine

  • envelopeWeight: peso in grammi

  • physicalAddress: indirizzo fisico della spedizione

SEND_ANALOG_FEEDBACK

Ricezione esito dell'invio cartaceo

details

  • physicalAddress: indirizzo fisico della spedizione

  • responseStatus: contiene l’esito dell'invio cartaceo (OK / KO)

  • notificationDate: data di consegna o mancata consegna.

  • registeredLetterCode:codice della lettera raccomandata

  • deliveryDetailCode:codice del dettaglio esito invio cartaceo

  • deliveryFailureCause: causa del fallimento della consegna

  • serviceLevel: tipologia del prodotto inviato (es: 890/AR)

  • newAddress: Eventuale indirizzo fisico a seguito di indagine svolta in loco da parte dell'addetto al recapito postale

  • sentAttemptMade: numero di tentativo (0 per il primo)

(*) Per la decodifica dei codici di e deliveryFailureCause e deliveryDetailCode all'interno dei details degli eventi di SEND_ANALOG_FEEDBACK si rimanda alla pagina Decodifiche SEND_ANALOG

ANALOG_SUCCESS_WORKFLOW

Completato con successo il workflow di invio cartaceo.

details

  • recIndex: posizione del destinatario nell'array recipients

  • physicalAddress: indirizzo fisico della spedizione

ANALOG_FAILURE_WORKFLOW

Completato con fallimento il workflow di invio cartaceo.

details

  • recIndex: posizione del destinatario nell'array recipients

  • generatedAarUrl: deposito della AAR

COMPLETELY_UNREACHABLE

Il destinatario è risultato irraggiungibile.

Attachments

Con category = "ANALOG_FAILURE_DELIVERY" e key riferimento per il download del documento di Deposito dell'avviso di avvenuta ricezione (deposito AAR) sulla piattaforma

details

  • recIndex: posizione del destinatario nell'array recipients

  • legalFactGenerationDate: data di generazione del documento di deposito AAR

Eventi di chiusura del workflow

REFINEMENT

Perfezionamento per decorrenza termini

details

  • recIndex: posizione del destinatario nell'array recipients

  • notificationCost: costo della notifica rifiutata per il mittente

  • eventTimestamp: indica la data di perfezionamento della notifica per decorrenza termini

NOTIFICATION_VIEWED

Visualizzazione della notifica (perfeziona la notifica se non già perfezionata per decorrenza termini o da altro destinatario)

attachments

RECIPIENT_ACCESS Attestazione di avvenuto accesso

details

  • recIndex: posizione del destinatario nell'array recipients

  • notificationCost: costo di gestione della notifica per il mittente espresso in euro-cents

  • eventTimestamp: data di visualizzazione della notifica

  • delegateInfo: struttura che contiene le informazione dell'eventuale delegato che ha fatto accesso alla notifica.

    • taxId: codice fiscale del delegato

    • denomination: denominazione delegato

    • delegateType: tipologia delegato PF/PG

NOTIFICATION_CANCELLED

Evento di fine della cancellazione della notifica dal parte del mittente.

details

  • notificationCost: costo di gestione della notifica per il mittente espresso in euro-cents

Altri eventi di timeline

NOTIFICATION_RADD_RETRIEVED

Evento di accesso alla notifica tramite RADD

details

  • recIndex: posizione del destinatario nell'array recipients

  • eventTimestamp: data di consegna della notifica

  • raddType: tipologia soggetto RADD

  • raddTransactionId: identificativo della transazione RADD

Eventi aggiuntivi al DEFAULT

In questo paragrafo sono indicati altri eventi della timeline che non hanno effetto sullo stato della notifica e non hanno una importanza prioritaria per il mittente, ma possono essere interessanti per recuperare delle informazioni di dettaglio. Ricordiamo che questi dati sono mantenuti dalla piattaforma in modo sicuro per 10 anni e sono sempre disponibili per essere recuperati tramite le API.

Eventi di preparazione workflow

AAR_GENERATION

Generazione dell’AAR (Avviso di Avvenuta Ricezione)

details

  • recIndex: posizione del destinatario nell'array recipients

  • generatedAarUrl: url per accedere all'avviso di avvenuta ricezione

SEND_COURTESY_MESSAGE

Invio di un messaggio di cortesia.

details

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress

    • type: tipologia messaggio di OPT_IN o un messaggio su APPIO, EMAIL o SMS

    • address: indirizzo email o numero di telefono utilizzato per il messaggio.

PROBABLE_SCHEDULING_ANALOG_DATE

Indica che il workflow può essere sospeso per 120h a fronte di un invio di un messaggio di cortesia.

details

  • recIndex: posizione del destinatario nell'array recipients

  • schedulingAnalogDate: data di inizio del workflow analogico, ritardato a causa di invio di messaggi di cortesia.

Eventi di scelta del workflow

PUBLIC_REGISTRY_RESPONSE

Indica la ricezione di un domicilio digitale dai registri nazionali

details

  • recIndex: posizione del destinatario nell'array recipients

  • digitalAddress: indirizzo digitale del destinatario

    • type: tipo domicilio digitale

    • address: indirizzo domicilio digitale

Eventi con evidenze dell'invio

Gli eventi di PROGRESS sono eventi restituiti dai servizi esterni di invio digitale (SEND_DIGITAL_PROGRESS) e cartaceo (SEND_ANALOG_PROGRESS).

Questi eventi possono contenere anche dei legalFact esterni come il messaggio di consegna della PEC (in formato EML) nel caso di invio digitale o le scansioni della ricevuta di consegna, del plico, del avviso di ricevimento, dell'indagine del postino nel caso di invio di raccomandata.

SEND_DIGITAL_PROGRESS

Indica un evento successivo relativo all'invio della PEC.

Attachments

Con category = "PEC_RECEIPT" e key il riferimento per il download del file in formato EML che attesta l'accettazione della PEC.

details

  • recIndex: posizione del destinatario nell'array recipients

  • eventTimestamp: data e ora della accettazione

  • digitalAddress: indirizzo digitale del destinatario

  • digitalAddressSource: indica la tipologia di domicilio digitale (PLATFORM, SPECIAL, GENERAL)

  • retryNumber: numero tentativo (0 per il primo)

SEND_ANALOG_PROGRESS

Indica un evento successivo relativo all'invio cartaceo

attachments

deliveryDetailCode

documentType

Descrizione

CON018

AAR

Accettazione Recapitista - L’evento rappresenta l’accettazione della Distinta di presa in carico da parte del Recapitista

CON020

Copia Conforme AAR

Copia conforme all'originale dell'avviso di avvenuta ricezione (AAR)

RECRN001B

AR

Ricevuta di consegna

RECRN002B, RECRN004B, RECRN002E, RECRN005B

Plico

Scansione Plico

RECRN003B

AR

Avviso di ricevimento

RECRN002E

Indagine

Indagine in loco dell'addetto al recapito (questa spesso è inclusa nella Scansione del

details

  • recIndex: posizione del destinatario nell'array recipients

  • notificationDate: data evento

  • deliveryDetailCode: codice consegna (*)

  • serviceLevel: tipologia di servizio

  • registeredLetterCode: identificativo raccomandata

  • attachments: array dei documenti allegati con struttura

    • id: indice nell'array

    • documentType: tipo documento

    • url: identificativo per il download

    • date: data produzione documento

PREPARE_ANALOG_DOMICILE_FAILURE

Invio cartaceo non possibile: non è stato trovato nessun indirizzo valido per predisporre il tentativo.

details

failureCause : indica il motivo del fallimento del secondo invio tramite i codici

  • D00: Non è stato trovato nessun nuovo indirizzo per predisporre un altro tentativo di invio.

  • D01: L’indirizzo non ha superato il processo di validazione.

  • D02: L’indirizzo è già stato usato per effettuare un tentativo di invio.

(*) Per la decodifica dei codici di deliveryDetailCode all'interno dei details degli eventi di SEND_ANALOG_PROGRESS si rimanda alla pagina

Last updated