Evolution API

Interagir com a Evolution API v2

Overview

This node integrates with the Evolution API v2 to manage WhatsApp-related functionalities across multiple resources such as instances, messages, groups, chats, events, and integrations. Specifically for the Chat resource with the Gerenciar Arquivo (archiveChat) operation, it allows users to archive a chat within a specified WhatsApp instance.

Practical scenarios include automating chat management tasks in WhatsApp business workflows, such as archiving inactive or resolved conversations programmatically to keep the chat list organized.

Example use case: Automatically archive customer support chats after issue resolution to maintain a clean interface and improve workflow efficiency.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance where the chat is managed. This is required to identify which instance the chat belongs to.

Note: The provided input properties JSON only includes "Instance Name" relevant to this resource-operation combination.

Output

The node outputs a JSON object containing the result of the archive chat operation. The output structure typically includes:

  • success: A boolean indicating if the operation was successful.
  • message: A string message confirming the operation status (e.g., "Operation completed successfully").
  • timestamp: ISO string timestamp when the operation was performed.

If the API returns additional data, it will be merged into the output JSON. If the response is an array or stringified JSON, it attempts to parse and normalize it accordingly.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Evolution API.
  • The node uses HTTP requests to the Evolution API endpoints.
  • Proper configuration of the Evolution API credentials in n8n is necessary.
  • The user must provide the correct instance name corresponding to their WhatsApp instance.

Troubleshooting

  • Common issues:

    • Incorrect or missing instance name may cause the API call to fail.
    • Network or authentication errors if the API key is invalid or expired.
    • API endpoint changes or downtime on the Evolution API side.
  • Error messages:

    • Errors thrown by the node will contain the error message from the API or internal request failure.
    • To resolve, verify the instance name, check API credentials, and ensure network connectivity.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch processing.

Links and References

Discussion