Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API to retrieve messaging data. Specifically, for the "Messaging" resource and the "Get Message" operation, it fetches a single message by its unique identifier. This is useful in scenarios where you need to access the content or metadata of a specific message from your unified messaging platform managed by Unipile.

Practical examples include:

  • Retrieving the details of a customer support message to display or process further.
  • Accessing a particular chat or SMS message for auditing or logging purposes.
  • Integrating message content into workflows such as automated responses or notifications.

Properties

Name Meaning
Message ID The unique identifier of the message to retrieve. This is required to specify which message the node should fetch.

Output

The node outputs JSON data representing the retrieved message. This typically includes all relevant fields of the message such as sender, recipient, timestamp, content, and any associated metadata provided by the Unipile API.

If the message contains binary data (e.g., attachments), the node would handle this accordingly, but based on the provided code and properties, the primary output is structured JSON data about the message.

Dependencies

  • Requires an active connection to the Unipile API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for the API is dynamically set from the credential's DSN (Data Source Name).
  • The node sends HTTP requests with JSON headers (Accept: application/json and Content-Type: application/json).

Troubleshooting

  • Missing or invalid Message ID: Since the Message ID is required, ensure it is provided and correctly formatted. Errors will occur if this is missing or incorrect.
  • Authentication errors: If the API key or token is invalid or expired, the node will fail to authenticate. Verify credentials in n8n settings.
  • Network or API endpoint issues: Check that the base URL (DSN) is correct and the Unipile API service is reachable.
  • Unexpected API response: If the message ID does not exist or the API returns an error, the node will propagate this error. Confirm the message exists and the user has permission to access it.

Links and References

Discussion