Evolution API icon

Evolution API

Interact with Evolution API

Overview

The "Send Buttons" operation of the Message resource in this custom node allows sending interactive button messages through an Evolution API instance. This node is useful for automating communication workflows where recipients can interact with messages by clicking buttons, such as quick replies, copying codes, opening URLs, or initiating phone calls.

Practical examples include:

  • Sending a customer support message with buttons to quickly reply or call support.
  • Sharing promotional content with buttons linking to product pages.
  • Providing verification codes that users can copy with a single click.

Properties

Name Meaning
Instance Name The name of the Evolution API instance that will send the button message.
Recipient Number The phone number or identifier of the message recipient.
Title The main title text displayed on the button message.
Description A descriptive text providing more details about the button message.
Footer Optional footer text shown at the bottom of the message.
Buttons Up to 3 buttons to include in the message. Each button has:
- Type The type of button action. Options: Reply (send a predefined reply), Copy (copy a code), URL (open a link), Call (initiate a phone call).
- Button Text The visible label text on the button.
- ID Identifier for Reply type buttons.
- Copy Code The code to be copied for Copy type buttons.
- URL The web address to open for URL type buttons.
- Phone Number The phone number to call for Call type buttons.

Output

The node outputs a JSON array containing the response from the Evolution API after sending the button message. The exact structure depends on the API response but typically includes confirmation of message delivery status and any relevant metadata.

No binary data output is indicated.

Dependencies

  • Requires an active Evolution API instance configured with appropriate credentials (an API key or token).
  • The node expects the Evolution API base URL and authentication to be set up in the n8n credentials configuration.
  • No other external dependencies are evident from the static code.

Troubleshooting

  • Operation not supported error: If the selected operation or resource is not implemented, the node throws an error indicating unsupported operation. Ensure "Message" resource and "Send Buttons" operation are correctly selected.
  • Missing required properties: The node requires mandatory fields like Instance Name, Recipient Number, Title, Description, and at least one button with valid parameters. Missing these will cause errors.
  • Button configuration errors: Each button must have the correct fields filled based on its type (e.g., URL for URL buttons). Incorrect or missing fields may cause the API request to fail.
  • API authentication issues: Invalid or missing API credentials will prevent successful message sending.
  • Recipient format errors: The recipient number must be in the expected format accepted by the Evolution API.

Links and References

Discussion