Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The node interacts with the Evolution API to manage chat conversations, specifically allowing users to archive or unarchive a conversation for a given contact. This is useful in scenarios where users want to organize their chat history by hiding inactive or resolved conversations without deleting them, or restoring previously archived chats for review or follow-up.

Practical examples include:

  • Archiving customer support chats after resolution to keep the active chat list clean.
  • Unarchiving a conversation when a customer reopens an issue or needs further assistance.

Properties

Name Meaning
Instance Name The name of the Evolution API instance to use for the operation.
Contact The contact number whose conversation is to be archived or unarchived.
Action Choose whether to archive (Archive) or unarchive (Unarchive) the conversation.
Message ID The ID of the last message in the conversation, used to identify the specific chat thread.
Message Is Mine Boolean indicating if the last message was sent by the instance (true) or received (false).

Output

The node outputs a JSON array containing the result of the archive/unarchive operation. The exact structure depends on the Evolution API response but typically includes confirmation of the action performed on the specified conversation.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node expects the Evolution API base URL and headers to be configured internally.
  • No additional external dependencies are indicated beyond the Evolution API service.

Troubleshooting

  • Unsupported operation error: If the node throws an error stating the operation is unsupported, verify that the "Manage Archive" operation is correctly selected under the "Chat" resource.
  • Missing or invalid parameters: Ensure all required properties (Instance Name, Contact, Action, Message ID, Message Is Mine) are provided and valid.
  • API authentication errors: Confirm that the API key credential is correctly set up and has necessary permissions.
  • Incorrect Message ID or Contact: Using an invalid message ID or contact number may cause the API to fail; double-check these values.
  • Network or API downtime: Temporary connectivity issues or Evolution API outages can cause failures; retry after some time.

Links and References

Discussion