Actions83
- Instances Actions
- Client Actions
- Message Actions
- Chat Actions
- Contact Actions
- Number Actions
- Group Actions
- Channel Actions
- Label Actions
- Story Actions
Overview
This node operation allows users to search for channels within a specified instance by applying various filters such as country codes, search text, and view type. It is useful when you want to discover or list channels that match certain criteria, for example, finding trending news channels in specific countries or filtering out channels you are already subscribed to.
Practical examples:
- Searching for popular news channels in the US and UK.
- Finding new or trending channels related to technology.
- Filtering out channels you have already subscribed to when looking for new newsletters.
Properties
| Name | Meaning |
|---|---|
| Id | Instance ID (required) identifying the context or environment where the search is performed. |
| Country Codes | Optional array of ISO 3166-1 alpha-2 country codes to filter channels by geographic region. Example: ["US", "GB"] |
| Search Text | Optional text string to search for in channel names or descriptions, e.g., "news". |
| View | Type of results filtering; options include RECOMMENDED, TRENDING, POPULAR, NEW. |
| Limit | Maximum number of results to return (default 50). |
| Skip Subscribed Newsletters | Boolean flag indicating whether to exclude channels corresponding to newsletters already subscribed to. |
Output
The output JSON contains an array of channel objects matching the search criteria. Each object typically includes details about the channel such as its name, description, country, and other metadata relevant to the channel's identity and status.
If the node supports binary data output, it would represent associated media or files linked to channels, but this operation primarily returns structured JSON data describing channels.
Dependencies
- Requires an API key credential for authenticating with the WaAPI service.
- The node communicates with the WaAPI endpoint at
https://waapi.app/api/v1. - No additional external dependencies beyond the configured API authentication.
Troubleshooting
- Invalid or missing Instance ID: Ensure the "Id" property is set correctly; otherwise, the API may reject the request.
- Malformed country codes JSON: The "Country Codes" field expects a valid JSON array of strings; invalid JSON will cause errors.
- API authentication errors: Verify that the API key credential is properly configured and has necessary permissions.
- Limit value too high: Setting an excessively high limit might cause performance issues or API rate limiting.
- Empty results: If no channels match the criteria, check the filters applied (e.g., country codes, search text) for correctness.
Links and References
- WaAPI Documentation (for detailed API usage and channel data structure)
- ISO 3166-1 alpha-2 country codes