Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," allows users to interact with the Evolution API service. Specifically, for the resource "Mensagem" and operation "Enviar Video," it enables sending a video message to a specified recipient via the API. This is useful in scenarios where automated or programmatic video messaging is needed, such as customer support follow-ups, marketing campaigns, or notifications that require rich media content.

For example, a user can configure this node to send a promotional video to a list of customers or reply to a specific message in a chat by referencing its ID.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the video.
Número Do Destinatário The recipient's phone number or identifier to whom the video will be sent.
Video The video content to send, provided as a URL or base64 encoded string.
Caption Optional text caption to accompany the video message.
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 to mention participants in the message:
-- Mencionar Todos Boolean flag to mention all participants in a group.
-- Números Para Mencionar Comma-separated list of phone numbers to mention individually 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. The exact structure depends on the API response but typically includes confirmation details such as message ID, status, timestamps, or error information.

If the API supports binary data responses, this node does not explicitly handle binary output; it focuses on JSON responses.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • Network access to the Evolution API endpoint (https://doc.evolution-api.com/api-reference).

Troubleshooting

  • Common Issues:

    • Invalid or missing instance name or recipient number will cause the API call to fail.
    • Incorrect video URL or malformed base64 string may result in upload errors.
    • Mentioning invalid phone numbers or message IDs might cause the message to be rejected.
    • Delay values that are too low or too high could affect message timing unexpectedly.
  • Error Messages:

    • "Operação não suportada." indicates the selected operation is not implemented for the chosen resource.
    • API errors returned from the Evolution API will be passed through; check the API documentation for specific error codes.
  • Resolutions:

    • Verify all required fields are correctly filled.
    • Ensure the API key credential is valid and has necessary permissions.
    • Validate video URLs or base64 strings before sending.
    • Use correct message IDs when replying to messages.
    • Adjust delay settings as needed.

Links and References

Discussion