Evolution API icon

Evolution API

Interact with Evolution API

Overview

The node "Evolution API" allows users to interact with the Evolution API, specifically focusing on managing instance behavior settings. It is useful for automating configuration of instances such as controlling call rejection, message reading status, and synchronization preferences. Practical applications include setting up automated responses to calls, managing online presence, and configuring how message history is handled in an instance.

Properties

Name Meaning
Instance Name The name identifier for the instance being configured.
Reject Calls Boolean option to enable or disable automatic rejection of incoming calls.
Call Message Custom message sent automatically when calls are rejected.
Ignore Groups Boolean option to determine whether group mentions should be ignored or not.
Always Online Boolean option to keep the instance always online regardless of activity.
Read Messages Boolean option to mark messages as read automatically.
Sync Full History Boolean option to synchronize the full message history for the instance.
Read Status Boolean option to control whether read status notifications are enabled or disabled.

Output

The node outputs a JSON array containing the result of the executed operation related to instance behavior definition. This typically includes confirmation of updated settings or current configuration details of the instance. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The base URL for API requests is https://doc.evolution-api.com/api-reference.
  • The node expects JSON content type for requests and responses.
  • No additional environment variables or external services beyond the Evolution API are indicated.

Troubleshooting

  • Unsupported operation error: If the specified resource-operation combination is not supported, the node throws an error stating "Unsupported operation." Ensure that the resource is set to "instances-api" and the operation to "instance-settings" as per the provided properties.
  • Missing or invalid credentials: Since the node requires authentication, ensure that a valid API key credential is configured in n8n.
  • Invalid property values: Required fields like "Instance Name" must be provided; otherwise, the API may reject the request.
  • Network or API errors: Check connectivity and API availability if requests fail.

Links and References

Discussion