Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node allows sending an image message through a messaging API associated with an "Evolution API" instance. It is designed to send images either by URL or base64 data to a specified recipient number, optionally including a caption and additional message options such as delay before sending, replying to a specific message, or mentioning users in a group chat.

Common scenarios include:

  • Sending promotional images or product photos to customers.
  • Sharing event pictures or announcements in group chats.
  • Automating image-based notifications with optional replies or mentions.

Example: Automatically send a welcome image with a caption to a new user joining a group, mentioning them directly.

Properties

Name Meaning
Instance Name The name of the Evolution API instance that will send the image message.
Recipient Number The phone number or identifier of the message recipient.
Image The image to send, provided as a URL or base64 encoded string.
Caption Optional text to accompany the image message.
Options Additional settings for the message:
- Delay Time in milliseconds to wait before sending the message (default 1200 ms).
- Reply to Message ID of a message to which this image message should reply.
- Mentions Settings to mention participants in the message:
-- Mention Everyone Boolean flag to mention all participants in a group.
-- Numbers to Mention Comma-separated list of specific numbers to mention if not mentioning everyone.

Output

The node outputs a JSON array containing the response from the API after attempting to send the image message. This typically includes confirmation details such as message ID, status, or error information.

If the API supports it, binary data output is not indicated here; the node focuses on JSON responses related to message sending.

Dependencies

  • Requires an active Evolution API instance configured with appropriate credentials (e.g., an API key or token).
  • Network access to the Evolution API endpoint.
  • Proper configuration of the node's credentials within n8n to authenticate requests.

Troubleshooting

  • Common issues:

    • Invalid or missing recipient number causing message delivery failure.
    • Incorrect image URL or malformed base64 data leading to upload errors.
    • Insufficient permissions or invalid API credentials resulting in authentication errors.
    • Delay option misconfiguration causing unexpected timing behavior.
  • Error messages:

    • "Operation not supported": Indicates the selected operation or resource is not implemented; verify correct Resource and Operation selection.
    • API errors returned in the JSON response may indicate invalid parameters or server-side issues; check the message content and API documentation.
  • Resolutions:

    • Double-check recipient number format and ensure it matches expected standards.
    • Validate image URLs or base64 strings before sending.
    • Confirm API credentials are correctly set up and have necessary permissions.
    • Adjust delay values to reasonable intervals.

Links and References

Discussion