Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows interaction with the Evolution API service. Specifically, for the Resource "Message" and Operation "Send Document," it sends a document file to a specified recipient via the configured instance of the Evolution API.

This node is useful in scenarios where automated sending of documents (such as PDFs, images, or other files) is required through messaging platforms supported by the Evolution API. For example, businesses can automate sending invoices, contracts, or reports directly to customers or team members.

Properties

Name Meaning
Name 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 to send, provided as a URL or base64 string.
Mensagem Optional text message to accompany the document.
Name 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).
- Reply to Message Optionally reply to a specific message by providing its Message ID.
- Menções Mention settings:
-- Mention Everyone Whether to mention all participants in a group.
-- Números Para Mencionar Specific numbers to mention, separated by commas (e.g., "5511999999999,5511888888888").

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the document. This typically includes information about the success or failure of the operation, message IDs, timestamps, or error details if any.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API endpoint to be reachable at https://doc.evolution-api.com/api-reference.
  • Proper configuration of the API credentials within n8n is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect instance name or recipient number may result in message delivery errors.
    • Improperly formatted document URLs or base64 strings can cause upload failures.
    • Delay values too low might cause rate limiting or throttling issues.
  • Error Messages:

    • "Operação não suportada." indicates the requested operation is not implemented for the selected resource.
    • Network or API errors will typically return standard HTTP error messages; ensure network connectivity and valid API keys.
  • Resolutions:

    • Verify API credentials and permissions.
    • Double-check input parameters for correctness.
    • Ensure the document source (URL/base64) is accessible and correctly formatted.
    • Adjust delay settings if encountering rate limits.

Links and References

Discussion