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.

Get Message

The previously created message with the provided message ID is returned. With right permission and ADVANCED feature level type related to the previously submitted message, also read and payment status infos (when applicable) are returned.

GEThttps://api.io.pagopa.it/api/v1/messages/{fiscal_code}/{id}

Authorization

Path parameters

fiscal_code*string

The fiscal code of the user, all upper case.

id*string

The ID of the message.

Response

Message found.

Body

message*ExternalCreatedMessageWithContent (all of)

notificationMessageResponseNotificationStatus (object)

statusMessageStatusValue (all of)

The processing status of a message. "ACCEPTED": the message has been accepted and will be processed for delivery; we'll try to store its content in the user's inbox and notify him on his preferred channels "THROTTLED": a temporary failure caused a retry during the message processing; any notification associated with this message will be delayed for a maximum of 7 days "FAILED": a permanent failure caused the process to exit with an error, no notification will be sent for this message "PROCESSED": the message was succesfully processed and is now stored in the user's inbox; we'll try to send a notification for each of the selected channels "REJECTED": either the recipient does not exist, or the sender has been blocked

read_statusReadStatus (string)

Api definition of read status enumeration

payment_statusPaymentStatus (string)

Payment status enumeration

Request

const response = await fetch('https://api.io.pagopa.it/api/v1/messages/{fiscal_code}/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": {
    "id": "text",
    "fiscal_code": "SPNDNL80R13C555X",
    "time_to_live": 3600,
    "created_at": "2018-10-13T00:00:00.000Z",
    "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.",
      "require_secure_channels": false,
      "payment_data": {
        "notice_number": "text",
        "invalid_after_due_date": false,
        "payee": {
          "fiscal_code": "12345678901"
        }
      },
      "due_date": "2018-10-13T00:00:00.000Z",
      "prescription_data": {
        "nre": "text",
        "iup": "text",
        "prescriber_fiscal_code": "TCNZRO80R13C555Y"
      },
      "eu_covid_cert": {
        "auth_code": "text"
      },
      "third_party_data": {
        "id": "text",
        "original_sender": "text",
        "original_receipt_date": "2018-10-13T00:00:00.000Z",
        "has_attachments": false,
        "has_remote_content": false,
        "has_precondition": "text",
        "summary": "text",
        "configuration_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
      },
      "legal_data": {
        "sender_mail_from": "text",
        "has_attachment": false,
        "message_unique_id": "text",
        "original_message_url": "text",
        "pec_server_service_id": "text"
      }
    },
    "sender_service_id": "text",
    "feature_level_type": "STANDARD"
  },
  "notification": {
    "email": "SENT",
    "webhook": "SENT"
  },
  "status": {},
  "read_status": "UNREAD",
  "payment_status": "NOT_PAID"
}

`message`

`id`

`fiscal_code`

`created_at`

`sender_service_id`

`content`

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

`notification`

`email`

`webhook`

`status`

`read_status`

`paid_status`

Esempi

Messaggio standard

### 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"
}

Messaggio premium

###  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"
}

Risorse utili

https://developer.io.italia.it/openapi.html#operation/getMessage

PreviousSubmit a Message passing the user fiscal_code in the request body NextGet Subscriptions Feed

Last updated 1 year ago