Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," is designed to interact with the Evolution API service. Specifically, for the Resource "Chat" and Operation "Procurar Chats" (Find Chats), it allows users to search for chat messages within a specified instance and contact. This can be useful in scenarios where you need to retrieve historical chat data, audit conversations, or integrate chat logs into other workflows.

Practical examples include:

  • Fetching chat history for a particular contact in a messaging instance.
  • Paginating through chat messages to display or process them incrementally.
  • Integrating chat search results into customer support or CRM systems.

Properties

Name Meaning
Nome Da Instância The name of the messaging instance where the chat is located.
Contato The contact number (remote JID) whose chats are being searched.
ID Da Mensagem The specific message ID to find within the chats.
Página The page number for paginated results (default is 1).
Quantidade Por Página Number of chat entries to return per page (default is 10).

Output

The node outputs a JSON array containing the search results from the chat messages matching the criteria. Each item in the array represents a chat message or chat metadata retrieved from the Evolution API.

If the node supports binary data output (not explicitly shown in the provided code), it would typically represent media attachments or files associated with chat messages. However, based on the static analysis, the output focuses on JSON-formatted chat data.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API service.
  • The node expects the Evolution API endpoint to be accessible and properly configured.
  • No additional environment variables or external dependencies are indicated in the source code.

Troubleshooting

  • Operation Not Supported Error: If you select an unsupported operation or resource, the node throws an error stating the operation is not supported. Ensure that the Resource is set to "chat-api" and Operation to "find-chats" as per your use case.
  • Missing Required Parameters: The properties "Nome Da Instância," "Contato," and "ID Da Mensagem" are required. Omitting these will likely cause errors or empty results.
  • Pagination Issues: Providing invalid values for "Página" or "Quantidade Por Página" (e.g., negative numbers) may result in unexpected behavior or no results.
  • API Authentication Failures: Ensure the API key credential is valid and has sufficient permissions to access chat data.

Links and References


Note: The above summary is based solely on static analysis of the provided source code and property definitions.

Discussion