v2.2
Search…
⌃K

Submit a Message passing the user fiscal_code in the request body

Descrizione

API per l’invio di messaggi verso un cittadino identificato tramite Codice Fiscale. Prima di inviare un messaggio è importante verificare che il cittadino sia iscritto a IO e che il servizio possa inviare comunicazioni al cittadino stesso.
post
https://api.io.pagopa.it/api/v1
/messages
Submit a Message passing the user fiscal_code in the request body

time_to_live

Questo parametro è deprecato.
Descrizione
Tempo espresso in secondi che specifica il tempo di retry di delivery del messaggio
Obbligatorio
No
Default
3600
Tipo
Intero
Esempio
3600

feature_level_type

Descrizione
Indica se il messaggio è inviato nell’ambito di una sottoscrizione Premium, o se è da considerarsi un messaggio standard
Obbligatorio
No
Default
STANDARD
Tipo
Stringa enumerata
Valori Accettati
  • STANDARD -> il messaggio è da considerarsi un normale messaggio IO
  • ADVANCED -> al messaggio sono correlate informazioni aggiuntive avanzate. È possibile specificare questo valore solo se si è titolari di una sottoscrizione Premium.
Esempio
ADVANCED

content *

subject *

Descrizione
Titolo del messaggio, la cui lunghezza deve essere compresa tra 10 e 120 caratteri
Obbligatorio
Tipo
Stringa
Esempio
Rinnova la tua carta d'identità

markdown *

Descrizione
Testo del messaggio in formato markdown la cui lunghezza deve essere compresa tra 80 e 10000 caratteri
Obbligatorio
Tipo
Stringa
Esempio
This is my first message to the IO app. Use body markdown format with min 80 characters.
Per testare la sintassi in markdown, puoi utilizzare un servizio online come Stackedit.

due_date

Descrizione
Permette di associare al messaggio un promemoria. Il formato data deve essere ISO-8601 e fuso orario UTC
Obbligatorio
No
Tipo
Stringa
Esempio
2018-10-13T00:00:00.000Z
Fai attenzione al fuso orario! La data deve essere espressa nel fuso orario UTC (Z). In Italia si usa il fuso UTC+1 quando è in vigore l'ora solare, mentre si usa il fuso UTC+2 quando è in vigore l'ora legale.
Esempio:
2022-09-30T22:00:00Z --> In Italia è la mezzanotte del 1° ottobre 2022
2022-11-30T23:00:00Z --> In Italia è la mezzanotte del 1° novembre 2022
Fai attenzione all'orario! Se la data di scadenza non prevede un orario specifico, solitamente si fa riferimento alla fine della giornata. Inserisci correttamente l'orario per evitare di mostrare una data di scadenza errata.
Esempio:
✅ 12 gennaio (23:59:59) --> L'utente può pagare entro la giornata del 12 gennaio
❌ 12 gennaio (00:00:01) --> L'utente può pagare entro la giornata dell'11 gennaio

payment_data

Per l’invio degli avvisi di pagamento è necessario richiedere specifica l’abilitazione.

amount *

Descrizione
Importo in centesimi di euro dell’avviso di pagamento emesso su piattaforma pagoPA
Obbligatorio
Sì, per pagamenti pagoPA
Tipo
Intero
Esempio
100

notice_number *

Descrizione
Codice avviso di un avviso di pagamento emesso su piattaforma pagoPA
Obbligatorio
Sì, per i pagamenti pagoPA
Tipo
Stringa
Esempio
301011100007347557
È importante che il codice fiscale del servizio mittente corrisponda al codice fiscale dell’ente creditore che emette l’avviso pagoPA.

invalid_after_due_date

Descrizione
In app visualizza il pagamento come scaduto se la data attuale è successiva a due_date
Obbligatorio
No
Default
false
Tipo
Booleano
Esempio
false

payee

Questa funzionalità è in sperimentazione interna.

third_party_data

id *

Descrizione
identificativo third party univoco, generato dall'ente, necessario per poter aggregare il messaggio coi suoi allegati
Obbligatorio
Tipo
Stringa
Esempio
false

has_attachments

Descrizione
Indica la presenza di eventuali allegati relativi al messaggio.
Obbligatorio
No
Default
false
Tipo
Booleano
Esempio
false

original_sender

original_receipt_date

summary

prescription_data

Questa funzionalità è in sperimentazione interna.

eu_covid_cert

Questa funzionalità è riservata ai soggetti autorizzati.
Questa funzionalità è in sperimentazione interna.

Esempi

### REQUEST
curl --location --request POST 'https://api.io.pagopa.it/api/v1/messages' \
--header 'Content-Type: application/json' \
--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__' \
--data-raw '{
"content": {
"subject": "Welcome new user !",
"markdown": "# This is a markdown header\n\nto show how easily markdown can be converted to **HTML**\n\nRemember: this has to be a long text."
},
“feature_type”: “STANDARD”,
"fiscal_code": "AAAAAA00A00A000A"
}'
### RESPONSE
{
"id": "01EM6X4JB9VSZTQ8H16KMQFCEJ"
}

Risorse utili