Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

The node "Evolution API" provides an interface to interact with the Evolution API, specifically supporting operations on various resources. For the resource Mensagem and operation Enviar Documento, this node sends a document message to a specified recipient via the Evolution API. This is useful in scenarios where automated sending of documents (such as PDFs, images, or other files) is required within messaging workflows.

Practical examples include:

  • Sending invoices or contracts automatically to clients.
  • Distributing reports or documentation to team members.
  • Sharing media files as part of customer support or notification systems.

Properties

Name Meaning
Nome Da Instância The name of the instance that will send the document.
Número Do Destinatário The recipient's number or identifier to whom the document will be sent.
Documento The document content, provided as a URL or base64 string.
Mensagem Optional text message to accompany the document.
Nome Do Arquivo The filename for the document being sent (default: "document.pdf").
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 to mention participants in the message:
-- Mencionar Todos Boolean to mention all participants in a group.
-- Números Para Mencionar Comma-separated list of numbers to mention individually (if not mentioning all).

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the document message. The structure typically includes confirmation details such as message IDs, status, or error information returned by the API.

If the API supports binary data output (e.g., returning the sent document or media), it would be included accordingly, but based on the provided code and properties, the primary output is JSON metadata about the sent message.

Dependencies

  • Requires an API key credential configured in n8n to authenticate with the Evolution API.
  • The node depends on the Evolution API service being accessible and properly configured.
  • Network access to the URLs provided for documents (if using URL instead of base64) must be available.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect recipient number format may result in delivery errors.
    • Providing an invalid document URL or malformed base64 string can cause the API to reject the message.
    • Delay values too low might cause rate limiting or message ordering issues.

  • Error Messages:

    • "Operação não suportada." indicates the requested operation is not implemented for the selected resource.
    • API errors related to message sending will usually include descriptive messages from the Evolution API; check those for guidance.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure recipient numbers are correctly formatted.
    • Validate document URLs or base64 strings before sending.
    • Adjust delay settings if encountering rate limits.

Links and References

Discussion