📎Aggiungere allegati (Premium)

Cosa sono gli allegati

Gli enti che hanno sottoscritto il programma Premium possono includere allegati nei messaggi che inviano. Questi allegati vengono recuperati dai sistemi dell'ente mittente nel momento in cui vengono aperti dall'utente.

Quando l'utente apre un messaggio vengono recuperati, oltre ai metadati del contenuto del messaggio, anche quelli relativi ai metadati (endpoint 1). Il recupero del file vero e proprio avviene tramite l'endpoint 2, ovvero con una GET all'indirizzo {baseUrl}/messages/{id}/{url}

Come funziona?

Step 0 - Esponi gli endpoint di recupero degli allegati

Per permettere a IO di recuperare il contenuto di un messaggio e dei suoi allegati, devi mettere a disposizione un REST web service conforme alla relativa OpenAPI.

Per maggiori informazioni, leggi le Specifiche degli endpoint di recupero degli allegati.

Per includere gli allegati in un messaggio, oltre agli step indicati in Inviare un messaggio, devi seguire questi step:

Step 1 - Includi il blocco third_party_data

Includi il blocco third_party_data, che contiene le informazioni necessarie per mostrare gli allegati.

Step 2 - Specifica il valore TRUE nel campo has_attachments

Specifica il valore TRUE nel campo has_attachments presente nella request.

Step 3 - Specifica il valore ADVANCED nel campo feature_level_type

Specifica il valore ADVANCED nel campo feature_level_type presente nella request.

Esempi

Esempio di chiamata per l’invio di un messaggio con allegati:

curl --location --request POST 'https://api.io.pagopa.it/api/v1/messages' \
--header 'Ocp-Apim-Subscription-Key: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "content": {
    "subject": "Messaggio con allegati",
    "markdown": "# Titolo\n\nTesto del messaggio: contiene **allegati**!",
    "third_party_data": {
      "id": "1234567890", 
      "has_attachments": true
    }
  },
  "feature_level_type": "ADVANCED",
  "fiscal_code": "<validFiscalCode>",
}'

Esempio di risposta positiva:

{
  "id": "01BX9NSMKVXXS5PSP2FATZMYYY"
}