Wappfy icon

Wappfy

Interact with WhatsApp through Wappfy API

Contact → List

AI-generated

Overview

This node integrates with the Wappfy API to interact with WhatsApp data and functionality. Specifically, for the Contact resource with the List operation, it retrieves a paginated list of contacts from the connected WhatsApp session.

Use cases include:

  • Fetching a list of WhatsApp contacts for further processing or filtering.
  • Synchronizing contact lists with other systems or CRMs.
  • Automating workflows that depend on contact information from WhatsApp.

Example: You want to retrieve the first 50 contacts sorted in ascending order to send them a broadcast message or analyze their details.

Properties

Name Meaning
Limit Number of contacts to return.
Offset Number of contacts to skip before starting to return results (for pagination).
Sort Order Order in which contacts are sorted; options are Ascending or Descending by default.

Output

The output is an array of JSON objects representing contacts retrieved from the WhatsApp session via the Wappfy API.

Each item in the output array corresponds to one contact object returned by the API. The exact structure depends on the API response but typically includes contact identifiers, names, phone numbers, and possibly status or profile picture URLs.

No binary data output is produced by this operation.

Dependencies

  • Requires a valid connection to the Wappfy API, including:

    • Base URL of the Wappfy API instance.
    • Instance name identifying the WhatsApp session.
    • An API key credential for authentication.
  • These credentials must be configured in n8n prior to using the node.

Troubleshooting

  • Common issues:

    • Invalid or missing API key or instance name will cause authentication failures.
    • Network connectivity problems to the Wappfy API endpoint.
    • Requesting too large a limit may result in timeouts or rate limiting.
  • Error messages:

    • Authentication errors usually indicate invalid credentials; verify API key and instance name.
    • HTTP errors such as 404 or 500 suggest issues with the API endpoint or parameters.
    • Pagination parameters (limit, offset) out of range may cause empty or partial results.
  • Resolution tips:

    • Double-check credentials and API endpoint configuration.
    • Use reasonable limits and offsets to avoid overloading the API.
    • Enable "Continue On Fail" in the node settings to handle individual request errors gracefully.

Links and References

Discussion