Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node provides functionality to send a video message through the Evolution API messaging service. It allows users to specify the instance sending the message, the recipient's number, and the video content either as a URL or base64 string. Additional options such as adding a caption, delaying the message, replying to a specific message, and mentioning participants in a group chat are supported.

This node is beneficial in scenarios where automated video messages need to be sent programmatically, for example:

  • Customer support bots sending tutorial videos.
  • Marketing campaigns delivering promotional videos.
  • Group notifications with mentions and replies to specific messages.

Properties

Name Meaning
Instance Name The name of the instance that will send the video message.
Recipient Number The phone number or identifier of the message recipient.
Video The video content to send, provided as a URL or a base64 encoded string.
Caption Optional text to accompany the video message.
Options Collection of additional settings:
- Delay Time in milliseconds to wait before sending the message (default 1200 ms).
- Reply to Message ID of an existing message to which this video message will reply.
- Mentions Settings to mention participants in a group:
-- Mention Everyone Boolean flag to mention all participants in the 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 Evolution API after attempting to send the video message. This typically includes metadata about the sent message such as message ID, status, timestamps, or error information if the operation failed.

If the node supports binary data output (not explicitly shown here), it would represent the video or related media content; however, based on the provided code and properties, the output focuses on JSON metadata.

Dependencies

  • Requires an active Evolution API credential configured in n8n to authenticate requests.
  • Depends on the Evolution API service endpoint https://doc.evolution-api.com/api-reference.
  • The node uses internal helper functions mapped by resource and operation names to execute the correct API call.

Troubleshooting

  • Unsupported operation error: If the node throws "Unsupported operation" it means the requested resource-operation combination is not implemented. Verify that "Message" resource and "Send Video" operation are correctly selected.
  • Missing required parameters: Ensure that "Instance Name", "Recipient Number", and "Video" fields are filled as they are mandatory.
  • Invalid video format: The video must be a valid URL or properly base64 encoded string. Invalid formats may cause API errors.
  • API authentication failures: Confirm that the API key or credentials are correctly set up in n8n.
  • Delays not respected: The delay option is client-side; ensure the node execution environment respects asynchronous waits.

Links and References

Discussion