Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node integrates with the Evolution API to send image messages. Specifically, for the "Mensagem" resource and the "Enviar Imagem" operation, it allows users to send an image (via URL or base64) to a specified recipient number through a chosen instance. This is useful in scenarios such as automated customer support, marketing campaigns, or notifications where images need to be sent programmatically.

Practical examples:

  • Sending product images to customers after they place an order.
  • Sharing event flyers or promotional banners automatically in group chats.
  • Responding with screenshots or visual information in chatbots.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message.
Número Do Destinatário The recipient's phone number in the format expected by the API.
Imagem The image to send, provided either as a URL or a base64 encoded string.
Caption Optional text caption to accompany the image.
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 flag to mention all participants in a group chat.
-- Números Para Mencionar Comma-separated list of phone numbers to mention individually (used if not mentioning everyone).

Output

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

If the node supports binary data output (not indicated here), it would represent media content or attachments related to the message.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the user to configure this credential in n8n beforehand.
  • Network access to the Evolution API endpoint (https://doc.evolution-api.com/api-reference) is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing instance name or recipient number can cause message sending failures.
    • Incorrect image URL or malformed base64 data may result in errors or no image being sent.
    • Delay values too low might cause rate limiting or unexpected behavior.
    • Mention settings must be consistent; e.g., specifying both "mention all" and individual mentions incorrectly could cause issues.
  • Error messages:

    • "Operação não suportada." indicates the selected operation-resource combination is not implemented.
    • API errors returned from Evolution API will be passed through; check the message for authentication errors, invalid parameters, or quota limits.
  • Resolutions:

    • Verify all required fields are correctly filled.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Validate image URLs or base64 strings before sending.
    • Adjust delay timing if encountering rate limits.

Links and References

Discussion