Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows interaction with the Evolution API service. Specifically, for the Message resource and Send Audio operation, it sends an audio message to a specified recipient number via a chosen instance of the Evolution API.

This node is useful in scenarios where automated audio messages need to be sent programmatically, such as:

  • Sending voice alerts or notifications to customers.
  • Delivering pre-recorded audio messages for marketing campaigns.
  • Automating customer support calls with audio instructions.

Example: Automatically send a welcome audio message to new users after registration by specifying the recipient's phone number and the audio file URL.

Properties

Name Meaning
Instance Name The name of the Evolution API instance that will send the audio message.
Recipient Number The phone number of the message recipient in the required format (e.g., international).
Audio The audio content to send, provided as a URL or base64 encoded string.
Options Additional options for sending the message:
- Delay Time in milliseconds to wait before sending the audio message (default is 1200 ms).

Output

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

If the node supports binary data output (not explicitly shown in the code), it would represent any media or attachments related to the message, but here the focus is on JSON responses.

Dependencies

  • Requires an active Evolution API account and a configured API authentication token (API key or similar) set up in n8n credentials.
  • The node depends on the Evolution API endpoint at https://doc.evolution-api.com/api-reference.
  • Proper network access to the Evolution API service is necessary.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource, the node throws an error indicating the function is not supported. Ensure the resource is "messages-api" and operation is "send-audio".
  • Invalid or missing parameters: Required fields like Instance Name, Recipient Number, and Audio must be correctly filled; otherwise, the API call will fail.
  • Authentication errors: Make sure the API credential is valid and has permissions to send messages.
  • Network issues: Verify connectivity to the Evolution API endpoint.
  • Delay option misuse: Setting an excessively high delay may cause unexpected behavior or timeouts.

Links and References

Discussion