Actions64
- Instance Actions
- Message Actions
- Group Actions
- Profile Actions
- Event Actions
- Integration Actions
- Chat Actions
Overview
This node interacts with the Evolution API to fetch group information based on different search methods. It supports fetching groups by invite code, by group ID, or fetching all groups. Additionally, when fetching all groups, it can optionally retrieve the list of participants for each group. This node is useful for scenarios where you need to manage or analyze group data from the Evolution API, such as retrieving group details for communication or administrative purposes.
Use Case Examples
- Fetch a specific group using its invite code to get detailed information about that group.
- Retrieve group information by providing a group ID to access specific group data.
- Fetch all groups available in the instance and optionally include the list of participants for each group, useful for bulk processing or reporting.
Properties
| Name | Meaning |
|---|---|
| Instance Name | The name of the instance to connect to the Evolution API, required to identify the target environment. |
| Search Method | The method used to search for groups, which can be by invite code, by group ID, or fetching all groups. |
| Invite Code | The invite code of the group to fetch, required when searching by invite code. |
| Group ID | The ID of the group to fetch, required when searching by group ID. |
| Get Participants | A boolean flag indicating whether to retrieve the list of participants for each group when fetching all groups. |
Output
JSON
groupId- The unique identifier of the group.groupName- The name of the group.inviteCode- The invite code associated with the group.participants- An optional list of participants in the group, included if requested.
Dependencies
- Requires an API key credential for authentication with the Evolution API.
Troubleshooting
- Ensure the instance name is correctly specified to avoid connection errors.
- When using 'By Invite Code' or 'By Group ID' search methods, verify that the invite code or group ID is valid and exists in the system.
- If fetching all groups with participants, be aware that the operation might take longer due to additional data retrieval.
- Common errors include unsupported operation errors if the specified operation or resource is incorrect, and authentication errors if the API key credential is missing or invalid.