New Evolution APIInstall

Summary

Manage Evolution Bots within an Evolution API instance by creating, retrieving, updating, deleting bots, managing their sessions, and changing session status.

Inputs

• Instance Name or ID (required) — Select the Evolution API instance where the Evolution Bot operates, either from a list or using an expression.
• O Que Deseja Fazer (required) — Choose the specific action to perform on the Evolution Bot such as create, find, update, delete, fetch sessions, or change session status.
• ID Do Evolution Bot — Specify the Evolution Bot ID to target a specific bot for find, update, delete, fetch sessions, or change status operations; leave empty to affect all bots (for find operation).
• URL Da API Do Evolution Bot (required) — Provide the API URL of the Evolution Bot instance when creating or updating a bot.
• ApiKey Da Evolution Bot — Provide the API key for authentication when creating or updating a bot.
• Tipo De Gatilho — Select the trigger type to specify how the bot recognizes activation triggers (keyword or all messages) when creating or updating a bot.
• Operador Do Gatilho — Select the trigger matching operator (e.g., contains, equals, starts with) applicable when using keyword triggers during bot creation or update.
• Gatilho (required) — Set the keyword, phrase, or regex that acts as the trigger to start the Evolution Bot when using keyword trigger type on create or update.
• Expira Em (Minutos) (required) — Define the inactivity timeout in minutes after which the bot is automatically deactivated, applicable on create or update.
• Palavra Chave De Finalização (required) — Set the keyword/phrase used to close the bot session, relevant for create or update operations.
• Delay Padrão Da Mensagem (Em Milésimos) (required) — Specify the default message delay in milliseconds to simulate response timing during bot creation or update.
• unknownMessage (required) — Input the message text sent when the bot cannot recognize a query, used during create or update.
• Escuta Mensagens Enviadas Por Mim — Boolean to determine if the bot listens to messages sent by the user, used in creation or update.
• Pausa O Bot Quando Eu Enviar Uma Mensagem — Boolean to pause the bot when the user sends a message, configurable on create or update.
• Mantem a Sessão Do Bot Aberta — Boolean to keep the bot session open indefinitely, applicable during create or update.
• Tempo De Espera (Em Segundos) (required) — Number of seconds the bot waits to aggregate multiple messages into one after receiving a message, used for create or update.
• Numero Do Destinatario (required) — Recipient's RemoteJid used when changing the status of a bot session.
• Status (required) — Select the session status (opened, paused, closed) to set when changing the status of a bot session.
• JIDs Ignorados — List of JIDs to be ignored by the bot, configurable when creating or updating a bot.

Output shape

a JSON array of objects representing the result of the chosen Evolution Bot operation

The output varies depending on the chosen suboperation: creating returns the new bot data; finding returns one or multiple bots; updating and deleting return confirmation and updated data; fetching sessions returns session data; changing status returns the updated session status. Operations support specifying bot ID for targeting specific bots or sessions.