Green API icon

Green API

Send WhatsApp messages via Green API or trigger workflows on webhooks
Join our community

Actions21

Overview

The "Get Group Data" operation of the Green API node allows users to retrieve detailed information about a specific WhatsApp group by providing its Group ID. This operation is useful for scenarios where you need to fetch metadata or current state details of a WhatsApp group, such as its name, participants, admins, or other group-related attributes.

Practical examples include:

  • Monitoring group membership and roles.
  • Displaying group info in dashboards or reports.
  • Automating workflows based on group data changes.

This operation requires specifying the exact Group ID to query.

Properties

Name Meaning
Mode Selects the node mode:
- Action: Execute WhatsApp actions with Green API.
- Listen for Incoming Webhook: Trigger workflows on incoming webhooks from Green API.
Group ID The unique identifier of the WhatsApp group to retrieve data from. Format example: 972501234567-1587570015@g.us. This is required for the "Get Group Data" operation.

Note: The "Mode" property must be set to "Action" to perform this operation.

Output

The output JSON contains the response from the Green API endpoint that provides group information. This typically includes details such as:

  • Group name
  • List of participants
  • Admins within the group
  • Other metadata related to the group

The exact structure depends on the Green API's response format but generally returns an object with group properties.

No binary data output is involved in this operation.

Dependencies

  • Requires valid credentials for the Green API service, including an instance ID and an API token.
  • The node makes HTTP POST requests to the Green API endpoints.
  • No additional environment variables are needed beyond the configured credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing Group ID will cause the request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "Failed to get group data: <error message>" indicates the API call failed. Check the Group ID and credentials.
    • Errors during file reading or malformed input parameters are not applicable here since this operation only requires a Group ID.

  • Resolution tips:

    • Verify the Group ID format and existence.
    • Ensure the API credentials are correctly configured and active.
    • Confirm network access to the Green API endpoints.

Links and References

  • Green API Documentation (for detailed API reference)
  • WhatsApp Group ID format explanation: Typically ends with @g.us indicating a group chat.

This summary focuses exclusively on the "Get Group Data" operation under the "Group" resource in action mode, as requested.

Discussion