Evolution API AI Tool icon

Evolution API AI Tool

Use Evolution API for WhatsApp in AI agents

Overview

This node integrates with the Evolution API to send WhatsApp messages and perform related operations. It is particularly useful for automating WhatsApp communications such as sending text messages, media files, or retrieving QR codes for instance authentication. Practical applications include customer support messaging, marketing campaigns, and automated notifications via WhatsApp.

For the Send Text Message operation, the node sends a plain text message to a specified phone number through a configured WhatsApp instance.

Properties

Name Meaning
Instance The name of the WhatsApp instance to use for sending the message.
Phone Number The recipient's phone number including country code (e.g., 5511999999999).
Message The text content of the message to be sent.

Output

The output is a JSON array where each item corresponds to the response from the Evolution API after sending the message. The structure depends on the API response but generally includes confirmation details about the sent message.

No binary data output is produced by this operation.

Dependencies

  • Requires an external Evolution API service endpoint URL and an API key credential for authentication.
  • The node uses HTTP requests (via axios) to communicate with the Evolution API.
  • Proper configuration of the API credentials in n8n is necessary before using the node.

Troubleshooting

  • Common issues:
    • Invalid or missing API key or URL will cause authentication failures.
    • Incorrect phone number format may result in message delivery errors.
    • Unsupported operations will throw an error indicating the operation is not supported.
  • Error messages:
    • "The operation \"<operation>\" is not supported!" indicates an invalid operation parameter.
    • Network or API errors will return their respective messages; ensure the API endpoint is reachable and credentials are valid.
  • To resolve errors, verify the API credentials, check the phone number format, and confirm that the selected operation is supported.

Links and References

  • Evolution API official documentation (not provided here, please refer to your API provider)
  • WhatsApp Business API guidelines for message formatting and usage

Discussion