Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

The node "Evolution API" allows users to interact with the Evolution API service, specifically enabling sending text messages through it. The "Enviar Texto" (Send Text) operation under the "Mensagem" (Message) resource is designed to send a plain text message to a specified recipient number. This node is useful in scenarios where automated messaging is required, such as customer notifications, alerts, or chatbots that need to send text messages programmatically.

Practical examples include:

  • Sending appointment reminders to clients.
  • Notifying users about status updates.
  • Responding automatically to incoming queries with predefined text messages.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
Numero Do Destinatario The recipient's remote JID (unique identifier for the destination). Required.
Mensagem The text message content to be sent. Required.
Opções Additional options for sending the message:
- Delay Number of milliseconds to wait before sending the message (default 1200 ms).
- Responder Mensagem Option to reply to a specific message by providing its message ID.
- Menções Settings for mentions within the message:
-- Mencionar Todos Boolean to mention all participants in a group.
-- Números Para Mencionar Comma-separated list of numbers to mention individually (only if not mentioning all).
- Preview De Link Boolean to enable or disable link preview in the message (default enabled).

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the message. The exact structure depends on the API response but typically includes confirmation details such as message ID, status, timestamps, or error information if the sending failed.

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 text only.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API service.
  • The node expects the Evolution API endpoint to be reachable and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common Issues:

    • Invalid or missing recipient number (remoteJid) will cause the message sending to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity issues can prevent communication with the Evolution API.
    • Providing an invalid message ID when replying to a message may cause errors.

  • Error Messages:

    • "Operação não suportada." indicates that the requested operation is not supported for the selected resource; ensure you select "Enviar Texto" under "Mensagem".
    • Authentication failures usually return HTTP 401 or 403 errors; verify your API key.
    • Validation errors from the API might indicate missing required fields like remoteJid or messageText.

Links and References

  • Evolution API official documentation (link not provided in source).
  • n8n documentation on creating custom nodes and handling API integrations.

Discussion