Evolution API

Interagir com a Evolution API v2

Overview

This node integrates with the Evolution API v2 to perform various operations related to WhatsApp instances, messages, groups, chats, events, and integrations. Specifically, for the Chat resource and the Procurar Status (Find Status Message) operation, it allows users to search for WhatsApp status messages associated with a given instance.

Common scenarios where this node is beneficial include:

  • Automating the retrieval of WhatsApp status updates from contacts.
  • Monitoring status messages for customer engagement or marketing purposes.
  • Integrating WhatsApp status data into workflows for further processing or notifications.

For example, a user might configure this node to periodically fetch status messages from a WhatsApp instance to analyze customer sentiment or trigger alerts when specific keywords appear in statuses.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance to operate on. This identifies which WhatsApp session the operation targets.

Output

The output JSON structure contains the results returned by the Evolution API for the "findStatusMessage" operation. It typically includes an array of status message objects, each representing a WhatsApp status update found during the search.

Additionally, the output includes metadata fields:

  • success: Boolean indicating if the operation was successful.
  • timestamp: ISO string timestamp of when the operation completed.
  • count (if applicable): Number of items returned.

If the API returns no data, a success message with a timestamp is provided.

The node does not explicitly handle binary data for this operation.

Dependencies

  • Requires an authenticated connection to the Evolution API v2 via an API key credential configured in n8n.
  • The node uses HTTP requests to communicate with the Evolution API endpoints.
  • Proper configuration of the "Instance Name" property is necessary to target the correct WhatsApp instance.

Troubleshooting

  • Common Issues:

    • Incorrect or missing instance name will cause the API call to fail or return no data.
    • Network connectivity issues may prevent communication with the Evolution API.
    • Invalid or expired API credentials will result in authentication errors.
  • Error Messages:

    • Authentication failures typically indicate invalid API keys; verify and update credentials.
    • "Instance not found" or similar errors suggest the specified instance name does not exist or is not connected.
    • JSON parsing errors in the output usually mean the API response format changed or is malformed.
  • Resolutions:

    • Double-check the instance name spelling and ensure the instance is active.
    • Verify API credentials and renew if necessary.
    • Ensure stable internet connection and that the Evolution API service is operational.

Links and References


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

Discussion