⚠️Submit a Message passing the user fiscal_code as path parameter

Attenzione: la seguente API sarà a breve deprecata, pertanto se ne sconsiglia l’uso.

Descrizione

API equivalente a Submit a Message passing the user fiscal_code in the request body

Submit a Message passing the user fiscal_code as path parameter

Submits a message to a user. On error, the reason is returned in the response payload. In order to call submitMessageforUser, before sending any message, the sender MUST call getProfile and check that the profile exists (for the specified fiscal code) and that the sender_allowed field of the user's profile it set to true.

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

Authorization

SubscriptionKey

Path parameters

fiscal_code*string

The fiscal code of the user, all upper case.

Example: "SPNDNL80R13C555X"

Pattern: [A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]

Body

application/json

time_to_liveinteger

This parameter specifies for how long (in seconds) the system will try to deliver the message to the channels configured by the user.

Example: 3600

content*all of

default_addressesobject

Default addresses for notifying the recipient of the message in case no address for the related channel is set in his profile.

fiscal_codestring (FiscalCode)

User's fiscal code.

Example: "SPNDNL80R13C555X"

feature_level_typestring

Example: "STANDARD"

Response

201400401403429500

Message created.

Headers

Body

application/json

idstring

The identifier of the created message.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.io.pagopa.it/api/v1/messages/{fiscal_code}', {
    method: 'POST',
    headers: {
      "Ocp-Apim-Subscription-Key": "SubscriptionKey <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "time_to_live": 3600,
      "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.",
        "payment_data": {
          "amount": 1,
          "notice_number": "text",
          "invalid_after_due_date": false,
          "payee": {
            "fiscal_code": "12345678901"
          }
        },
        "prescription_data": {
          "nre": "text",
          "prescriber_fiscal_code": "TCNZRO80R13C555Y"
        },
        "legal_data": {
          "sender_mail_from": "text",
          "has_attachment": false,
          "message_unique_id": "text"
        },
        "eu_covid_cert": {
          "auth_code": "text"
        },
        "third_party_data": {
          "id": "text",
          "original_receipt_date": "2018-10-13T00:00:00.000Z",
          "has_attachments": false,
          "has_remote_content": false,
          "configuration_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
        },
        "due_date": "2018-10-13T00:00:00.000Z"
      },
      "default_addresses": {
        "email": "[e-mail]"
      },
      "fiscal_code": "SPNDNL80R13C555X",
      "feature_level_type": "STANDARD"
    }),
});
const data = await response.json();

Response

201400500

{
  "id": "01BX9NSMKVXXS5PSP2FATZMYYY"
}

Esempi

### REQUEST
curl --location --request POST 'https://api.io.pagopa.it/api/v1/messages/AAAAAA00A00A000A' \
--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__' \
--header 'Content-Type: application/json' \
--data-raw '{
"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"
}
}'

### RESPONSE
{
"id": "01EM6X4JB9VSZTQ8H16KMQFCEJ"
}

Risorse utili

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