Evolution API

Interagir com a Evolution API v2

Overview

This node integrates with the Evolution API v2 to send various types of WhatsApp messages and manage instances, groups, chats, events, and integrations. Specifically, for the Mensagem (Message) resource and the Enviar Status (Send Status) operation, it allows sending a status update message to a specified recipient number through a named instance.

Common scenarios where this node is beneficial include automating WhatsApp communications such as sending status updates, notifications, or alerts to users. For example, a business can use it to automatically send order status updates or service notifications to customers via WhatsApp.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance to use for sending the status message. This identifies which configured WhatsApp session will send the message.
Number The recipient's phone number to which the status message will be sent.

Output

The output JSON contains the response from the Evolution API after attempting to send the status message. It typically includes:

  • success: A boolean indicating if the operation was successful.
  • message: A confirmation or informational message about the operation.
  • timestamp: The ISO string timestamp when the operation was performed.
  • Additional fields may be present depending on the API response.

If the API returns an array or stringified JSON, the node attempts to parse it accordingly and returns structured data.

The node does not output binary data for this operation.

Dependencies

  • Requires an active connection to the Evolution API v2.
  • Needs an API authentication token or API key credential configured in n8n to authorize requests.
  • The "Instance Name" must correspond to a valid and connected WhatsApp instance managed by the Evolution API.

Troubleshooting

  • Common Issues:

    • Invalid or missing instance name: Ensure the instance name provided matches a configured and connected WhatsApp instance.
    • Incorrect recipient number format: The number should be in the correct international format without extra characters.
    • Authentication errors: Verify that the API key or token credential is correctly set up and has necessary permissions.
    • Network or API downtime: Check connectivity and Evolution API service status.
  • Error Messages:

    • Errors returned from the API are captured and included in the output under an error field if "Continue On Fail" is enabled.
    • Common error messages might indicate invalid parameters, unauthorized access, or instance not found.
    • To resolve, verify input parameters, credentials, and instance status.

Links and References

Discussion