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 service to perform operations related to WhatsApp chats. Specifically, the 'Archive Chat' operation allows users to archive a chat by providing the phone number associated with the chat. This is useful for managing chat organization and decluttering the active chat list in WhatsApp.

Use Case Examples

  1. Archiving a chat with a specific contact by providing their phone number with country code.
  2. Automating chat management workflows by archiving chats programmatically.

Properties

Name Meaning
Phone Number The phone number with country code of the chat to be archived. This is a required string input.

Output

JSON

  • json - The JSON output contains the response from the Z-API service after attempting to archive the specified chat. This typically includes success or error information related to the archive operation.

Dependencies

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

Troubleshooting

  • Ensure the phone number is provided in the correct format including the country code, e.g., '5511999999999'.
  • If the API key credential is invalid or missing, the node will fail to authenticate with Z-API.
  • Network issues or API downtime may cause request failures; check connectivity and Z-API service status.
  • Errors returned from Z-API will be included in the output JSON; review these messages for troubleshooting.

Links

  • Z-API Official Website - Official documentation and information about the Z-API service used for WhatsApp integration.

Discussion