Tabella dei contenuti
📜 Come inviare un Messaggio
Facendo riferimento al procedimento indicato nella Guida Tecnica per l'integrazione ai servizi, dove puoi trovare tutte le informazioni preliminari e di dettaglio, qui ti forniamo un esempio pratico di invio di un Messaggio.
- Assicurati che il cittadino possa ricevere il tuo messaggio
- 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"\
- Componi la request per l'API di invio, della quale ti forniamo qui un esempio:
1{
2 "feature_level_type": "STANDARD",
3 "content": {
4 "subject": "Partecipazione Evento",
5 "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.",
6 "due_date": "2023-03-30T23:59:59.000Z"
7 },
8 "fiscal_code": "RSRNOU70S54S000L"
9}
10
- il campo subject è il titolo del messaggio e comparirà in testa allo stesso:\
- il campo markdown è il corpo del messaggio e, come suggerito dal nome, supporta lo standard Markdown per la formattazione del testo e l'inserimento di intestazioni, liste puntate/numerate, tabelle, link e immagini; per sapere come comunicare al meglio con la tua utenza su IO consulta la sezione dedicata nel Manuale dei Servizi
- il campo fiscal_code è il codice fiscale del Cittadino destinatario del messaggio
- se richiesto, aggiungi anche il campo due_date per indicare la data di scadenza; poni attenzione al formato richiesto dalle specifiche tecniche e alle considerazioni sui fusi orari riportate nella Guida Tecnica!
Nell'esempio, la data di scadenza è impostata in modo che il Cittadino possa pagare entro il termine della giornata del 31 marzo 2023 (a marzo non è in vigore l'ora legale e dunque in Italia il fuso è UTC+1)
- Invoca l'API di invio richiamando in POST l'endpoint https://api.io.pagopa.it/api/v1/messages
- Prendi nota dell'identificativo del Messaggio che IO ti comunica in risposta: ti servirà per conoscere il suo stato di processamento e, se sei cliente Premium, usufruire delle caratteristiche a valore aggiunto offerte dal Programma
1{
2 "id": "01GS8744E24EZDG3XD5ECXB9RG"
3}
4
- Ecco cosa vedrà il Cittadino aprendo App IO quando riceverà il tuo messaggio:\
Hai bisogno di aiuto?
Scrivi un’email in cui descrivi il tuo problema o dubbio all’indirizzo onboarding@io.italia.it
Dicci cosa ne pensi
Per segnalare problemi o dare feedback, lascia un commento nello spazio Github dell'app IO