Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key

Overview

This node, named "Evolution API Direct," allows users to interact with the Evolution API by directly specifying the server URL and an API key. It is designed to perform various operations on different resources exposed by the Evolution API. In the context of the provided resource "Chat" and operation "Ler Mensagens" (Read Messages), the node fetches specific chat messages from a given contact on a specified instance.

Typical use cases include:

  • Retrieving chat messages for monitoring or logging purposes.
  • Integrating chat data into workflows for further processing or analysis.
  • Automating message retrieval from a chat service that uses the Evolution API.

For example, a user can configure this node to read a particular message sent or received by a chat instance, enabling automated responses or archiving.

Properties

Name Meaning
Server URL The full URL of the Evolution API server to connect to (e.g., https://api.exemplo.com).
API Key The API key credential required to authenticate requests against the Evolution API.
Nome Da Instância The name of the specific instance within the Evolution API environment.
Contato The contact number (remote JID) whose message is to be read.
ID Da Mensagem The unique identifier of the message to retrieve.
Mensagem É Minha Boolean flag indicating if the message was sent by the instance itself (true/false).

Output

The node outputs a JSON array containing the retrieved message(s) data. Each item in the output array corresponds to a message object fetched from the Evolution API. The exact structure of the message object depends on the API response but typically includes details such as message content, sender information, timestamps, and message status.

If the API supports binary data (e.g., media attachments), the node would handle it accordingly, but based on the provided code and properties, the primary output is JSON-formatted message data.

Dependencies

  • Requires access to the Evolution API endpoint specified by the user via the "Server URL" property.
  • Requires a valid API key credential for authentication.
  • No additional external dependencies are indicated beyond standard HTTP request capabilities.
  • The node expects the user to provide correct instance names and identifiers relevant to their Evolution API setup.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API key will result in authentication errors.
    • Invalid server URL or network issues may cause connection failures.
    • Providing wrong instance name, contact number, or message ID will lead to empty or error responses.
  • Error Messages:

    • "Operação não suportada." indicates that the selected operation is not implemented for the chosen resource.
    • Network or HTTP errors will typically propagate from the underlying request library; ensure the server URL and credentials are correct.
  • Resolutions:

    • Verify all input parameters carefully.
    • Ensure the API key has sufficient permissions.
    • Check network connectivity and API availability.
    • Confirm that the message ID exists for the given contact and instance.

Links and References

Discussion