LogoLogo
v2.4
v2.4
  • 🏠Guida tecnica
  • 🕗Changelog
  • 🔢Setup iniziale
    • Adesione tramite l'Area Riservata
    • Iscrizione al Developer Portal
  • Funzionalità
    • 📦Pubblicare un servizio
      • Creare un servizio
      • Provare un servizio in test
      • Dati obbligatori
        • Attributi
        • Service Metadata
      • Importare servizi nell'Area Riservata
    • ✉️Inviare un messaggio
      • Messaggi di test
      • 📎Aggiungere allegati (Premium)
        • Specifiche degli endpoint di recupero degli allegati
  • 📐API
    • OpenAPI
    • API Messaggi
      • Get a User Profile using POST
      • Submit a Message passing the user fiscal_code in the request body
      • Get Message
      • Get Subscriptions Feed
      • ⚠️Get a User Profile
      • ⚠️Submit a Message passing the user fiscal_code as path parameter
    • API Servizi
      • Get User Services
      • Get Service
      • Update Service
      • Regenerate Service Key
      • Upload service logo
      • Upload organization logo
      • Create Service
    • Errori comuni
    • Specifiche API
  • 🔑Abilitazioni
    • Test con Codici Fiscali reali
    • Test invio avvisi pagoPA
    • Invio messaggi massivo
    • Subscription feed
    • Gestione dei servizi
    • Funzionalità Premium
  • Risorse Utili
    • ❓Supporto agli Enti
    • 📘Glossario
Powered by GitBook
On this page
  • Cosa sono i messaggi?
  • Che tipologie di messaggi esistono?
  • Come funziona l'invio dei messaggi?
  • Gestione degli errori
  1. Funzionalità

Inviare un messaggio

Cosa sono i messaggi?

L’invio di messaggi è la prima tipologia di comunicazione messa a disposizione dalle API di IO.

I messaggi sono comunicazioni personali dirette a un cittadino specifico, identificato tramite il suo Codice Fiscale. Questo significa che non è possibile inviare messaggi a più cittadini con una sola chiamata.

Che tipologie di messaggi esistono?

Ci sono due tipologie di messaggi:

  • Standard, ovvero i messaggi che possono inviare tutti gli enti che hanno sottoscritto un contratto a regime tradizionale;

  • Premium, ovvero i messaggi che possono inviare tutti gli enti che hanno sottoscritto un contratto a regime Premium.

Al momento dell'invio, gli enti che hanno aderito al programma Premium possono indicare, per ciascun messaggio da inviare, se questo sia Premium - e dunque scalato dal carnet, secondo le condizioni sottoscritte - oppure standard.

Come funziona l'invio dei messaggi?

Step 1 - Crea un servizio

Per inviare un messaggio, devi prima Pubblicare un servizio.

Step 2 - Testa il contenuto del messaggio

Prima di andare in produzione puoi testare il contenuto dei messaggi, che verranno inviati all'indirizzo email del delegato. Leggi la pagina Messaggi di test.

Step 3 - Verifica di poter contattare il destinatario

Ogni volta che invii un messaggio, devi assicurarti che il destinatario esista e che abbia dato il consenso a ricevere comunicazioni per quello specifico servizio.

Per maggiori informazioni scopri le API Get a User Profile using POST e Get Subscriptions Feed.

Step 4 - Invia il messaggio

Per farlo, usa l'API Submit a Message passing the user fiscal_code in the request body.

Puoi anche aggiungere allegati al messaggio, sfruttando una delle funzionalità del programma Premium. Per maggiori informazioni leggi Aggiungere allegati (Premium).

Step 5 - Controlla l'esito

Interroga l’API Get Message, utilizzando il Codice Fiscale del destinatario e l’identificativo del messaggio ottenuto nello step precedente.

Gestione degli errori

Tutte le API di IO possono restituire delle risposte di errore, definite nelle specifiche di ciascuna API. È necessario implementare lato client dei meccanismi per la corretta gestione di questo tipo di risposte.

Esempio: tutte le API possono restituire lo status code 429, che rappresenta un segnale che indica il superamento del rate consentito. In questo caso, è necessario implementare un meccanismo di retry e diminuire il rate delle richieste inserendo delle pause.

PreviousImportare servizi nell'Area RiservataNextMessaggi di test

Last updated 2 years ago

✉️