Table of contents
✉️ Send a message
What are messages?
Messages are personal communications directed to a specific citizen, identified by means of their fiscal code. It is currently not possible to send messages to multiple citizens with a single call.
To learn more, consult the page Inviare messaggi in the Service manual.
How are messages sent?
Step 1- Create a service
To send a message , you must first 📦 Publish a service.
Step 2- Test the content of the message
Before going into production mode, you can test the content of the messages. Read the page Test messages.
Step 3- Check that you can contact the recipient
Every time you send a message, you must make sure that the recipient exists and provided their consent to receive communications for that specific service.
For more information, discover the APIs Get a User Profile using POST and Get Subscriptions Feed.
Step 4- Send the message
To do so, use the API Submit a Message passing the user fiscal\_code in the request body.
If you intend to send a message with remote content, follow the relative instructions on how to be integrated.
You can also add PDF/A attachments. For more information read the relative instructions.
Step 5- Check the result
Query the API Get Message, using the fiscal code of the recipient and the identifier of the message obtained in the previous step.
If you signed the Premium agreement, you can also know the reading and payment status of the recipients.
Sending method
There are two methods for sending messages that are useful depending on the type of content you must communicate.
Traditional message
This is the simplest form of communication and that requires fewer integrations: the sender defines the content of the message and sends it.
Message with remote content
This is a message whose information is recovered by the systems of the sending institution each time the message is used by the final user. The messages with remote content are intended in particular for communications that send sensitive information.
{% hint style="info" %} At the moment of sending, the institutions that joined the Premium offer can indicate, for each message to send, whether or not to use the additional functions provided by the agreement. \
{% /hint %}
Error management
All the IO APIs can return the error responses defined in the specifications of each API_._ Customer-side mechanisms must be implemented to correctly manage this type of response.
{% hint style="info" %} Example: all the APIs can return status code 429, which represents a signal that indicates the exceedance of the permitted rate. In this case, it is necessary to implement a retry mechanism and decrease the rate of the requests by inserting pauses.
Haven't completed onboarding yet and need help?
Write an email describing your problem or question to the address areariservata@assistenza.pagopa.it.
Tell us what you think
To report problems or give feedback, leave a comment in the GitHub space of the IO app