Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the resource Mensagem and operation Enviar Lista, it sends a structured list message to a specified recipient via the Evolution API. This is useful in scenarios where you want to present multiple selectable options to a user within a chat or messaging platform, such as customer support menus, product catalogs, or interactive surveys.

For example, a business could send a menu of services or products as a list message to customers, allowing them to select an option directly from the message interface.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the list message.
Número Do Destinatário The recipient's phone number or identifier to whom the list message will be sent.
Título Da Lista The main title of the list message, serving as the header or subject.
Descrição A description text providing additional context or information about the list.
Texto Do Botão The text displayed on the button that opens the list options (default: "Ver Opções").
Texto Do Rodapé Footer text shown at the bottom of the list message.
Seções One or more sections containing rows (options). Each section has:
- Título Da Seção: Section title.
- Linhas: Multiple rows, each with:
- Título: Title of the row (required).
- Descrição: Optional description.
- ID Da Linha: Unique ID for the option.
Opções (Options) Additional message options including:
- Delay: Milliseconds delay before sending the message (default 1200 ms).
- Responder Mensagem: Optionally reply to a specific message by its ID.
- Menções: Mentions settings:
- Mention all participants.
- Or specify numbers to mention separated by commas.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the list message. The exact structure depends on the API response but typically includes confirmation details such as message IDs, status, or error information.

If the API supports binary data (e.g., media attachments), this node does not explicitly handle binary output for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API endpoint and authentication to be configured properly in n8n credentials.
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Invalid or missing instance name or recipient number may cause the API call to fail.
    • Improperly formatted sections or rows (e.g., missing required titles or IDs) can result in errors.
    • Delay values that are too low might cause timing issues in message delivery.
    • Mentioning invalid or incorrectly formatted phone numbers may cause mention failures.

  • Error messages:

    • "Operação não suportada." indicates the selected operation is not implemented or recognized; ensure the correct resource and operation are chosen.
    • API errors returned from the Evolution API will be passed through; check the API documentation for error codes and meanings.

  • Resolution tips:

    • Double-check all required fields are filled correctly.
    • Validate phone numbers and IDs used in mentions and rows.
    • Increase delay if messages are sent too quickly causing rate limits or delivery issues.
    • Ensure the API key credential is valid and has necessary permissions.

Links and References

  • Evolution API official documentation (not provided here; consult your API provider)
  • n8n documentation on creating and using custom nodes: https://docs.n8n.io/integrations/creating-nodes/
  • General best practices for WhatsApp or messaging list messages (if applicable)

Discussion