DevPortalPagoPA



Tabella dei contenuti

Get Message

Descrizione

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.

message

id

DescrizioneIdentificativo del messaggio ottenuto con la Submit a message
TipoStringa
Esempio01EM6X4JB9VSZTQ8H16KMQFCEJ

fiscal_code

DescrizioneCodice fiscale del cittadino a cui è stato inviato il messaggio
TipoStringa
EsempioAAAAAA00A00A000A

created_at

DescrizioneData di creazione del messaggio nel formato ISO-8601 e fuso orario UTC
TipoStringa
Esempio2021-02-18T08:17:01.775Z

sender_service_id

DescrizioneIdentificativo del servizio associato al messaggio
TipoStringa
Esempio01EYNQ0864HKYR1Q9PXPJ18W7G

content

I dati relativi al content sono gli stessi inviati tramite il submit del messaggio.

notification

email

DescrizioneStato 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.
TipoStringa
EsempioSENT

webhook

DescrizioneStato 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.
TipoStringa
EsempioSENT

status

DescrizioneStato 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.
TipoStringa
EsempioPROCESSED

Esempi

Esempio: “PROCESSED”
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__'
4
1### 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}
19

Risorse 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