Tabella dei contenuti
Submit a Message passing the user fiscal_code in the request body
Descrizione
Questa API consente l’invio di messaggi verso un cittadino identificato tramite Codice Fiscale. Prima di inviare un messaggio, dovrai verificare che il cittadino sia iscritto a IO e che il servizio possa inviare comunicazioni al cittadino stesso.
post
time_to_live
| 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 |
|
| Esempio | ADVANCED |
content *
subject *
| Descrizione | Titolo del messaggio, la cui lunghezza deve essere compresa tra 10 e 120 caratteri |
| Obbligatorio | Sì |
| 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 | Sì |
| Tipo | Stringa |
| Esempio | This is my first message to the IO app. Use body markdown format with min 80 characters. |
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.000Z |
payment_data
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 |
invalid_after_due_date
| Descrizione | In app visualizza il pagamento come scaduto se la data attuale è successiva a due_date |
| Obbligatorio | No |
| Default | |
| Tipo | Booleano |
| Esempio |
payee
third_party_data
id *
| Descrizione | identificativo third party univoco, generato dall'ente, necessario per poter aggregare il messaggio coi suoi allegati |
| Obbligatorio | Sì |
| Tipo | Stringa |
| Esempio |
has_attachments
| Descrizione | Indica la presenza di eventuali allegati relativi al messaggio. |
| Obbligatorio | No |
| Default | |
| Tipo | Booleano |
| Esempio |
🚧 Campi riservati per utilizzi futuri
original_sender
original_receipt_date
summary
prescription_data
eu_covid_cert
legal_data
Esempi
1### REQUEST
2curl --location --request POST 'https://api.io.pagopa.it/api/v1/messages' \
3--header 'Content-Type: application/json' \
4--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__' \
5--data-raw '{
6"content": {
7"subject": "Welcome new user !",
8"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."
9},
10“feature_type”: “STANDARD”,
11"fiscal_code": "AAAAAA00A00A000A"
12}'
131### RESPONSE
2{
3"id": "01EM6X4JB9VSZTQ8H16KMQFCEJ"
4}
5Risorse utili
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