Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API to list chat conversations within the Messaging resource. It allows users to retrieve a collection of chats filtered and paginated according to various criteria. This is useful for scenarios where you want to automate the retrieval of messaging data, such as monitoring unread chats, syncing chat history, or integrating chat data into other workflows.

Practical examples include:

  • Fetching the latest 50 chats from a specific account.
  • Retrieving only unread chats to trigger notifications or follow-up actions.
  • Paginating through chat lists using cursors or date filters to process large volumes of messages incrementally.

Properties

Name Meaning
Account ID Filter chats by a specific account identifier.
Account Type Filter chats by the type of account (e.g., email, social media).
After Return chats created after this timestamp or cursor.
Before Return chats created before this timestamp or cursor.
Cursor Pagination cursor to continue listing chats from a previous request.
Limit Maximum number of chat results to return (minimum 1, default 50).
Unread Boolean flag to filter only unread chats (true) or all chats (false).

Output

The node outputs JSON data representing a list of chat objects retrieved from the Unipile API. Each item in the output corresponds to a chat conversation with its associated metadata (such as IDs, timestamps, status, participants, etc.). The exact structure depends on the API response but generally includes details necessary to identify and work with each chat.

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 via credentials.
  • The node sends HTTP requests with JSON content-type headers.

Troubleshooting

  • Empty results: Ensure that the filters (Account ID, Account Type, After, Before, Unread) are correctly set and that there are chats matching those criteria.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Pagination issues: When using cursors, ensure the cursor value is correct and not expired.
  • Limit parameter: Setting the limit too high might cause performance issues or API rate limiting; use reasonable values.
  • Network errors: Check connectivity and API endpoint availability.

Links and References

Discussion