Maytapi icon

Maytapi

Integrate with Maytapi WhatsApp Unofficial API

Actions55

Group → Get Group Info by Invite Code

AI-generated

Overview

This node operation "Get Group Info by Invite Code" allows you to retrieve detailed information about a WhatsApp group using an invite code. This is useful when you have received a group invite code (for example, from a webhook event) and want to fetch metadata about the group such as its name, participants, or other details without needing the full group ID.

Common scenarios include:

  • Automatically fetching group details after receiving an invite link.
  • Validating or displaying group information before joining or processing group-related workflows.
  • Integrating with systems that manage WhatsApp groups based on invite codes.

Example: After receiving a webhook notification containing a group invite code, use this operation to get the group's name, description, and participant list for further automation or logging.

Properties

Name Meaning
Phone ID Source Select how to provide the Phone ID: either "From Credentials" (default) or "Custom".
Phone ID If "Custom" is selected above, enter your WhatsApp instance Phone ID here (required).
Invite Code (for Group Info) The invite code string used to retrieve the group information (received from webhook).

Output

The output JSON contains the response from the Maytapi API endpoint /group/getGroupInfoByInviteCode/{inviteCode}. It typically includes detailed information about the WhatsApp group associated with the invite code, such as:

  • Group ID
  • Group name
  • Description
  • Participants list
  • Possibly other metadata related to the group

The exact structure depends on the API response but generally provides comprehensive group details.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for the Maytapi WhatsApp Unofficial API.
  • The node expects a valid Phone ID, which can be provided either via credentials or custom input.
  • Network access to https://api.maytapi.com/api is required.

Troubleshooting

  • Missing Phone ID: If neither credentials nor custom Phone ID is provided, the node will throw an error stating "Phone ID is required." Ensure you configure the Phone ID correctly.
  • Invalid Invite Code: Providing an incorrect or expired invite code may result in an API error or empty response. Verify the invite code is correct and current.
  • API Errors: Any errors returned by the Maytapi API (e.g., rate limits, invalid tokens) will be surfaced as node errors. Check your API key validity and usage limits.
  • Network Issues: Connectivity problems to the Maytapi API endpoint will cause failures. Confirm network access and proxy settings if applicable.

Links and References

Discussion