Actions148
- Chats Actions
- Chat Contacts Actions
- Chat Messages Actions
- Chat Files Actions
- Files Actions
- Team Actions
- Labels Actions
- Departments Actions
- Quick replies Actions
- Queue Actions
- WhatsApp session Actions
- WhatsApp profile Actions
- Business catalog Actions
- Campaigns Actions
- Meeting Links Actions
- User Status Actions
- Webhooks Actions
- Other Actions
- Send messages Actions
- Outbound Messages Actions
- WhatsApp Numbers Actions
- Groups Actions
- Channels Actions
Overview
The node provides an interface to interact with the SparkBot WhatsApp API, specifically allowing users to search for WhatsApp channels associated with a given WhatsApp number. This operation is useful when you want to discover channels based on various criteria such as text queries, categories, sorting preferences, and geographic filters.
Common scenarios include:
- Finding popular or trending WhatsApp channels related to a specific topic or keyword.
- Filtering channels by country to target regional audiences.
- Sorting channels by subscriber count or creation time to identify new or highly subscribed channels.
For example, a marketing automation workflow could use this node to dynamically find trending WhatsApp channels in a particular country and then send targeted messages or gather analytics.
Properties
| Name | Meaning |
|---|---|
| WhatsApp Number | The ID of the WhatsApp number (device) from which to search channels. |
| Search Query | Optional text string to search for channels matching the query. |
| Results Limit | Maximum number of results to return, between 1 and 50. Defaults to 50. |
| Category | Category of channels to search for. Options: Recommended, Trending, Popular, New, Featured. |
| Sort Order | Sort order for the results. Options: Descending, Ascending. Defaults to Descending. |
| Sort Field | Field to sort by. Options: Creation Time, Subscribers. Defaults to Subscribers. |
| Countries | List of countries to filter channels by (up to 10). Each country is represented by its ISO code. |
Output
The output is a JSON array where each item represents a channel matching the search criteria. Each channel object contains details returned by the SparkBot API about that channel, such as its name, category, subscriber count, creation time, and other metadata relevant to the channel.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the SparkBot WhatsApp API.
- The node depends on the SparkBot API service being accessible.
- The "WhatsApp Number" property must correspond to a valid device ID configured in the user's SparkBot account.
- No additional environment variables are explicitly required beyond the API key credential.
Troubleshooting
- Invalid WhatsApp Number: If the provided WhatsApp number ID is incorrect or not linked to the account, the API call will fail. Verify the device ID is correct and authorized.
- API Limits: The results limit must be between 1 and 50. Providing values outside this range may cause errors.
- Network Issues: Connectivity problems with the SparkBot API endpoint can cause request failures.
- Empty Results: If no channels match the search criteria, the output will be an empty array. Adjust filters or search terms accordingly.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
Links and References
- SparkBot WhatsApp API Documentation (hypothetical link as actual URL is not provided)
- n8n Documentation on Creating Custom Nodes
- ISO Country Codes Reference: https://www.iso.org/iso-3166-country-codes.html