⚠️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

post

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.

Authorizations

Path parameters

fiscal_codeanyrequired

The fiscal code of the user, all upper case.

Body

time_to_liveinteger · min: 3600 · max: 604800 · default: 3600optional

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

contentall ofrequired

default_addressesobjectoptional

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

fiscal_codestring · FiscalCodeoptional

User's fiscal code.

Example: SPNDNL80R13C555X

feature_level_typestring · default: "STANDARD"optional

Example: STANDARD

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.io.pagopa.it/api/v1/messages/{fiscal_code}' \
  --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "time_to_live": 3600,
    "content": {
      "subject": "Welcome new user !",
      "markdown": "# This is a markdown header

  to show how easily markdown can be converted to **HTML**

  Remember: this has to be a long text.",
      "require_secure_channels": true,
      "payment_data": {
        "amount": 1,
        "notice_number": "text",
        "invalid_after_due_date": true,
        "payee": {
          "fiscal_code": "12345678901"
        }
      },
      "prescription_data": {
        "nre": "text",
        "iup": "text",
        "prescriber_fiscal_code": "TCNZRO80R13C555Y"
      },
      "legal_data": {
        "sender_mail_from": "text",
        "has_attachment": true,
        "message_unique_id": "text",
        "original_message_url": "text",
        "pec_server_service_id": "text"
      },
      "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": true,
        "has_remote_content": true,
        "has_precondition": "text",
        "summary": "text",
        "configuration_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
      },
      "due_date": "2018-10-13T00:00:00.000Z"
    },
    "default_addresses": {
      "email": "[e-mail]"
    },
    "fiscal_code": "SPNDNL80R13C555X",
    "feature_level_type": "STANDARD"
  }'

application/json

201

400

401

403

429

500

201

{
  "id": "text"
}

Message created.

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