z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages

Overview

This node interacts with the Z-API to perform operations related to WhatsApp groups. Specifically, the 'Get Group Metadata' operation retrieves detailed metadata about a specified WhatsApp group using its Group ID. This is useful for scenarios where you need to fetch information about a group, such as its participants, settings, or other metadata, for automation or integration purposes.

Use Case Examples

  1. Fetching metadata of a WhatsApp group to display group details in a dashboard.
  2. Automating workflows that require group information before sending messages or performing other group-related actions.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group for which metadata is to be retrieved.

Output

JSON

  • groupId - The ID of the group for which metadata was retrieved.
  • metadata - The detailed metadata information of the specified WhatsApp group.

Dependencies

  • Requires an API key credential for Z-API to authenticate requests.

Troubleshooting

  • Ensure the Group ID is correct and the bot or API user has access to the group; otherwise, the metadata retrieval will fail.
  • Common errors may include authentication failures if the API key is invalid or missing, or permission errors if the group ID is incorrect or the bot is not a member of the group.

Links

  • Z-API Documentation - Official documentation for Z-API, detailing available endpoints and usage instructions.

Discussion