Evolution API

Interagir com a Evolution API v2

Overview

This node integrates with the Evolution API v2 to manage WhatsApp-related functionalities, specifically for groups, instances, messages, chats, events, and integrations. The "Buscar Link de convite do Grupo" (Fetch Group Invite Link) operation under the "Grupo" (Group) resource retrieves the invitation link for a specified WhatsApp group.

Use cases include automating the retrieval of group invite links to share them programmatically or use them in workflows that require group joining links without manual intervention.

For example, you can use this node to fetch the invite link of a WhatsApp group after creating it or when you want to distribute the invite link via other channels automatically.

Properties

Name Meaning
Instance Name The name of the WhatsApp instance to operate on.
Group ID The unique identifier of the WhatsApp group for which to fetch the invite link.

Output

The node outputs a JSON object containing the response from the Evolution API regarding the group invite link. The output includes:

  • The invite link or code associated with the specified group.
  • A success boolean indicating if the operation was successful.
  • A timestamp marking when the operation was performed.

If the API returns an array or string, the node attempts to parse it into JSON. In case of failure, it wraps the raw value in a JSON structure.

No binary data is output by this operation.

Example output structure (simplified):

{
  "inviteCode": "https://chat.whatsapp.com/ExampleInviteLink",
  "success": true,
  "timestamp": "2024-06-01T12:00:00.000Z"
}

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Evolution API.
  • The node depends on the Evolution API v2 endpoints being accessible and properly configured.
  • The user must provide valid instance names and group IDs corresponding to their WhatsApp environment managed by the Evolution API.

Troubleshooting

  • Invalid Instance Name or Group ID: If the provided instance name or group ID is incorrect or does not exist, the API will likely return an error or empty response. Verify these inputs carefully.
  • Authentication Errors: Ensure the API key credential is correctly set up and has permissions to access group information.
  • Network Issues: Connectivity problems to the Evolution API endpoint may cause timeouts or failures.
  • Parsing Errors: If the API returns unexpected data formats, the node might fail to parse the response. Check the API response format and update the node or API accordingly.
  • Permission Denied: The WhatsApp instance might not have permission to fetch invite codes if the group settings restrict such operations.

Links and References

Discussion