Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key

Actions64

Overview

The node "Evolution API Direct" provides integration with the Evolution API, allowing users to perform various operations by specifying a resource and an operation. Specifically for the Resource Integração and Operation Flowise, it enables managing Flowise bots through direct API calls. This includes creating, updating, deleting, finding Flowise bots, managing their sessions, and changing session statuses.

Typical use cases include automating chatbot management workflows, such as:

  • Creating new Flowise bots with specific triggers and behaviors.
  • Querying existing bots or sessions to monitor activity.
  • Updating bot configurations dynamically.
  • Controlling session states (open, paused, closed) programmatically.

For example, a user could automate the deployment of a new chatbot instance with custom trigger keywords and expiration settings, or pause a bot session when needed.

Properties

Name Meaning
Server URL The full URL of your Evolution API server. Example: https://api.exemplo.com.
API Key The API key credential for authenticating with your Evolution API instance or global account.
Nome Da Instancia The name of the instance that will send messages.
O Que Deseja Fazer The action to perform on the Flowise integration. Options: Add Flowise, Verify Flowise, Update Flowise, Delete Flowise, Search Session in Flowise, Change Session Status in Flowise.
ID Do Flowise The ID of the Flowise bot to find, update, delete, or manage sessions for. Leave empty to target all.
Url Do Flowise The URL of your Flowise bot API. Required for creating or updating a Flowise bot.
ApiKey Do Flowise The API key for your Flowise bot. Required for creating or updating a Flowise bot.
Tipo De Gatilho Trigger type for the Flowise bot. Options: Keyword, All.
Operador Do Gatilho Operator for the trigger keyword matching. Options: Contains, Equals, Starts With, Ends With, Regex.
Gatilho The keyword, phrase, or regex pattern used as a trigger to start the Flowise bot.
Expira Em (Minutos) Number of minutes without responses after which the bot should be deactivated.
Palavra Chave De Finalização The keyword or phrase used to close the bot session. Default is #sair.
Delay Padrão Da Mensagem (Em Milésimos) The default delay in milliseconds before the bot sends a message.
Palavra Chave De Finalização (unknownMessage) Message or phrase shown when the bot does not recognize the input.
Escuta Mensagens Enviadas Por Mim Boolean flag indicating whether the bot listens to messages sent by the user themselves.
Pausa O Bot Quando Eu Enviar Uma Mensagem Boolean flag indicating whether the bot pauses when the user sends a message.
Mantem a Sessão Do Bot Aberta Boolean flag indicating whether to keep the bot session open continuously.
Tempo De Espera (Em Segundos) Time in seconds the bot waits for additional messages after receiving one, then combines them into a single message.
Numero Do Destinatario The remote JID (identifier) of the recipient. Required when changing session status.
Status The status to set for a session. Options: Opened, Paused, Closed. Used when changing session status.

Output

The node outputs JSON data representing the result of the requested operation on the Flowise integration. The structure depends on the operation performed:

  • For creation, update, or deletion operations, the output typically contains confirmation details or the updated Flowise bot object.
  • For retrieval operations (find Flowise, fetch sessions), the output contains arrays or objects describing the bots or sessions found.
  • For status changes, the output confirms the new status of the session.

No binary data output is indicated.

Dependencies

  • Requires access to the Evolution API endpoint specified by the user (Server URL).
  • Requires valid API keys both for the Evolution API and for the Flowise bot API.
  • Network connectivity to these APIs must be configured.
  • No other external dependencies are indicated.

Troubleshooting

  • Invalid API Key or Authentication Errors: Ensure the API keys provided are correct and have sufficient permissions.
  • Incorrect URLs: Verify that the Server URL and Url Do Flowise are reachable and correctly formatted.
  • Missing Required Parameters: Some operations require specific parameters (e.g., flowiseBotId for updates). Omitting these will cause errors.
  • Trigger Configuration Issues: When using keyword triggers, ensure the triggerValue matches expected patterns and the operator is appropriate.
  • Session Management Errors: Changing session status requires a valid remoteJid and status; incorrect values may cause failures.
  • Timeouts or Network Issues: Check network connectivity and API availability if requests time out or fail.

Common error messages will indicate unsupported operations or missing parameters; reviewing the node configuration against the required properties usually resolves these.

Links and References

  • Evolution API Documentation (as referenced in the node's base URL)
  • Flowise official documentation (not linked here, but recommended to consult for bot API details)

Discussion