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 "Procurar Status" (translated as "Find Status Messages"), it allows users to search for status messages related to a chat instance. This can be useful in scenarios where you want to retrieve message status information such as delivery or read receipts for a particular contact and message within a specified instance.

Practical examples include:

  • Fetching the delivery status of a specific message sent to a contact.
  • Paginating through status messages to analyze message engagement or troubleshoot message delivery issues.

Properties

Name Meaning
Nome Da Instância The name of the chat instance to query.
Contato The contact number (remote JID) whose message status is being searched.
ID Da Mensagem The unique identifier of the message for which status is requested.
Página The page number for paginated results (default is 1).
Quantidade Por Página Number of status messages to return per page (pagination size, default is 10).

Output

The node outputs a JSON array containing the results of the status messages search. Each item in the array represents a status message record related to the specified message and contact within the given instance. The exact structure depends on the Evolution API response but typically includes details such as status type, timestamps, and possibly metadata about message delivery or read status.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API service.
  • The node expects the Evolution API endpoint to be accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Operation Not Supported Error: If the node throws an error stating the operation is not supported, verify that the Resource is set to "Chat" and the Operation to "Procurar Status". Also, ensure the node version supports this operation.
  • Missing Required Parameters: Ensure all required properties ("Nome Da Instância", "Contato", and "ID Da Mensagem") are provided; missing these will likely cause errors.
  • API Authentication Issues: Confirm that the API key credential is valid and has the necessary permissions.
  • Pagination Errors: Providing invalid values for "Página" or "Quantidade Por Página" (e.g., negative numbers) may result in unexpected behavior or empty results.

Links and References

Discussion