Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The node enables sending a document message through the Evolution API messaging service. It is designed to send documents such as PDFs or other file types to a specified recipient number, optionally including a caption and additional message options like delay, reply-to message, and mentions.

This node is useful in scenarios where automated document sharing is required, for example:

  • Sending invoices or contracts automatically to clients.
  • Sharing reports or manuals with team members.
  • Distributing certificates or tickets via chat.

Properties

Name Meaning
Instance Name The name of the instance that will send the document.
Recipient Number The phone number or identifier of the message recipient.
Document URL or base64 string representing the document to be sent.
Message Optional text caption to accompany the document.
File Name The filename to assign to the document being sent (default: "document.pdf").
Options Additional message options:
- Delay Milliseconds to wait before sending the message (default 1200 ms).
- Reply Message ID of a message to which this document message will reply.
- Mentions Settings to mention participants: either mention everyone or specify comma-separated numbers to mention.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to send the document message. This typically includes status information about the message delivery.

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

Dependencies

  • Requires an active Evolution API credential configured in n8n for authentication.
  • Depends on the Evolution API endpoint https://doc.evolution-api.com/api-reference.
  • The node uses standard HTTP headers for JSON communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Operation not supported error: If the selected operation or resource is not implemented, the node throws an error indicating unsupported operation. Ensure the correct Resource ("messages-api") and Operation ("send-document") are selected.
  • Invalid recipient number: Sending to an incorrectly formatted or non-existent number may cause API errors. Verify the recipient number format.
  • Document URL/base64 issues: If the document property is invalid or inaccessible, the message will fail. Confirm the document source is reachable and correctly encoded.
  • Missing required fields: Instance Name, Recipient Number, and Document are mandatory. Omitting these will prevent execution.
  • Delay misconfiguration: Setting an excessively high delay might cause unexpected timing behavior.

Links and References

Discussion