Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to send a list message through the Evolution API messaging service. The "Send List" operation under the "Message" resource enables sending interactive list messages to specified recipients. Such list messages are useful in scenarios where you want to present multiple selectable options to a user within a chat interface, for example:

  • Customer support bots offering predefined help topics.
  • Marketing campaigns presenting product categories.
  • Surveys or polls with multiple choices.

The node supports detailed customization of the list message, including title, description, footer text, button text, and multiple sections with rows representing selectable options.

Properties

Name Meaning
Name 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.
Descrição Description text providing more details about the list message.
Texto Do Botão Text displayed on the button that opens the list options (default is "Ver Opções").
Texto Do Rodapé Footer text shown at the bottom of the list message.
Seções One or more sections in the list, each containing:
- 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_message) Additional options for sending the message:
- Delay: Number of milliseconds to wait before sending the message (default 1200 ms).
- Reply to Message: Optionally reply to a specific message by its ID.
- Menções: Mentions settings:
- Mention Everyone: Boolean to mention all group participants.
- Números Para Mencionar: Comma-separated numbers to mention individually.

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 of message delivery status, message IDs, timestamps, or error information if sending failed.

No binary data output is indicated.

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 API credential in n8n is necessary.
  • The node expects the Evolution API to support sending list messages as per the documented properties.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect recipient number format may result in message delivery errors.
    • Missing required fields like instance name, recipient number, title, description, button text, footer text, or section titles/rows can cause validation errors.
    • Delay values too low might cause timing issues; ensure reasonable delay if used.
    • Replying to a non-existent message ID may cause errors.
  • Error Messages:

    • "Operação não suportada." indicates the requested operation is not supported for the selected resource.
    • API errors returned from Evolution API will be passed through; check the error message for details.
  • Resolutions:

    • Verify all required fields are filled correctly.
    • Confirm API credentials are valid and have necessary permissions.
    • Ensure recipient numbers are in correct international format.
    • Use the delay option to avoid rate limiting or timing conflicts.
    • Check message IDs when using the reply feature.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion