Evolution API icon

Evolution API

Interact with Evolution API

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.
  • Automating customer support responses via text.

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 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 (used 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.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API service.
  • The node expects proper configuration of this API authentication within n8n credentials.
  • Network access to the Evolution API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing recipient number (remoteJid) will cause the message sending to fail.
    • Incorrect or missing API authentication will result in authorization errors.
    • Providing an invalid message ID when replying to a message may cause errors.
    • Network connectivity issues can prevent successful API calls.
  • Error Messages:

    • "Operação não suportada." indicates that the selected operation is not implemented or recognized.
    • API errors returned from the Evolution API will be passed through; check the message and description fields for details.
  • Resolutions:

    • Verify all required fields are correctly filled.
    • Ensure the API key credential is valid and has necessary permissions.
    • Confirm network connectivity and API endpoint availability.
    • Double-check message IDs used for replies exist and are correct.

Links and References

Discussion