Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The node "Evolution API" allows sending a list message through the Evolution messaging API. Specifically, the "Send List" operation under the "Message" resource enables users to send interactive list messages to recipients. This is useful in scenarios where you want to present multiple selectable options within a single message, such as menus, surveys, or choice prompts.

Practical examples include:

  • Sending a product catalog with categories and items for customers to select.
  • Presenting a menu of services or support topics in a customer service chatbot.
  • Offering event options or polls where users can pick from predefined choices.

Properties

Name Meaning
Instance Name The name of the instance that will send the list message.
Recipient Number The phone number or identifier of the recipient who will receive the list message.
List Title The main title displayed at the top of the list message.
Description A description providing additional context or information about the list.
Button Text The text shown on the button that opens the list options (default: "View Options").
Footer Text Text displayed at the bottom/footer of the list message.
Sections One or more sections containing rows (options). Each section has:
- Section Title Title of the section grouping related rows.
- Rows Multiple rows within the section, each with:
-- Title Title of the individual row/option.
-- Description Optional description for the row.
-- Row ID Unique identifier for the option, used internally to identify the selected choice.
Options Additional message options including:
- Delay Delay in milliseconds before sending the message (default 1200 ms).
- Reply to Message Optionally reply to a specific message by its ID.
- Mentions Settings to mention participants: either mention everyone or specify a comma-separated list of numbers to mention.

Output

The node outputs a JSON array containing the response from the Evolution API after sending 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 node supports binary data output (not indicated here), it would represent any media or attachments sent alongside the message, but this operation focuses on structured list messages only.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for the API is https://doc.evolution-api.com/api-reference.
  • No other external dependencies are indicated.

Troubleshooting

  • Unsupported operation error: If the node throws an error stating the operation is unsupported, verify that the "Send List" operation is correctly selected under the "Message" resource.
  • Missing required fields: Ensure all required properties like Instance Name, Recipient Number, List Title, Description, Button Text, Footer Text, and at least one section with rows are provided.
  • Invalid recipient number: The recipient number must be in the correct format expected by the Evolution API; otherwise, the message may fail to send.
  • API authentication errors: Check that the API key or token credential is valid and has necessary permissions.
  • Delay not respected: The delay property controls how long the node waits before sending; if timing issues occur, verify the delay value is set appropriately.
  • Mention settings misconfiguration: When using mentions, ensure the "Mention Everyone" flag or the list of numbers to mention is correctly set to avoid unexpected behavior.

Links and References

Discussion