Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node allows you to send a structured "list message" via the Evolution API, typically used for WhatsApp-like messaging platforms. The "Enviar Lista" (Send List) operation under the "Mensagem" (Message) resource enables sending interactive lists to recipients, which can be useful for presenting options, menus, or surveys in chatbots and automated customer service scenarios.

Practical examples:

  • Sending a menu of services to a customer in a WhatsApp group.
  • Allowing users to select from a list of support topics.
  • Presenting multiple choices for booking, ordering, or feedback collection.

Properties

Below are the input properties supported by this operation:

Display Name Type Description
Nome Da Instância string The name of the instance that will send the list. Required.
Número Do Destinatário string The recipient's number (JID format). Required.
Título Da Lista string Main title of the list. Required.
Descrição string Description of the list. Required.
Texto Do Botão string Text displayed on the list button. Default: "Ver Opções". Required.
Texto Do Rodapé string Footer text shown at the bottom of the list. Required.
Seções fixedCollection One or more sections, each with a title and rows (options). Each row has a title, optional description, and unique ID. Multiple sections/rows allowed.
Opções collection Additional options:
- Delay number Milliseconds to wait before sending the message. Default: 1200.
- Responder Mensagem fixedCollection Optionally reply to a specific message by its ID.
- Menções fixedCollection Mention all participants or specify numbers to mention (comma-separated).

Output

The output is a JSON array containing the result of the send-list operation. The structure typically includes:

[
  {
    "status": "success",
    "messageId": "string",      // Unique identifier of the sent message
    "timestamp": "number",      // Time when the message was sent
    "to": "string",             // Recipient JID
    "instanceName": "string",   // Instance used to send the message
    // ...other fields as returned by the Evolution API
  }
]

Note: The exact fields may vary depending on the Evolution API response.

Dependencies

  • External Service: Requires access to the Evolution API.
  • API Key/Credentials: You must configure valid credentials for the "evolutionApi" in n8n.
  • n8n Configuration: Ensure the node is properly authenticated and the base URL is accessible.

Troubleshooting

Common issues:

  • Missing or invalid credentials: Ensure your Evolution API credentials are correctly set up in n8n.
  • Unsupported operation/resource: If you see an error like Opera\xE7\xE3o n\xE3o suportada. ("Operation not supported"), check that you selected a valid combination of Resource and Operation.
  • Invalid recipient number: Make sure the recipient's number is in the correct JID format.
  • Malformed sections/rows: Ensure each section and row has required fields (titles, IDs).

Error messages:

  • "Opera\xE7\xE3o n\xE3o suportada."
    Resolution: Double-check the selected operation and resource; only supported combinations are allowed.

Links and References

Discussion