Evolution API icon

Evolution API

Interact with Evolution API

Actions114

OpenAI → Change Bot Status

AI-generated

Overview

This node interacts with the Evolution API to change the status of a bot instance. It is useful for managing bot availability by enabling or disabling a specific bot identified by its ID within a given instance. For example, a user can enable a bot to make it active or disable it to temporarily stop its operation.

Use Case Examples

  1. Enable a bot by setting its status to 'enabled' using the bot's ID and instance name.
  2. Disable a bot to prevent it from responding or operating by changing its status to 'disabled'.

Properties

Name Meaning
Instance Name The name of the instance where the bot is located, used to identify the specific environment for the bot status change.
Bot ID The unique identifier of the bot whose status is to be changed.
Status The new status to set for the bot, either 'enabled' or 'disabled' to control the bot's operational state.

Output

JSON

  • status - The updated status of the bot after the operation.
  • botId - The ID of the bot whose status was changed.
  • instanceName - The name of the instance where the bot status was changed.

Dependencies

  • Requires authentication with the Evolution API via an API key credential.

Troubleshooting

  • Error 'Unsupported operation' indicates the specified operation is not implemented; verify the operation name is correct.
  • Missing or invalid 'Instance Name' or 'Bot ID' parameters will cause the node to fail; ensure these are provided and valid.
  • API authentication errors may occur if the Evolution API credentials are not set or invalid; verify credentials configuration.

Discussion