...
After identifying which specific message(s) should be retrieved by using the availableMessages endpoint, the messages can be retrieved from the "retrieve" endpoints that correspond to their the message type. In the request body, users can specify parameters such as the limit (number of messages to retrieve), "shouldPeek" and sequenceNumber.
The API for the specified message type for Calling to a "retrieve" endpoint responds to results in the retrieval request with of the requested messages. Users can then process and display these messages in their application based on their type and content.
This pull model allows users to have control over the messages message type they retrieve, specifying limits and retrieving messages from a particular point in the sequence using "sequenceNumber"
3. Messages are (soft)deleted after retrieval
After retrieval messages are soft-deleted. This means that after retrieval, messages are marked as deleted for the end-user and no longer available in the "availableMessages" and their corresponding "Retrieve" endpoint.
After soft-deletion, the system marks the messages as deleted for the end user, but messages will be stored for an additional temporary period of 72 hours. During this timeframe, the data is still restorable.
...
To recover or "restore" a soft-deleted message, users can call to the "recoverMessages" endpoint. This endpoint allows users to bring back messages that were soft-deleted within the a 72 hour timeframe.
This approach provides an additional safety measure for end users. In case a message was mistakenly deleted during the retrieval process, or if there is a need to recover soft-deleted data, this mechanism allows for data recovery without permanent loss.
...