Evolution API Plus icon

Evolution API Plus

Interact with Evolution API

Integração → Evolution Bot

AI-generated

Summary

Manage Evolution Bot integrations by creating, retrieving, updating, deleting bots, as well as fetching and changing session statuses within the Evolution Bot system.

Inputs

  • Nome Da Instancia (required) — Specify the name of the instance sending the message.
  • O Que Deseja Fazer (required) — Select the action to perform with the Evolution Bot integration: add, verify, update, delete bot, fetch sessions, or change session status.
  • ID Do Evolution Bot — Provide the Evolution Bot ID to operate on; leave empty to target all (applicable for find, update, delete, fetch sessions, change session status).
  • URL Da API Do Evolution Bot (required) — Enter the URL for your Evolution Bot API (required for creating or updating a bot).
  • ApiKey Da Evolution Bot — Enter the API key for your Evolution Bot (needed when creating or updating a bot).
  • Tipo De Gatilho — Choose the trigger type for the bot (keyword or all, relevant when creating or updating).
  • Operador Do Gatilho — Select the operator for the trigger condition when trigger type is keyword (e.g., contains, equals, regex).
  • Gatilho (required) — Define the keyword, phrase, or regex used to trigger the Evolution Bot (required when creating or updating with keyword trigger).
  • Expira Em (Minutos) (required) — Set the timeout in minutes before the bot deactivates after no responses (required when creating or updating).
  • Palavra Chave De Finalização (required) — Define the keyword or phrase used to close the bot (required when creating or updating).
  • Delay Padrão Da Mensagem (Em Milésimos) (required) — Set the default message delay in milliseconds for bot responses (required when creating or updating).
  • Palavra Chave De Finalização (Unknown Message) (required) — Message returned when input is not recognized by the bot (required when creating or updating).
  • Escuta Mensagens Enviadas Por Mim — Indicate whether the bot listens to messages sent by the user (optional when creating or updating).
  • Pausa O Bot Quando Eu Enviar Uma Mensagem — Specify if the bot should pause whenever the user sends a message (optional when creating or updating).
  • Mantem a Sessão Do Bot Aberta — Indicate if the bot session should remain open (optional when creating or updating).
  • Tempo De Espera (Em Segundos) (required) — Set debounce time in seconds to wait for additional messages before processing (required when creating or updating).
  • JIDs Ignorados — List of JIDs to be ignored by the bot (optional when creating or updating).
  • Numero Do Destinatario (required) — The remoteJid (recipient number) to specify the session whose status will be changed (required when changing session status).
  • Status (required) — Set the desired status for the bot session: opened, paused, or closed (required when changing session status).

Output shape

a JSON object containing the result of the selected Evolution Bot action, such as details of a created or updated bot, list of bots found, deletion confirmation, session fetch results, or session status update confirmation.

When searching or operating on specific bots, results or confirmations relate to the provided bot ID. Creating or updating requires full configuration inputs. Changing session status requires remoteJid and status parameters. Operations may vary in output structure depending on the selected 'O Que Deseja Fazer' action.

Examples

Example 1: Creating an Evolution Bot

Provide instance name, API URL, API key, trigger type and value, expiration time, keywords for finishing and unknown messages, delays, and other bot behavior settings to create a new Evolution Bot integration.

Example 2: Checking Evolution Bots

Supply instance name and optionally a bot ID to retrieve details of specific or all Evolution Bots.

Example 3: Updating an Evolution Bot

Input instance name, bot ID, and updated settings including API URL, trigger conditions, keywords, delays, and behavior flags to modify an existing Evolution Bot.

Links

Discussion