Tabella dei contenuti
Get Message
Descrizione
Questa API controlla lo stato di invio del messaggio recuperando il contenuto. Dovrai interrogare l’API con il Codice Fiscale del cittadino oggetto del messaggio e l’identificativo del messaggio.
get
message
id
| Descrizione | Identificativo del messaggio ottenuto con l'API ⚠️ Submit a Message passing the user fiscal_code as path parameter |
| Tipo | Stringa |
| Esempio | 01EM6X4JB9VSZTQ8H16KMQFCEJ |
fiscal_code
| Descrizione | Codice Fiscale del cittadino a cui è stato inviato il messaggio |
| Tipo | Stringa |
| Esempio | AAAAAA00A00A000A |
created_at
| Descrizione | Data di creazione del messaggio nel formato ISO-8601 e fuso orario UTC |
| Tipo | Stringa |
| Esempio | 2021-02-18T08:17:01.775Z |
sender_service_id
| Descrizione | Identificativo del servizio associato al messaggio |
| Tipo | Stringa |
| Esempio | 01EYNQ0864HKYR1Q9PXPJ18W7G |
I dati relativi al Content sono gli stessi inviati in occasione della creazione del messaggio.
notification
| Descrizione | Stato d'invio dell'email. - SENT: email inviata correttamente; - THROTTLED: errore temporaneo per sovraccarico, il messaggio potrà essere recapitato entro il TTL e per un massimo di 7 giorni; - EXPIRED: raggiunto il massimo TTL del messaggio; - FAILED: errore permanente della notifica. |
| Tipo | Stringa enumerata |
| Esempio | SENT |
webhook
| Descrizione | Stato d'invio della notifica push. - SENT: notifica inviata; - THROTTLED: errore temporaneo per sovraccarico, il messaggio potrà essere recapitato entro il TTL e per un massimo di 7 giorni; - EXPIRED: raggiunto il massimo TTL del messaggio; - FAILED: errore permanente della notifica. |
| Tipo | Stringa enumerata |
| Esempio | SENT |
status
| Descrizione | Stato d'invio del messaggio. - ACCEPTED: il messaggio è stato inserito in coda per il salvataggio; - THROTTLED: errore temporaneo per sovraccarico, il messaggio potrà essere recapitato entro il TTL e per un massimo di 7 giorni; - FAILED: errore permanente nel salvataggio del messaggio; - PROCESSED: il messaggio è stato inviato; quando rilevi questo stato hai la certezza che il tuo messaggio è a disposizione del destinatario quando aprirà app IO - REJECTED: il messaggio è stato scartato perché il destinatario non esiste o ha bloccato le comunicazioni del servizio. |
| Tipo | Stringa enumerata |
| Esempio | PROCESSED |
read_status
| Descrizione | Campo presente solo per i messaggi inviati come ADVANCED (parte del programma Premium). Il campo può assumere i seguenti valori:
|
| Tipo | Stringa enumerata |
| Esempio | READ |
payment_status
| Descrizione | Campo presente solo per i messaggi che contengono un avviso di pagamento e che vengono inviati come ADVANCED (parte del programma Premium). Il campo può assumere i seguenti valori:
|
| Tipo | Stringa enumerata |
| Esempio | NOT_PAID |
Esempi
Messaggio standard
1### REQUEST
2curl --location --request GET 'https://api.io.pagopa.it/api/v1/messages/AAAAAA00A00A000A/01EM6X4JB9VSZTQ8H16KMQFCEJ' \
3--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__'
41### RESPONSE
2{
3"message": {
4 "content": {
5 "subject": "My first IO app message with min 10 character",
6 "markdown": "This is my first message to the IO app. Use body markdown format with min 80 character"
7 },
8 "created_at": "2021-02-18T08:17:01.775Z",
9 "fiscal_code": "AAAAAA00A00A000A",
10 "id": "01EM6X4JB9VSZTQ8H16KMQFCEJ",
11 "sender_service_id": "01EYNQ0864HKYR1Q9PXPJ18W7G"
12 },
13 "notification": {
14 "email": "SENT",
15 "webhook": "SENT"
16 },
17 "status": "PROCESSED"
18}
191### REQUEST
2curl --location --request GET 'https://api.io.pagopa.it/api/v1/messages/AAAAAA00A00A000A/01EM6X4JB9VSZTQ8H16KMQFCEJ' \
3--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__'
41### RESPONSE
2{
3 "message": {
4 "content": {
5 "subject": "My first IO app message with min 10 character",
6 "markdown": "This is my first message to the IO app. Use body markdown format with min 80 character"
7 },
8 "created_at": "2021-02-18T08:17:01.775Z",
9 "fiscal_code": "AAAAAA00A00A000A",
10 "id": "01EM6X4JB9VSZTQ8H16KMQFCEJ",
11 "sender_service_id": "01EYNQ0864HKYR1Q9PXPJ18W7G"
12 },
13 "notification": {
14 "email": "SENT",
15 "webhook": "SENT"
16 },
17 “read_status”: “READ”,
18 “payment_status”: “NOT_PAID”,
19 "status": "PROCESSED"
20}
21
22Risorse 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