Wappfy icon

Wappfy

Interact with WhatsApp through Wappfy API

Actions76

Overview

This node enables interaction with the Wappfy API to manage WhatsApp-related resources, including channels. Specifically, the Channel - Search by Text operation allows users to search for public channels using a text query. This is useful for discovering channels relevant to specific topics or interests by providing keywords.

Practical scenarios include:

  • Finding WhatsApp channels related to a particular subject or keyword.
  • Filtering channels by categories or countries to narrow down search results.
  • Paginating through large sets of channel search results using cursors.

For example, a user could search for channels containing the word "technology" and filter results to channels categorized under "news" or limited to certain countries.

Properties

Name Meaning
Search Text The text string to search for within public channels.
Countries Optional comma-separated list of country codes to filter the search results by location.
Categories Optional comma-separated list of categories to filter the search results by topic.
Start Cursor Optional cursor string used for pagination to continue fetching results from a previous call.

Output

The node outputs an array of JSON objects representing the search results returned by the Wappfy API. Each item corresponds to a channel matching the search criteria. The exact structure depends on the API response but typically includes channel details such as ID, name, description, category, country, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Wappfy API credential with:

    • Base URL of the Wappfy API instance.
    • Instance name identifier.
    • API key for authentication.

  • The node makes HTTP POST requests to the endpoint /api/{instanceName}/channels/search/by-text with a JSON body containing the search parameters.

  • Proper configuration of the Wappfy API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Empty or no results:
    Ensure the Search Text property is correctly set and not empty. Also verify that optional filters like Countries and Categories are valid and correspond to existing values.

  • Authentication errors:
    Check that the API key and instance name in the credentials are correct and have sufficient permissions.

  • Pagination issues:
    When using Start Cursor, ensure it is obtained from a previous search result's pagination info. Using an invalid or expired cursor may cause errors or empty responses.

  • API request failures:
    Network issues or incorrect base URL configuration can cause request failures. Verify connectivity and credential settings.

  • Error messages:
    Errors thrown by the node will include messages from the Wappfy API. Common errors might relate to invalid parameters or unauthorized access. Review the error message and adjust input properties or credentials accordingly.

Links and References

Discussion