Evolution API icon

Evolution API

Interact with Evolution API

Overview

The "Send List" operation of the Message resource in this node allows sending a structured interactive list message to a specified recipient via an instance of a messaging service. This type of message typically contains a title, description, footer, button text, and multiple sections with selectable rows, enabling rich user interaction within chat platforms.

Common scenarios where this node is beneficial include:

  • Sending menu options or catalogs to users in customer support or sales bots.
  • Presenting multiple choices for user selection in automated workflows.
  • Delivering organized information lists such as FAQs, product categories, or event schedules.

For example, a business could send a list of available services with descriptions and unique IDs, allowing the user to select one directly from the chat interface.

Properties

Name Meaning
Instance Name The name of the messaging instance that will send the list message.
Recipient Number The phone number or identifier of the message recipient.
Title The main title of the list message.
Description A descriptive text explaining the list content.
Button Text The label text displayed on the list's action button (e.g., "View Options").
Footer Text Text shown at the bottom/footer of the list message.
Sections One or more sections containing rows; each section has a title and multiple rows representing selectable options.
- Section Title Title of a single section within the list.
- Rows Multiple rows inside a section, each with:
-- Row Title Title of the individual row option.
-- Row Description Optional description providing additional details about the row.
-- Row ID Unique identifier for the row option, used to identify the user's selection.
Options (Message) Additional message options including:
- Delay Milliseconds delay before sending the message (default 1200 ms).
- Reply Message Optionally specify a message ID to reply to (quoted message).
- Mentions Settings to mention participants:
-- Mention Everyone Boolean flag to mention all group participants.
-- Numbers To Mention Comma-separated list of specific numbers to mention if not mentioning everyone.

Output

The node outputs a JSON array where each item corresponds to the result of sending the list message. The exact structure depends on the underlying API response but generally includes confirmation details such as message ID, status, or error information.

If the messaging platform supports it, binary data output is not applicable here since this operation deals with structured text-based interactive messages.

Dependencies

  • Requires an active messaging instance configured with appropriate credentials (e.g., API key or authentication token).
  • The node interacts with the Evolution API endpoint for sending messages.
  • Proper configuration of the instance name and recipient number is mandatory.
  • Network connectivity to the Evolution API service is required.

Troubleshooting

  • Common Issues:

    • Missing or incorrect instance name or recipient number will cause failures.
    • Invalid or empty sections/rows may lead to errors or incomplete messages.
    • Delay values too low might cause rate limiting or message ordering issues.
    • Incorrect message ID in the reply option can cause the reply to fail.
  • Error Messages:

    • "Operation not supported." indicates the selected operation is not implemented or recognized.
    • API errors related to authentication usually mean invalid or missing credentials.
    • Validation errors may occur if required fields like title, description, or button text are empty.
  • Resolutions:

    • Verify all required properties are correctly filled.
    • Ensure the instance is properly authenticated and connected.
    • Check the format of phone numbers and IDs.
    • Use reasonable delay values to avoid API throttling.

Links and References

  • Evolution API Documentation (base URL referenced in the node)
  • Messaging platform documentation for interactive list messages (platform-specific, e.g., WhatsApp Business API)

Discussion