Evolution API icon

Evolution API

Interact with Evolution API

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 through a messaging platform. This is useful in scenarios where you want to present recipients with a menu or options in a conversational interface, such as customer support bots, interactive marketing campaigns, or automated notifications that require user selection.

For example, a business could send a product catalog as a list message, allowing customers to select items directly from the chat 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 label 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 within the list, each containing multiple rows (options). Each section has:
- Título Da Seção: Section title.
- Linhas: Rows inside the section, each with:
  • Título (required): Row title
  • Descrição (optional): Row description
  • ID Da Linha: Unique ID for the option.
Opções (Options) Additional message options including:
- Delay: Time in milliseconds to wait before sending the message (default 1200 ms).
- Responder Mensagem: Optionally reply to a specific message by its ID.
- Menções: Mentions settings, either mention all participants or specific numbers 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, timestamps, or error messages if any.

If the API supports binary data (e.g., media attachments), this would be included accordingly, but for this operation, the output focuses on JSON metadata about the sent list message.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API base URL and headers to be configured internally.
  • No other external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Missing required fields such as instance name, recipient number, or list title will cause errors.
    • Incorrect formatting of phone numbers in mentions may lead to failed mentions.
    • Sending a list with empty sections or rows might result in API rejection.
    • Delay values that are too low might cause timing issues in message delivery.

  • Error Messages:

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

  • Resolutions:

    • Ensure all required properties are filled correctly.
    • Validate phone numbers and IDs used in mentions and replies.
    • Use reasonable delay values to avoid race conditions.
    • Confirm the Evolution API credentials are valid and have necessary permissions.

Links and References

Discussion