Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API to list messages within the Messaging resource. It is designed to retrieve a collection of messages based on various filtering and pagination parameters. This node is useful in scenarios where you want to automate the retrieval of messaging data, such as fetching recent messages, filtering by sender or account, or paginating through large sets of messages.

Practical examples include:

  • Fetching the latest 50 messages from a specific account.
  • Retrieving messages sent by a particular sender.
  • Paginating through messages using cursors or date filters.

Properties

Name Meaning
Account ID Filter messages by a specific account identifier.
After Retrieve messages sent after this timestamp (string format).
Before Retrieve messages sent before this timestamp (string format).
Cursor A cursor string used for pagination to continue listing messages from a previous request.
Limit Maximum number of messages to return (minimum 1, default 50).
Sender ID Filter messages by a specific sender identifier.

Output

The output contains a JSON array of message objects retrieved from the Unipile API. Each object represents a message with its associated metadata as returned by the API. The exact structure depends on the API response but typically includes fields like message content, sender information, timestamps, and identifiers.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is configured dynamically from the provided credentials.
  • The node sends HTTP requests with JSON headers (Accept: application/json and Content-Type: application/json).

Troubleshooting

  • Invalid or missing API credentials: Ensure that the API key credential is correctly set up and valid.
  • Pagination issues: If using cursors, verify that the cursor value is correct and corresponds to a valid page.
  • Limit parameter errors: The limit must be at least 1; setting it below this may cause errors.
  • Date filter format: The after and before fields expect properly formatted date strings; incorrect formats may lead to no results or errors.
  • API connectivity problems: Check network access and the correctness of the base URL configured via credentials.

Links and References

Discussion