Evolution API icon

Evolution API

Interact with Evolution API

Actions114

Group → Toggle Ephemeral Messages

AI-generated

Overview

This node operation toggles ephemeral messages in a specified group within the Evolution API. It allows users to enable or disable ephemeral messages and set their expiration time, which controls how long messages remain visible before disappearing. This is useful for managing message retention and privacy in group chats, such as setting messages to disappear after 24 hours, 7 days, or 90 days, or disabling ephemeral messages entirely.

Use Case Examples

  1. A user wants to enable ephemeral messages in a group chat so that messages disappear after 7 days to maintain privacy.
  2. A user disables ephemeral messages in a group to keep all messages permanently visible.

Properties

Name Meaning
Instance Name The name of the Evolution API instance to use for the request.
Group ID The unique identifier of the group where ephemeral messages will be toggled.
Expiration The duration after which messages in the group will expire and be deleted automatically. Options include Disabled (0), 24 Hours (86400 seconds), 7 Days (604800 seconds), and 90 Days (7776000 seconds).

Output

JSON

  • success - Indicates whether the toggle operation was successful.
  • groupJid - The ID of the group where ephemeral messages were toggled.
  • expiration - The expiration time set for ephemeral messages in the group.

Dependencies

  • Requires an Evolution API credential for authentication to interact with the Evolution API.

Troubleshooting

  • If the node throws an 'Unsupported operation' error, verify that the resource and operation names are correctly set to 'Group' and 'Toggle Ephemeral Messages'.
  • Ensure the provided Group ID is valid and the instance name corresponds to a configured Evolution API instance.
  • Check that the API credentials are correctly set and have the necessary permissions to modify group settings.

Discussion