Evolution API

Interagir com a Evolution API v2

Overview

This node integrates with the Evolution API v2 to perform various operations related to WhatsApp messaging and instance management. Specifically, for the Chat resource and the Enviar Presença (Send Presence) operation, it allows sending presence updates from a specified instance. Presence updates typically indicate user activity status such as "online", "typing", or "recording" in WhatsApp chats.

Practical scenarios where this node is beneficial include:

  • Indicating to chat participants that the user is currently typing or active.
  • Automating presence signals to improve user engagement or bot responsiveness.
  • Managing presence states programmatically in customer support or marketing workflows.

Example: A chatbot can send a "typing" presence before sending a message to simulate human-like interaction.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance from which to send the presence update. This identifies the specific connection to use for the operation.

Output

The output JSON contains the response from the Evolution API after attempting to send the presence update. It generally includes:

  • success: Boolean indicating if the operation was successful.
  • message: A confirmation message about the operation.
  • timestamp: The time when the operation was performed.

If the API returns additional data, it will be included in the output JSON. The node does not output binary data for this operation.

Example output JSON:

{
  "success": true,
  "message": "Operation completed successfully",
  "timestamp": "2024-06-01T12:00:00.000Z"
}

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Evolution API.
  • The node uses HTTP requests to the Evolution API endpoints.
  • The "Instance Name" must correspond to a valid and connected WhatsApp instance managed by the Evolution API.

Troubleshooting

  • Common issues:

    • Invalid or missing instance name: Ensure the instance name provided exists and is connected.
    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Network or API downtime: Check the availability of the Evolution API service.
  • Error messages:

    • "Instance not found": The specified instance name does not exist; verify the name.
    • "Unauthorized" or "Authentication failed": The API key is invalid or expired; update credentials.
    • "Failed to send presence": Could indicate incorrect presence value or temporary API issue; retry or check parameters.

Links and References


This summary focuses on the Chat resource's "Enviar Presença" operation based on the provided source code and input properties.

Discussion