Evolution APIInstall

Overview

The node integrates with the Evolution API v2 to manage WhatsApp-related resources such as instances, messages, groups, chats, events, and integrations. Specifically, for the Grupo resource and the Encontrar Participantes operation, it retrieves the list of participants in a specified WhatsApp group.

This operation is useful when you want to programmatically access the members of a WhatsApp group, for example:

• To audit or monitor group membership.
• To send targeted messages or notifications to group members.
• To synchronize group member data with other systems.

Properties

Output

The output is a JSON array containing the participants of the specified group. Each item in the array represents a participant and includes details as returned by the Evolution API. Additionally, the output includes metadata fields:

• success: Boolean indicating if the operation was successful.
• timestamp: ISO string timestamp of when the response was generated.
• count: Number of participants found (if the response is an array).

Example structure of output JSON (simplified):

{
  "items": [
    {
      "id": "participant1_id",
      "name": "Participant One",
      "phone": "1234567890",
      "...": "other participant details"
    },
    {
      "id": "participant2_id",
      "name": "Participant Two",
      "phone": "0987654321",
      "...": "other participant details"
    }
  ],
  "success": true,
  "count": 2,
  "timestamp": "2024-06-01T12:00:00.000Z"
}

No binary data is output by this operation.

Dependencies

• Requires an authenticated connection to the Evolution API v2 via an API key credential configured in n8n.
• The node uses the Evolution API endpoints to perform operations; thus, internet connectivity and valid API credentials are necessary.
• The user must provide the correct instance name and group ID corresponding to their WhatsApp environment.

Troubleshooting

• Common issues:

  • Invalid or missing instance name: Ensure the instance name matches an active WhatsApp session registered in the Evolution API.
  • Incorrect group ID: Verify the group ID is accurate and that the instance has access to the group.
  • Authentication errors: Confirm that the API key credential is correctly set up and has permissions to access group data.
  • Network or API downtime: Check network connectivity and Evolution API service status.

• Error messages:

  • "401 Unauthorized" or similar authentication errors indicate invalid or expired API credentials.
  • "404 Not Found" may mean the group ID or instance name does not exist.
  • "500 Internal Server Error" suggests server-side issues; retry later or contact support.

To resolve errors, verify input parameters, check API credentials, and consult Evolution API documentation or support.

Links and References

• Evolution API Documentation (hypothetical link, replace with actual if available)
• n8n Documentation on Creating Custom Nodes
• WhatsApp Group Management Concepts: https://faq.whatsapp.com/general/chats/how-to-create-and-manage-groups

This summary focuses on the "Grupo" resource and the "Encontrar Participantes" operation as requested.