Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node, named "Evolution API," allows users to send interactive button messages through a messaging API. Specifically, the "Enviar Botões" (Send Buttons) operation under the "Mensagem" (Message) resource enables sending a message with up to three customizable buttons to a specified recipient number. This is useful for scenarios where you want to engage users interactively, such as customer support, marketing campaigns, or automated notifications that require user responses.

Practical examples include:

  • Sending a message with quick reply buttons for customer feedback.
  • Providing buttons to copy a code, open a URL, or initiate a phone call directly from the message.
  • Creating interactive menus or prompts within chat conversations.

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 to which the button message 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 can be one of the following types:
- Resposta (Reply): A button that sends a predefined reply ID when clicked.
- Copiar (Copy): A button that copies a specified code/text to the clipboard.
- URL: A button that opens a specified URL.
- Ligar (Call): A button that initiates a phone call to a specified number.

Each button requires specific fields depending on its type:

  • Reply: Texto Do Botão (button display text), ID (reply identifier).
  • Copy: Texto Do Botão, Código Para Copiar (code to copy).
  • URL: Texto Do Botão, URL.
  • Call: Texto Do Botão, Número De Telefone (phone number to call).

Output

The node outputs a JSON array containing the response from the API after attempting to send the button message. The exact structure depends on the API response but typically includes confirmation of message delivery status or error details if the operation failed.

No binary data output is indicated by the source code or properties.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API service.
  • The node expects the user to configure this credential within n8n.
  • The node uses HTTP requests with JSON payloads and expects JSON responses.
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Missing or incorrect instance name or recipient number may cause message sending failures.
    • Exceeding the maximum of 3 buttons will likely result in errors.
    • Providing incomplete button details (e.g., missing URL for a URL button) will cause validation errors.
    • Network or authentication errors if the API key is invalid or not configured properly.

  • Error messages:

    • "Operação não suportada." means the selected operation is not supported; ensure you select "Enviar Botões" under the correct resource.
    • API errors returned from the Evolution API will be passed through; check the API documentation for specific error codes and messages.

  • Resolution tips:

    • Double-check all required fields before execution.
    • Verify API credentials and network connectivity.
    • Ensure button configurations match their required fields based on type.

Links and References

Discussion