Evolution API icon

Evolution API

Interact with Evolution API
Join our community

Actions64

Overview

This node, named "Evolution API," allows interaction with the Evolution API service. Specifically for the resource Instancia and operation Definir/Buscar Proxy, it enables users to either set (define) or find (check) proxy settings for a given instance. This is useful in scenarios where an instance needs to route its network traffic through a proxy server for security, compliance, or routing reasons.

Practical examples include:

  • Enabling a proxy for an instance that sends messages, ensuring all outbound traffic goes through a controlled proxy.
  • Disabling the proxy when direct connection is preferred.
  • Checking the current proxy configuration of an instance to verify connectivity or troubleshoot network issues.

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" (find/check proxy).
Ativar Proxy Boolean to enable (true) or disable (false) the proxy integration (only for setting proxy).
Protocolo Do Proxy Protocol used by the proxy: 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 performed:

  • For Definir Proxy (set proxy), the output likely confirms success or failure of applying the proxy settings.
  • For Verificar Proxy (find proxy), the output returns the current proxy configuration details or status for the specified instance.

No binary data output is indicated.

Dependencies

  • Requires an API key credential to authenticate with the Evolution API service.
  • The node expects the Evolution API endpoint to be reachable and properly configured.
  • No additional external dependencies are explicitly required beyond the API access.

Troubleshooting

  • Common Issues:

    • Incorrect instance name may cause the operation to fail or return no data.
    • Invalid proxy credentials (username/password) will prevent successful proxy setup.
    • Network issues or unreachable Evolution API endpoints can cause request failures.
    • Missing required fields such as proxy host, port, username, or password when setting proxy.

  • Error Messages:

    • "Operação não suportada." indicates the requested operation is not supported for the selected resource.
    • Authentication errors if the API key credential is invalid or missing.
    • Validation errors if required parameters are missing or malformed.

  • Resolutions:

    • Verify all required input properties are correctly filled.
    • Ensure the API key credential is valid and has necessary permissions.
    • Confirm network connectivity to the Evolution API.
    • Double-check proxy server details and credentials.

Links and References

Discussion