Unipile icon

Unipile

Interact with Unipile API

Overview

The "Sync Chat From Start" operation in the Messaging resource of this node is designed to retrieve the entire chat history from the beginning for a specified chat. This operation is useful when you want to synchronize or back up all messages from a particular chat thread, ensuring you have a complete record starting from the first message.

Practical examples include:

  • Archiving chat conversations for compliance or record-keeping.
  • Migrating chat data to another system.
  • Analyzing full conversation histories for insights or reporting.

Properties

Name Meaning
Chat ID The unique identifier of the chat whose full history you want to sync. This is required to specify which chat to retrieve messages from.

Output

The output will contain a JSON structure representing the full chat history starting from the earliest message. Each item in the output typically corresponds to an individual message or event within the chat, including details such as sender, timestamp, and message content.

If the node supports binary data (e.g., attachments or media within messages), it would be included accordingly, but based on the provided code snippet, the primary output is JSON-formatted chat data.

Dependencies

  • Requires an API key credential to authenticate with the Unipile API.
  • The base URL for API requests is configured via credentials.
  • The node depends on the Unipile API service being accessible and properly configured.

Troubleshooting

  • Missing or invalid Chat ID: Ensure that the Chat ID property is correctly set and corresponds to an existing chat in the Unipile system.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network or API errors: Check connectivity to the Unipile API endpoint and confirm the base URL is correct.
  • Empty results: If no messages are returned, confirm that the chat contains messages and that the Chat ID is accurate.

Links and References

Discussion