Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API to list chat messages within a specified chat. It is designed to retrieve messages from a particular chat conversation, supporting pagination and filtering options. This node is useful in scenarios where you want to automate the retrieval of chat history, monitor conversations, or integrate chat data into workflows for analysis or notifications.

Practical examples include:

  • Fetching recent messages from a customer support chat to trigger follow-up actions.
  • Archiving chat conversations by periodically listing and storing messages.
  • Filtering messages sent by a specific user within a chat for moderation or reporting.

Properties

Name Meaning
Chat ID The unique identifier of the chat from which to list messages.
Additional Fields Optional parameters to refine the message listing:
- After Return messages sent after this message ID or timestamp (used for pagination).
- Before Return messages sent before this message ID or timestamp (used for pagination).
- Cursor A cursor token for pagination to continue listing from a specific point.
- Limit Maximum number of messages to return (minimum 1, default 50).
- Sender ID Filter messages to only those sent by a specific sender ID.

Output

The node outputs a JSON array of chat messages retrieved from the specified chat. Each message object typically contains details such as message content, sender information, timestamps, and message IDs. If the API supports it, the output may also include pagination tokens or cursors to fetch subsequent pages.

If binary data is present (e.g., attachments), it would be included in the binary output field, representing files or media associated with messages.

Dependencies

  • Requires an API key credential to authenticate with the Unipile API.
  • The base URL for API requests is configured via credentials.
  • No additional external dependencies are indicated beyond the Unipile API access.

Troubleshooting

  • Missing or invalid Chat ID: The node requires a valid chat identifier; ensure this is provided and correct.
  • API authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Pagination issues: When using after, before, or cursor fields, ensure values are valid and correspond to existing message IDs or tokens.
  • Limit parameter errors: The limit must be at least 1; setting it to zero or negative will cause errors.
  • Sender ID filter returns no results: Confirm the sender ID exists in the chat and matches the expected format.

Links and References

Discussion