Actions22
Message → Get All
AI-generatedOverview
This node interacts with the Supportpal REST API to retrieve all messages associated with a specific ticket. It allows users to fetch messages by specifying the ticket ID and apply various filters through query parameters, such as including drafts, filtering by message type (ticket messages or notes), filtering by user or operator messages, pagination controls (start and limit), and sorting options (order column and direction). This operation is useful for support teams who want to programmatically access all communications related to a ticket for analysis, reporting, or integration with other systems.
Use Case Examples
- Fetch all messages for a given ticket ID to display the conversation history in a custom dashboard.
- Retrieve only user-posted messages excluding operator notes for sentiment analysis.
- Get a limited number of recent messages sorted by their ID in descending order for quick review.
Properties
| Name | Meaning |
|---|---|
| Ticket ID | The ID of the ticket to fetch messages for. This is a required numeric input to specify which ticket's messages to retrieve. |
| Simplify Response | A boolean flag to return a simplified response containing only the message data, omitting additional metadata or nested structures. |
| Query Parameters | A collection of optional filters and controls to refine the messages retrieved. Includes options to include drafts, filter by user or operator messages, filter by message type (ticket messages or notes), pagination controls (start and limit), and sorting options (order column and direction). |
Output
JSON
id- The unique identifier of the message.ticket_id- The ID of the ticket the message belongs to.user_id- The ID of the user who posted the message.text- The content of the message.type- The type of message, indicating if it is a ticket message or a note.is_draft- Indicates if the message is a draft.created_at- Timestamp when the message was created.updated_at- Timestamp when the message was last updated.
Dependencies
- Supportpal REST API
Troubleshooting
- Ensure the provided Ticket ID is valid and exists in the Supportpal system to avoid 'not found' errors.
- Check API credentials and permissions to confirm the node can access message data.
- If the response is empty, verify the query parameters to ensure they are not overly restrictive.
- Network issues or API downtime can cause request failures; retry or check API status if errors occur.
Links
- Supportpal API Documentation - Official documentation for the Supportpal REST API, useful for understanding available endpoints and parameters.