Maytapi icon

Maytapi

Integrate with Maytapi WhatsApp Unofficial API

Actions55

Group → Get Group

AI-generated

Overview

The "Get Group" operation of the Maytapi node retrieves detailed information about a specific WhatsApp group using its Group ID. It can optionally generate an invite link for the group. This operation is useful when you want to fetch metadata and current state of a WhatsApp group, such as its participants, settings, or invite link.

Practical examples:

  • Fetching group details to display in a dashboard.
  • Retrieving the invite link to share with new members.
  • Auditing group membership or configuration before performing administrative actions.

Properties

Name Meaning
Phone ID Source Select how to provide the Phone ID: "From Credentials" (use Phone ID stored in credentials) or "Custom" (enter a custom Phone ID).
Phone ID The WhatsApp instance Phone ID to use if "Custom" is selected as Phone ID Source.
Group ID The unique identifier of the WhatsApp group (conversation ID ending with @g.us).
Generate Invite Link Boolean flag to indicate whether to generate an invite link for the specified group.

Output

The output JSON contains the response from the Maytapi API for the requested group. This typically includes group metadata such as group name, participants, admins, description, and other group-related information. If the "Generate Invite Link" option is enabled, the response will also include the generated invite link for the group.

No binary data is output by this operation.

Example output structure (simplified):

{
  "id": "905301234567-1574073754@g.us",
  "name": "My WhatsApp Group",
  "participants": [...],
  "admins": [...],
  "description": "...",
  "inviteLink": "https://chat.whatsapp.com/...",
  ...
}

Dependencies

  • Requires an API key credential for Maytapi WhatsApp Unofficial API.
  • The Phone ID must be provided either via credentials or custom input.
  • The node makes HTTP requests to the Maytapi API endpoint https://api.maytapi.com/api.

Troubleshooting

  • Missing Phone ID: If neither credentials nor custom Phone ID is provided, the node throws an error "Phone ID is required."
  • Invalid Group ID: Providing an incorrect or malformed Group ID may result in API errors or empty responses.
  • API Errors: Network issues or invalid API keys will cause request failures; ensure valid credentials and network connectivity.
  • Invite Link Generation: If "Generate Invite Link" is enabled but the group does not allow invite links or the API fails, the invite link field may be missing or null.

Links and References

Discussion