Overview

This node interacts with the Z-API service to perform various operations related to WhatsApp messaging and management. Specifically, for the 'Instance' resource with the 'Get Status' operation, it retrieves the current status of a WhatsApp instance connected via Z-API. This is useful for monitoring the availability and health of the WhatsApp instance, ensuring it is ready to send and receive messages.

Use Case Examples

1. A user wants to check if their WhatsApp instance is online before sending bulk messages.
2. A workflow needs to verify the instance status to trigger alerts if the instance goes offline.

Output

JSON

• status - The current status of the WhatsApp instance, such as online, offline, or error state
• instanceId - Identifier of the WhatsApp instance whose status is retrieved
• timestamp - The time at which the status was retrieved

Dependencies

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

Troubleshooting

• If the node returns an error related to authentication, verify that the Z-API credential is correctly configured and valid.
• If the status response is empty or unexpected, ensure the WhatsApp instance is properly connected and active in the Z-API service.
• Network issues or API downtime may cause failures; check connectivity and Z-API service status.

Links

• Z-API Documentation - Official documentation for Z-API, including details on instance management and status retrieval.