ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Messages API → List All Converation Messages

AI-generated

Overview

This node interacts with the Messages API of a chat platform to list all messages within a specific conversation. It is useful for retrieving the full message history of a conversation between a contact and an inbox channel, enabling workflows that require message auditing, analysis, or display.

Practical examples include:

  • Fetching conversation messages to display in a custom dashboard.
  • Archiving chat histories for compliance or record-keeping.
  • Triggering follow-up actions based on conversation content.

Properties

Name Meaning
Inbox Identifier The unique identifier of the inbox channel from which to retrieve conversation messages.
Contact Identifier The source ID of the contact involved in the conversation.
Conversation Id The numeric ID representing the specific conversation whose messages are to be listed.

Output

The node outputs a JSON array containing the messages of the specified conversation. Each item in the array represents a single message with details such as sender, timestamp, message content, and potentially metadata related to the message.

If the API supports binary data (e.g., attachments), those would be included accordingly, but this node primarily focuses on textual message data.

Dependencies

  • Requires an API key credential for authenticating with the chat platform's API.
  • The base URL for the API must be configured in the node credentials.
  • Depends on the external Messages API service being available and accessible.

Troubleshooting

  • Missing or invalid identifiers: Ensure that the Inbox Identifier, Contact Identifier, and Conversation Id are correctly provided and correspond to existing entities in the chat platform.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access conversation messages.
  • API connectivity issues: Check network connectivity and the correctness of the API base URL.
  • Empty results: If no messages are returned, confirm that the conversation ID is correct and that messages exist for that conversation.

Links and References

  • Refer to the official chat platform API documentation for detailed information on the Messages API endpoints and data structures.
  • Consult n8n community forums or documentation for examples on using API nodes with similar configurations.

Discussion