Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

The node named "Evolution API" provides an interface to interact with the Evolution API service. Specifically, for the Chat resource and the Find Status operation, it allows users to retrieve status messages related to a particular chat contact. This can be useful in scenarios where you want to track or audit message statuses (such as read receipts or delivery confirmations) for a given message ID within a chat instance.

Practical examples include:

  • Fetching the delivery or read status of a specific message sent to a contact.
  • Paginating through status updates if there are many, by specifying page number and quantity per page.
  • Integrating chat status information into workflows for customer support or analytics.

Properties

Name Meaning
Instance Name The name of the chat instance to connect to.
Contact The contact number (remote JID) whose message status is being queried.
Message ID The unique identifier of the message for which status messages are requested.
Page The page number of the results to fetch (for pagination).
Quantity Per Page Number of status messages to return per page (pagination size).

Output

The node outputs a JSON array containing the status messages retrieved from the Evolution API for the specified message and contact. Each item in the array represents a status update related to the message, such as delivery or read status details.

If the API supports binary data (not evident from the provided code), it would typically relate to attachments or media associated with the chat, but this node primarily deals with JSON status data.

Dependencies

  • Requires an active connection to the Evolution API service.
  • Requires 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 other external dependencies are indicated.

Troubleshooting

  • Unsupported operation error: If the node throws an error stating the operation is unsupported, verify that the Resource is set to "Chat" and Operation to "Find Status". Also ensure the version of the node supports this operation.
  • Missing required parameters: Ensure all required properties (Instance Name, Contact, Message ID) are provided; missing these will cause errors.
  • API connectivity issues: Check network access and API credentials if the node cannot reach the Evolution API endpoint.
  • Pagination errors: Providing invalid page numbers or offsets may result in empty or error responses; use positive integers.

Links and References

Discussion