📜Come sapere se un Messaggio è stato recapitato

Una volta che ti sarai assicurato che il tuo utente possa ricevere le tue comunicazioni e avrai spedito un messaggio su IO (anche con un avviso di pagamento), per conoscere il suo stato di processamento IO ti mette a disposizione un'apposita API che potrai richiamare in "polling" utilizzando l'identificativo univoco tornato dall'API di invio.

  1. Aggiungi l'header Ocp-Apim-Subscription-Key e valorizzalo con la chiave (primaria o secondaria) del tuo Servizio IO: puoi recuperarla accedendo all'Area Riservata e cercando la scheda del tuo Servizio nella pagina "Servizi"

  2. Componi la URL di invocazione per l'API come nell'esempio: https://api.io.pagopa.it/api/v1/messages/RSRNOU70S54S000L/01GS8744E24EZDG3XD5ECXB9RG

    1. il parametro in blu è il Codice Fiscale del destinatario del messaggio

    2. il parametro in verde è l'identificativo univoco del messaggio ritornato in fase di invio

  3. IO risponderà con lo stato aggiornato del messaggio:

{
"message": {
  "content": {
    "subject": "Partecipazione Evento",
    "markdown": "Gentile Mario Rossi,\n\r\n\rabbiamo accettato la tua richiesta di partecipazione all'\''evento e ti inviamo in allegato la ricevuta del pagamento della tua quota e la brochure con tutte le informazioni utili.\n\rA Ti aspettiamo!\n\rL'\''Amministrazione Comunale di Ipazia."
    },
    "created_at": "2023-03-16T08:17:01.775Z",
    "fiscal_code": "RSRNOU70S54S000L",
    "id": "01GS8744E24EZDG3XD5ECXB9RG",
    "sender_service_id": "01EYNQ0864HKYR1Q9PXPJ18W7G"
  },
  "notification": {
    "email": "SENT",
    "webhook": "SENT"
  },
  "status": "PROCESSED"
}
  • il campo id è l'eco dell'identificativo del messaggio che hai specificato in richiesta

  • il campo sender_service_id contiene il codice identificativo del servizio che stai usando per il messaggio:

    Il codice identificativo del Servizio è reperibile nell'Area Riservata
  • il campo status assume il valore PROCESSED nel momento in cui il messaggio è a disposizione dell'utente nella sua App IO; consulta la Guida Tecnica per gli altri possibili stati previsti

Un messaggio in stato PROCESSED è pronto per essere visualizzato nel momento in cui il destinatario utilizzi la propria App IO; non è garanzia del fatto che abbia già ricevuto la relativa notifica push, che dipende anche dalle impostazioni particolari del dispositivo che sta utilizzando.

Last updated