Evolution API icon

Evolution API

Complete WhatsApp automation with Evolution API
Join our community

Actions48

Overview

This node integrates with the Evolution API to automate WhatsApp messaging tasks. Specifically, the Send Text operation under the Message resource allows users to send plain text messages to specified phone numbers via WhatsApp.

Common scenarios where this node is beneficial include:

  • Sending notifications or alerts to customers or team members.
  • Automating customer support responses.
  • Broadcasting updates or reminders to individual contacts.

For example, a business could use this node to automatically send appointment reminders to clients by specifying their phone numbers and the reminder message.

Properties

Name Meaning
Phone Number The recipient's phone number including country code, without the "+" sign (e.g., 5511999999999).
Message The text content of the message to be sent.
Additional Fields Optional settings:
• Delay: Time in milliseconds to wait before sending the message.
• Link Preview: Enable or disable link previews in the message.
• Quoted Message ID: ID of a message to quote or reply to.
• Mentions: Comma-separated list of phone numbers to mention in the message.

Output

The node outputs a JSON object representing the response from the Evolution API after attempting to send the text message. This typically includes details about the message status, any errors, or confirmation data returned by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "messageId": "string",
  "status": "sent",
  "timestamp": "2024-06-01T12:00:00Z",
  "recipient": "5511999999999"
}

Dependencies

  • Requires an active subscription and valid API key credentials for the Evolution API service.
  • Requires configuration of the Evolution API base URL, API key, and instance name within the node credentials.
  • Optionally uses another API validation service to verify subscription and API key validity before sending requests.

Troubleshooting

  • Invalid API Key or Subscription: If the node throws an error related to invalid subscription or API key, verify that the provided API credentials are correct and active.
  • Unknown Operation or Resource Errors: These indicate misconfiguration of the node parameters; ensure the resource is set to "Message" and operation to "Send Text".
  • Message Not Sent: Check if the phone number format is correct (country code included, no "+" sign) and that the recipient is reachable on WhatsApp.
  • Delays Not Working: If using the delay field, ensure the value is a non-negative integer representing milliseconds.
  • Link Preview Disabled Unexpectedly: Confirm the "Link Preview" boolean is set as intended; some links may not generate previews depending on WhatsApp limitations.

Links and References

Discussion