Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Integration → Evolution Bot

AI-generated

Overview

This node interacts with the Evolution Bot integration within the Evolution API. It allows users to perform various operations related to Evolution Bots, such as creating, checking, updating, deleting bots, fetching sessions, and changing session statuses. This node is useful for automating and managing chatbot interactions and sessions programmatically.

Use Case Examples

  1. Create a new Evolution Bot with specific triggers and settings.
  2. Check the details of an existing Evolution Bot by its ID.
  3. Update the configuration of an Evolution Bot, including triggers and messages.
  4. Delete an Evolution Bot by its ID to stop its operation permanently.

Properties

Name Meaning
Instance Name The name of the instance that will send the message, required for identifying the sender instance.
What Do You Want To Do The specific operation to perform with the Evolution Bot integration, such as create, find, update, delete, fetch sessions, or change session status.
Evolution Bot ID The ID of the Evolution Bot to search for or modify; can be left empty to search for all bots.
Evolution Bot API URL The URL endpoint of the Evolution Bot API, required for creating or updating bots.
Evolution Bot ApiKey The API key for authenticating requests to the Evolution Bot API, required for creating or updating bots.
Trigger Type The type of trigger for the Evolution Bot, either a keyword or all messages.
Trigger Operator The operator used to evaluate the trigger keyword, such as contains, equals, starts with, ends with, or regex.
Trigger The word, phrase, or regex pattern used as a trigger to start the Evolution Bot.
Expires In (Minutes) The number of minutes without responses after which the bot should be deactivated.
Finish Keyword The word or phrase used to close the bot session.
Default Message Delay (In Milliseconds) The delay in milliseconds before the bot sends a message.
Unknown Message The message sent when the bot does not recognize the input.
Listen To Messages Sent By Me Whether the bot listens to messages sent by the user themselves.
Pause The Bot When I Send A Message Whether the bot pauses when the user sends a message.
Keep The Bot Session Open Whether to keep the bot session open after interactions.
Wait Time (In Seconds) The debounce time the bot waits to merge multiple messages into one after receiving a message.
Recipient Number The remoteJid (recipient identifier) for changing the session status.
Status The session status to set, such as opened, paused, or closed.
Ignored JIDs List of JIDs that the bot will ignore.
Operator Type The operator type for the trigger, including contains, equals, starts with, ends with, regex, or none.

Output

JSON

  • success - Indicates if the operation was successful.
  • data - Contains the response data from the Evolution Bot API, such as bot details or session information.

Dependencies

  • Evolution API endpoint URL
  • Evolution Bot API key credential

Troubleshooting

  • Ensure the Evolution Bot API URL and ApiKey are correctly set for create and update operations.
  • Verify that the Evolution Bot ID is provided when required for find, update, delete, fetch sessions, or change status operations.
  • Check network connectivity and API endpoint availability if requests fail.
  • Common errors include unsupported operations if the selected operation is not implemented, or authentication errors if the API key is invalid.

Links

Discussion