Wappfy icon

Wappfy

Interact with WhatsApp through Wappfy API

Overview

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

Use cases include:

  • Synchronizing WhatsApp contacts into other systems or CRMs.
  • Automating contact management workflows.
  • Building dashboards or reports based on WhatsApp contacts.

For example, you could use this node to fetch all contacts in batches of 50, then process or filter them further downstream in your workflow.

Properties

Name Meaning
Limit Number of contacts to return in one request (pagination size). Default is 20.
Offset Number of contacts to skip before starting to collect results (pagination offset). Default is 0.
Sort Order The order in which contacts are sorted by the API response. Options: Ascending, Descending. Default is Ascending.

Output

The node outputs an array of JSON objects representing WhatsApp contacts. Each object corresponds to a single contact's data as returned by the Wappfy API.

The exact structure depends on the API but typically includes fields such as contact ID, name, phone number, profile picture URL, status, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires a valid connection to the Wappfy API via configured credentials including:

    • Base URL of the Wappfy API instance.
    • Instance name identifying the WhatsApp session.
    • An API key credential for authentication.
  • The node makes HTTP GET requests to the endpoint /api/contacts/all with query parameters for pagination and sorting.

Troubleshooting

  • Empty results: Check that the WhatsApp session is active and properly connected. Also verify that the limit and offset parameters are set correctly.

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.

  • API connectivity issues: Verify network access to the Wappfy API base URL and that the instance name is correct.

  • Unexpected errors: Enable "Continue On Fail" in the node settings to capture error messages in the output for debugging.

Links and References

  • Wappfy API Documentation (general reference for API endpoints)
  • WhatsApp Business API concepts for understanding contact data structures

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion