ZuckZapGo AI icon

ZuckZapGo AI

Send WhatsApp messages using ZuckZapGo - optimized for AI workflows
Join our community

Actions21

Overview

The "List Groups" operation of the ZuckZapGo AI node retrieves a comprehensive list of WhatsApp groups associated with the authenticated account. It fetches metadata such as group names, descriptions, participant counts, and admin status. This operation is useful for scenarios where you want to analyze or manage WhatsApp groups programmatically, such as generating reports on group activity, automating group messaging workflows, or integrating group data into other systems.

Practical examples:

  • Automatically listing all WhatsApp groups to display in a dashboard.
  • Filtering groups based on participant count or admin presence.
  • Using group metadata to trigger targeted messaging campaigns.

Properties

Name Meaning
Ignore Participants Whether to ignore participant details for better performance (groups will still be listed but without participant information)
Optimize Response Whether to optimize the response to reduce token usage and improve AI processing
Max Response Length Maximum number of characters in the response. Responses will be truncated if longer.
Include Only Essential Fields Whether to include only essential fields in the response to reduce noise
Response Format How to format the response for optimal AI agent understanding. Options: Optimized (clean, structured), Raw (complete raw API response), Summary (brief key info only)

Output

The output JSON contains the response from the WhatsApp API endpoint /group/list. The structure includes an array of group objects with metadata such as group names, descriptions, participant counts, and admin status.

If "Optimize Response" is enabled, the output may be truncated to the first 10 groups with additional metadata indicating that the response was optimized for AI processing, including original and returned counts and the reason for truncation.

No binary data is produced by this operation.

Example simplified output structure:

{
  "data": [
    {
      "id": "group_id_1",
      "name": "Group Name 1",
      "description": "Description of group 1",
      "participantCount": 25,
      "adminCount": 3,
      // ... other metadata fields
    },
    {
      "id": "group_id_2",
      "name": "Group Name 2",
      "description": "Description of group 2",
      "participantCount": 10,
      "adminCount": 1
    }
    // more groups...
  ],
  "_aiOptimized": true,
  "_truncated": {
    "originalCount": 50,
    "returnedCount": 10,
    "reason": "Optimized for AI processing"
  }
}

Dependencies

  • Requires an API key credential for the ZuckZapGo WhatsApp API service.
  • The node uses the internal helper function zuckzapgoApiRequest to communicate with the WhatsApp API.
  • No additional external dependencies are required.
  • If "Optimize Response" is enabled, the node performs local truncation and tagging of the response for AI optimization.

Troubleshooting

  • Error: Unknown operation — This error occurs if an unsupported operation name is provided. Ensure the operation is set to "List Groups".
  • API request failures — Network issues or invalid API credentials can cause request errors. Verify your API key and network connectivity.
  • Empty or missing group data — If no groups are returned, confirm that the authenticated WhatsApp account is part of groups.
  • Performance issues when not ignoring participants — Including participant details can slow down the response. Use "Ignore Participants" option to improve performance if participant info is not needed.
  • Response truncation confusion — When "Optimize Response" is enabled, only a subset of groups may be returned. Disable this option to get the full list.

Links and References

Discussion