Evolution API NKInstall

Summary

Manage Evolution Bot instances by creating, retrieving, updating, deleting bots, fetching or changing session statuses using configurable parameters such as instance name, API URL, triggers, and session options.

Inputs

• Nome Da Instancia (required) — Specify the name of the instance that will send messages.
• O Que Deseja Fazer (required) — Select the desired action to perform with the Evolution Bot integration: add, verify, update, delete bot, fetch sessions, or change session status.
• ID Do Evolution Bot — Enter the Evolution Bot ID to target specific bots for find, update, delete, fetch sessions, or change session status operations; leave empty to apply action to all bots.
• URL Da API Do Evolution Bot (required) — Provide the API URL of your Evolution Bot, required for create and update operations.
• ApiKey Da Evolution Bot (required) — Enter the API key for your Evolution Bot, required for create and update operations.
• Tipo De Gatilho — Choose the trigger type (keyword or all) to start the Evolution Bot for create and update operations.
• Operador Do Gatilho — Select the trigger operator (contains, equals, startsWith, endsWith, regex) to define how the trigger keyword matches incoming messages, applicable if trigger type is keyword.
• Gatilho (required) — Specify the keyword, phrase, or regex to trigger the Evolution Bot, used in create and update operations.
• Expira Em (Minutos) (required) — Set the number of minutes without responses to automatically deactivate the bot (create/update).
• Palavra Chave De Finalização (required) — Define the keyword or phrase used to close the bot session (create/update).
• Delay Padrão Da Mensagem (Em Milésimos) (required) — Set the default message delay in milliseconds for the bot's responses (create/update).
• Palavra Chave De Finalização (required) — Set the message for unrecognized inputs (create/update).
• Escuta Mensagens Enviadas Por Mim — Boolean to let the bot listen to messages sent by the user (create/update).
• Pausa O Bot Quando Eu Enviar Uma Mensagem — Boolean to pause the bot when the user sends a message (create/update).
• Mantem a Sessão Do Bot Aberta — Boolean to keep the bot session open (create/update).
• Tempo De Espera (Em Segundos) (required) — Set the wait time in seconds to gather subsequent messages into one for the bot (create/update).
• Numero Do Destinatario (required) — Specify the remoteJid (recipient identifier) for changing session status.
• Status (required) — Select the new status (opened, paused, closed) to set for the session when changing the session status.
• JIDs Ignorados — List of JIDs to be ignored by the bot (create/update).
• Tipo do Operador — Choose the trigger operator type (contains, equals, startsWith, endsWith, regex, none) for create and update operations.

Output shape

a list of JSON objects reflecting the result of the selected Evolution Bot operation

Returns JSON data depending on the chosen action: bot details for create/find/update/delete, session lists for fetchSessionsEvolutionBot, and status update results for changeStatusEvolutionBot. The output shape may vary accordingly.

Examples

Example 1: Create a new Evolution Bot instance

Provide the instance name, API URL, API key, trigger type and value, expiry time, keywords for finishing and unknown messages, message delay, session and listening options.

Example 2: Retrieve details of a specific Evolution Bot

Specify the Evolution Bot ID to retrieve its details.

Example 3: Update an existing Evolution Bot

Provide the Evolution Bot ID and updated parameters such as API URL, API key, trigger settings, and session options.