Clientes Online - WhatsApp icon

Clientes Online - WhatsApp

Interação com a Plataforma de Relacionamento via WhatsApp - Clientes.Online
Join our community

Actions59

Overview

This node interacts with the "Clientes Online - WhatsApp" platform, specifically enabling users to search for contacts based on various filters. The "Contato - Pesquisar" (Contact - Search) operation allows retrieving contact information by applying different criteria such as keyword, region, operator, gender, email, and date ranges, among others.

Typical use cases include:

  • Finding contacts matching a specific keyword or attribute.
  • Filtering contacts registered within a certain time period.
  • Searching contacts by demographic or service-related attributes like operator or portability status.
  • Retrieving contacts who are leads or have specific tags.

For example, a marketing team could use this node to extract all contacts from a particular region or those who have birthdays in the current month to send targeted campaigns.

Properties

Name Meaning
Buscar Contatos Notice informing that this operation allows searching contacts using different filters.
Paginação (p) Page number for paginated contact search results.
Tipo De Filtro Type of filter to apply for searching contacts. Options:
- Palavra Chave (Keyword)
- Região (Region)
- Operadora (Operator)
- Gênero (Gender)
- Portabilidade (Portability)
- Bloqueados (Blocked)
- Período (Period)
- Importados (Imported)
- E-Mail
- Leads
- Aniversariantes (Birthdays)
Parâmetro De Busca Search parameter value corresponding to the selected filter type (e.g., name, number, state, operator, email). Required for filters: Keyword, Region, Operator, Gender, Email, Birthdays.
Data Inicial Start date for filtering contacts by registration period. Required when filter type is "Período".
Data Final End date for filtering contacts by registration period. Required when filter type is "Período".

Output

The node outputs an array of JSON objects representing the contacts found according to the applied filters and pagination. Each object contains contact details as returned by the Clientes Online API. The exact structure depends on the API response but typically includes identifiers, names, contact info, tags, and other metadata.

There is no indication that the node outputs binary data.

Dependencies

  • Requires connection to the Clientes Online platform via an API key credential.
  • The node depends on the Clientes Online API being accessible and properly authenticated.
  • No additional environment variables or external services are explicitly required beyond the API credential.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will prevent successful contact searches.
    • Using incompatible filter parameters (e.g., missing required search parameter for a filter) may cause errors.
    • Pagination values out of range might return empty results or errors.
    • Date format issues for "Data Inicial" and "Data Final" can lead to request failures.

  • Error Messages:

    • Authentication errors indicate problems with the provided API key; verify and update credentials.
    • Validation errors suggest missing or incorrect input properties; ensure all required fields for the chosen filter are filled.
    • Network or timeout errors imply connectivity issues with the Clientes Online API; check network settings and API availability.

Links and References

Discussion