SendWave API icon

SendWave API

Interactuar con SendWave API

Integration → Evolution Bot

AI-generated

Summary

Coordinate Evolution Bot actions by selecting an operation type, instance, and configuration. The chosen action determines which parameters apply.

Inputs

  • resourceForEvolutionBot — Select the operation to perform with the Evolution Bot. Options: createEvolutionBot, findEvolutionBot, updateEvolutionBot, deleteEvolutionBot, fetchSessionsEvolutionBot, changeStatusEvolutionBot. Default: createEvolutionBot.
  • instanceName (required) — Name of the Evolution Bot instance to connect to.
  • evolutionBotId — ID of the Evolution Bot to search, update, or delete. Leave empty to search all instances.
  • apiUrl (required) — URL of the Evolution Bot instance. Required for create and update operations.
  • apiKeyBot — API key for the Evolution Bot. Type: password.
  • triggerType — Select the trigger type for the bot. Options: keyword, all. Default: keyword.
  • triggerOperator — Operator for comparing the trigger value against message content. Options: contains, equals, startsWith, endsWith, regex, none. Default: contains.
  • triggerValue (required) — Keyword or regex pattern that serves as the trigger to initiate the Evolution Bot.
  • expire (required) — Minutes of inactivity after which the bot session is automatically disabled. Default: 0.
  • keywordFinish (required) — Word or phrase used to close the bot. Default: '#sair'.
  • delayMessage (required) — Default delay in milliseconds between messages sent by the bot. Default: 1000.
  • unknownMessage (required) — Message returned when the bot does not recognize incoming content. Default: 'Mensagem não reconhecida'.
  • listeningFromMe — Whether the bot listens to messages sent by the workflow author. Default: false.
  • stopBotFromMe — Whether to pause the bot when the workflow author sends a message. Default: false.
  • keepOpen — Whether to keep the bot session open after interactions. Default: false.
  • debounceTime (required) — Seconds the bot waits after receiving a message before grouping multiple incoming messages into one. Default: 0.
  • remoteJid — Recipient JID. Required for changeStatusEvolutionBot operations.
  • status — Status to set for the Evolution Bot session. Options: opened, paused, closed. Default: opened.
  • ignoreJids — List of JIDs that the bot will ignore. Type: string with multiple values allowed. Default: [].

Output shape

Action-dependent. Returns Evolution Bot instance data, session lists, or confirmation of the performed action. Consult execution logs for full output shape per operation.

Create/update operations return bot details; find returns matching bot/session records; delete returns removal confirmation; fetchSessions returns active session list; changeStatus returns session status update confirmation.

Discussion