Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the resource "Mensagem" and operation "Enviar Botões," it sends a message containing interactive buttons to a specified recipient via an instance of the Evolution messaging platform.

Common scenarios include:

  • Sending interactive messages in customer support or sales automation workflows.
  • Delivering quick reply options or call-to-action buttons to users on messaging platforms.
  • Automating notifications that require user interaction, such as confirmations or menu selections.

For example, you can send a message titled "Choose an option" with buttons like "Reply," "Copy code," "Visit URL," or "Call number," enabling recipients to respond quickly or take immediate action.

Properties

Name Meaning
Nome Da Instância The name of the Evolution API instance that will send the buttons message.
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 message containing buttons.
Descrição The description text of the message containing buttons.
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): One of Reply, Copy, URL, or Call
- Texto Do Botão (Display Text): The label shown on the button
- ID: Required if type is Reply; unique identifier for the reply button
- Código Para Copiar (Copy Code): Required if type is Copy; the text/code to copy to clipboard
- URL: Required if type is URL; the web address to open when clicked
- Número De Telefone (Phone Number): Required if type is Call; the phone number to dial

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 about the sent message.

If the API supports binary data (e.g., media attachments), it would be included accordingly, but this operation focuses on sending button messages and primarily returns JSON data.

Dependencies

  • Requires an active Evolution API instance configured with appropriate credentials (an API key or token).
  • The node expects the Evolution API service to be reachable and properly authenticated.
  • No additional external dependencies are indicated beyond the Evolution API itself.

Troubleshooting

  • Operation Not Supported Error: If you select an unsupported operation or resource, the node throws an error stating the operation is not supported. Ensure you use valid combinations of resource and operation.
  • Missing Required Fields: The node requires certain fields like instance name, recipient number, title, description, and button details. Omitting these will cause errors.
  • Button Configuration Errors: Each button type requires specific properties (e.g., "id" for reply buttons). Incorrect or missing button parameters may lead to failures.
  • API Authentication Issues: Invalid or missing API credentials will prevent successful requests. Verify your API key/token configuration.
  • Recipient Format: Ensure the recipient number is in the correct format expected by the Evolution API.

Links and References

Discussion