Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node allows you to manage the archive status of a chat conversation using the Evolution API. Specifically, it enables you to either archive or unarchive a chat with a given contact by specifying relevant details such as the instance name, contact number, message ID, and whether the message was sent by your instance. This is useful for automating chat management tasks, such as organizing conversations or restoring access to previously archived chats.

Practical examples:

  • Automatically archiving chats after a support ticket is closed.
  • Unarchiving a chat when a customer sends a new message.
  • Keeping your chat list organized by programmatically managing archived conversations.

Properties

Display Name Type Meaning
Nome Da Instância String The name of the Evolution API instance to use.
Contato String The contact's phone number whose chat you want to archive or unarchive.
Ação Options Choose whether to archive ("Arquivar") or unarchive ("Desarquivar") the conversation.
ID Da Mensagem String The ID of the last message in the conversation.
Mensagem É Minha Boolean Indicates if the message was sent by your instance (true) or not (false).

Output

The output will be a JSON object (or array of objects) containing the result of the archive/unarchive operation as returned by the Evolution API. The exact structure depends on the API response, but typically includes status information and possibly details about the affected chat.

[
  {
    // Example fields (actual fields depend on API response)
    "status": "success",
    "chatId": "5511999999999@c.us",
    "archived": true
  }
]

Dependencies

  • External Service: Requires access to the Evolution API.
  • API Key/Credentials: You must configure valid Evolution API credentials in n8n under the credential type evolutionApi.
  • n8n Configuration: No additional configuration required beyond setting up credentials.

Troubleshooting

  • Common Issues:

    • Missing or incorrect credentials will prevent the node from connecting to the Evolution API.
    • Providing an invalid contact number or message ID may result in errors from the API.
    • Attempting to use unsupported operations or resources will throw an error.

  • Error Messages:

    • "Operação não suportada."
      Resolution: Ensure you have selected a valid combination of Resource and Operation.
    • Errors related to missing required fields (e.g., instance name, contact, message ID)
      Resolution: Double-check that all required properties are filled in correctly.

Links and References

Discussion