Evolution API

Interagir com a Evolution API v2
Join our community

Actions53

Overview

This node integrates with the Evolution API v2 to manage WhatsApp-related functionalities, specifically for groups under the "Grupo" resource. The "Mensagens Temporárias" (Temporary Messages) operation allows toggling ephemeral messages in a WhatsApp group. This feature is useful when you want messages in a group to disappear automatically after a certain period, enhancing privacy and reducing chat clutter.

Practical scenarios include:

  • Managing group chats where sensitive information is shared temporarily.
  • Automatically cleaning up group conversations without manual intervention.
  • Enabling or disabling temporary messages based on group policies or events.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance to use for the operation.
Group ID The unique identifier of the WhatsApp group where temporary messages will be toggled.

Output

The node outputs a JSON object containing the result of the toggle ephemeral messages operation. The output includes:

  • success: A boolean indicating if the operation was successful.
  • message (optional): A confirmation message if no detailed response is returned.
  • timestamp: The ISO string timestamp when the operation was performed.
  • Additional fields may be present depending on the API response.

No binary data output is involved in this operation.

Example output structure:

{
  "success": true,
  "message": "Operation completed successfully",
  "timestamp": "2024-06-01T12:00:00.000Z"
}

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Evolution API.
  • The node uses HTTP requests to the Evolution API endpoints.
  • Proper configuration of the WhatsApp instance within the Evolution platform is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing Instance Name or Group ID parameters.
    • Authentication failures due to incorrect or expired API credentials.
    • Network connectivity issues preventing access to the Evolution API.
    • Insufficient permissions on the WhatsApp instance to modify group settings.

  • Error Messages:

    • Errors from the API are caught and returned as error messages in the output.
    • If the node fails due to an exception and "Continue On Fail" is disabled, the workflow execution stops.
    • To resolve errors, verify input parameters, check API credentials, and ensure the WhatsApp instance is active and connected.

Links and References

Discussion