Evolution API icon

Evolution API

Interact with Evolution API

Actions64

Overview

This node interacts with the Evolution API to manage proxy settings for instances. It supports two main operations under the "Instancia" resource: setting a proxy configuration and checking the current proxy status. This is useful in scenarios where you need to route instance communications through a proxy server, either enabling or disabling it, or verifying the existing proxy setup.

Practical examples include:

  • Enabling a corporate proxy for an instance to comply with network policies.
  • Disabling the proxy when direct internet access is required.
  • Checking if a proxy is currently configured before performing network operations.

Properties

Name Meaning
Nome Da Instancia The name of the instance that will send the message; identifies which instance to configure.
O Que Deseja Fazer Choose between "Definir Proxy" (set proxy) or "Verificar Proxy" (check proxy status).
Ativar Proxy Boolean option to enable or disable proxy integration (only for setting proxy).
Protocolo Do Proxy Protocol used by the proxy; options are HTTP or HTTPS (only for setting proxy).
Host Do Proxy The hostname or IP address of the proxy server (only for setting proxy).
Porta Do Proxy The port number on which the proxy server listens (only for setting proxy).
Usuário Do Proxy Username for authenticating with the proxy server (only for setting proxy).
Senha Do Proxy Password for authenticating with the proxy server (only for setting proxy).

Output

The node outputs a JSON array containing the result of the proxy operation. For "Definir Proxy," this typically includes confirmation of the proxy being set or disabled. For "Verificar Proxy," it returns the current proxy configuration details or status.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node depends on the Evolution API endpoint at https://doc.evolution-api.com/api-reference.
  • Proper network connectivity to the Evolution API service is necessary.

Troubleshooting

  • Common issues:

    • Incorrect instance name may cause the operation to fail because the target instance cannot be found.
    • Invalid proxy credentials (username/password) will prevent successful proxy configuration.
    • Network issues or incorrect base URL can lead to connection errors.

  • Error messages:

    • "Operação não suportada." indicates that the selected operation is not implemented for the chosen resource. Verify that the resource and operation names are correct.
    • Authentication failures usually manifest as authorization errors from the API; ensure the API key credential is valid and has proper permissions.
    • Missing required fields (e.g., proxy host, port, username, password) will cause validation errors; ensure all mandatory inputs are provided.

Links and References

Discussion