Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key

Overview

The node "Evolution API Direct" allows users to interact directly with the Evolution API by specifying a server URL and an API key. It supports various resources and operations, including the "Chat" resource with the "Procurar Chats" (Find Chats) operation. This operation enables searching for chat messages based on specific parameters such as contact number, message ID, pagination, and page size.

This node is beneficial in scenarios where you need to programmatically query chat data from the Evolution API, for example:

  • Retrieving chat history for a specific contact.
  • Searching for particular messages within chats.
  • Paginating through large sets of chat records.

Properties

Name Meaning
Server URL The full URL of your Evolution API server endpoint (e.g., https://api.exemplo.com).
API Key The API key credential required to authenticate requests to the Evolution API instance.
Nome Da Instância The name of the Evolution API instance you want to target.
Contato The phone number or identifier of the contact whose chats you want to search.
ID Da Mensagem The unique identifier of the message to find within the chats.
Página The page number for paginated results (default is 1).
Quantidade Por Página The number of chat records to return per page (default is 10).

Output

The node outputs JSON data representing the result of the chat search query. The structure typically includes details about the chats found, such as message content, timestamps, sender/receiver information, and any metadata returned by the Evolution API.

If the API returns binary data (not indicated here), it would be included accordingly, but this node primarily deals with JSON chat data.

Dependencies

  • Requires access to the Evolution API endpoint specified by the user.
  • Requires a valid API key credential for authentication.
  • The node expects the user to provide correct instance names and other parameters relevant to the Evolution API setup.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API key will cause authentication failures.
    • Invalid server URL or instance name may lead to connection errors.
    • Providing wrong contact numbers or message IDs might result in empty responses.
    • Pagination parameters out of range could cause unexpected results or errors.
  • Error Messages:

    • "Operação não suportada." indicates that the selected operation is not supported for the chosen resource. Verify that "Chat" and "Procurar Chats" are correctly selected.
    • Network or authentication errors usually stem from incorrect API keys or server URLs; double-check these inputs.
  • Resolution Tips:

    • Ensure all required fields are filled correctly.
    • Validate API key permissions and instance availability.
    • Use correct formatting for contact numbers and message IDs.
    • Adjust pagination parameters to valid ranges.

Links and References

  • Evolution API Documentation (as referenced in the node's default base URL)
  • Consult your Evolution API provider for detailed API key management and instance configuration.

Discussion