Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node integrates with the Evolution API to send interactive button messages via a messaging platform. Specifically, the "Enviar Botões" (Send Buttons) operation under the "Mensagem" (Message) resource allows users to send messages containing up to three customizable buttons to a specified recipient.

Common scenarios for this node include:

  • Sending customer support options where users can quickly reply or take actions.
  • Marketing campaigns that prompt recipients to visit URLs, call a number, or copy codes.
  • Automating responses with predefined quick-reply buttons to streamline communication.

For example, a business could send a message titled "Choose an option" with buttons like "Contact Support", "Visit Website", and "Copy Discount Code" to engage customers interactively.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the buttons.
Número Do Destinatário The recipient's phone number or identifier to whom the message with buttons will be sent.
Título The title text of the button message.
Descrição The description text of the button message.
Rodapé Optional footer text displayed at the bottom of the message.
Botões Up to 3 buttons to include in the message. Each button has:
- Tipo (Type): The type of button, options are: Reply (quick reply), Copy (copy code), URL, Call.
- Texto Do Botão (Display Text): The label shown on the button.
- ID (for Reply type): Identifier for the reply button.
- Código Para Copiar (Copy Code) (for Copy type): The code/text to copy when button is pressed.
- URL (for URL type): The link to open when button is clicked.
- Número De Telefone (Phone Number) (for Call type): The phone number to call when pressed.

Output

The node outputs a JSON array where each item corresponds to the result of sending the button message. The exact structure depends on the Evolution API response but generally includes confirmation details such as message ID, status, or error information.

If the node supports binary data output (not explicitly shown here), it would typically represent media attachments or message receipts, but this operation focuses on JSON message sending results.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node uses the base URL https://doc.evolution-api.com/api-reference for API requests.
  • Proper configuration of the instance name and recipient number is necessary.
  • No additional external dependencies beyond the Evolution API and n8n environment.

Troubleshooting

  • Operation Not Supported Error: If the selected operation or resource is not supported, the node throws an error indicating the function is unavailable. Ensure you select the correct resource ("messages-api") and operation ("send-buttons").
  • Missing Required Fields: Errors may occur if required properties like instance name, recipient number, title, description, or button details are missing or invalid. Double-check all required inputs.
  • API Authentication Failures: If the API key credential is incorrect or expired, authentication errors will occur. Verify the API key and permissions.
  • Button Limit Exceeded: Only up to 3 buttons are allowed; adding more may cause errors.
  • Invalid Button Configuration: Each button type requires specific fields (e.g., URL for URL type). Omitting these will likely cause request failures.

Links and References

Discussion