Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node, named "Evolution API," is designed to interact with the Evolution API service. Specifically, for the Resource "Chat" and Operation "Buscar Estados" (Find Status Messages), it allows users to query status messages related to a particular chat contact within an instance of the Evolution API environment. This can be useful in scenarios where you want to retrieve message statuses for auditing, monitoring, or integration purposes.

For example, you might use this node to:

  • Retrieve the status of specific messages sent to a contact.
  • Paginate through status messages to analyze communication history.
  • Integrate message status data into other workflows or reporting tools.

Properties

Name Meaning
Nombre De La Instancia The name of the Evolution API instance to connect to.
Contacto The phone number or identifier of the contact whose message statuses are being queried.
ID Del Mensaje The unique identifier of the message for which status information is requested.
Página The page number for paginated results (default is 1).
Cantidad Por Página The number of status messages to return per page (default is 10).

Output

The node outputs a JSON array containing the results returned by the Evolution API for the requested status messages. Each item in the array represents a status message record associated with the specified contact and message ID. The exact structure depends on the API response but typically includes details such as message status, timestamps, and possibly metadata about delivery or read receipts.

If the API supports binary data (e.g., media attachments), this node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON-formatted status message data.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The base URL for requests is set to https://doc.evolution-api.com/api-reference.
  • No additional external dependencies are indicated in the provided source code.

Troubleshooting

  • Operation Not Supported Error: If you select an unsupported operation or resource, the node throws an error stating the operation is not supported. Ensure that the Resource is set to "Chat" and Operation to "Buscar Estados" for this functionality.
  • Missing Required Parameters: The node requires all mandatory fields (instance name, contact, message ID) to be filled. Omitting these will likely cause errors or empty responses.
  • API Connectivity Issues: Network problems or incorrect API credentials may result in failed requests. Verify your API key and network access.
  • Pagination Limits: Requesting pages beyond available data may return empty arrays; adjust "Página" and "Cantidad Por Página" accordingly.

Links and References

Discussion