Get Message
API che controlla lo stato di invio del messaggio recuperando il contenuto. È necessario interrogare l’API con il Codice Fiscale del cittadino oggetto del messaggio e l’identificativo del messaggio.
get
https://api.io.pagopa.it/api/v1
/messages/{fiscal_code}/{id}
Get Message
Descrizione | |
Tipo | Stringa |
Esempio | 01EM6X4JB9VSZTQ8H16KMQFCEJ |
Descrizione | Codice Fiscale del cittadino a cui è stato inviato il messaggio |
Tipo | Stringa |
Esempio | AAAAAA00A00A000A |
Descrizione | Data di creazione del messaggio nel formato ISO-8601 e fuso orario UTC |
Tipo | Stringa |
Esempio | 2021-02-18T08:17:01.775Z |
Descrizione | Identificativo del servizio associato al messaggio |
Tipo | Stringa |
Esempio | 01EYNQ0864HKYR1Q9PXPJ18W7G |
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 |
Esempio | SENT |
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 |
Esempio | SENT |
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;
- REJECTED: il messaggio è stato scartato perché il destinatario non esiste o ha bloccato le comunicazioni del servizio. |
Tipo | Stringa |
Esempio | PROCESSED |
Descrizione | Campo presente solo per i messaggi inviati come ADVANCED (parte del programma Premium). Il campo può assumere i seguenti valori:
|
Tipo | Stringa |
Esempio | READ |
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 |
Esempio | NOT_PAID |
### REQUEST
curl --location --request GET 'https://api.io.pagopa.it/api/v1/messages/AAAAAA00A00A000A/01EM6X4JB9VSZTQ8H16KMQFCEJ' \
--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__'
### RESPONSE
{
"message": {
"content": {
"subject": "My first IO app message with min 10 character",
"markdown": "This is my first message to the IO app. Use body markdown format with min 80 character"
},
"created_at": "2021-02-18T08:17:01.775Z",
"fiscal_code": "AAAAAA00A00A000A",
"id": "01EM6X4JB9VSZTQ8H16KMQFCEJ",
"sender_service_id": "01EYNQ0864HKYR1Q9PXPJ18W7G"
},
"notification": {
"email": "SENT",
"webhook": "SENT"
},
"status": "PROCESSED"
}
### REQUEST
curl --location --request GET 'https://api.io.pagopa.it/api/v1/messages/AAAAAA00A00A000A/01EM6X4JB9VSZTQ8H16KMQFCEJ' \
--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__'
### RESPONSE
{
"message": {
"content": {
"subject": "My first IO app message with min 10 character",
"markdown": "This is my first message to the IO app. Use body markdown format with min 80 character"
},
"created_at": "2021-02-18T08:17:01.775Z",
"fiscal_code": "AAAAAA00A00A000A",
"id": "01EM6X4JB9VSZTQ8H16KMQFCEJ",
"sender_service_id": "01EYNQ0864HKYR1Q9PXPJ18W7G"
},
"notification": {
"email": "SENT",
"webhook": "SENT"
},
“read_status”: “READ”,
“paid_status”: “NOT_PAID”,
"status": "PROCESSED"
}