Actions37
- Instance Actions
- Message Actions
- Group Actions
- Contact Actions
- Chat Actions
- Campaign Actions
- Chatbot Actions
Overview
This node integrates with the UazAPI service to manage WhatsApp instances and perform various operations on them. Specifically, for the Instance - Get Status operation, it retrieves the current status of a WhatsApp instance managed by UazAPI.
Typical use cases include:
- Monitoring whether a WhatsApp instance is connected and operational.
- Checking the health or connection state of an instance before sending messages or performing other actions.
- Automating workflows that depend on the availability of a WhatsApp instance.
For example, you might use this node in an automation to periodically check if your WhatsApp instance is online and ready to send messages, triggering alerts or fallback logic if it is not.
Properties
| Name | Meaning |
|---|---|
| Instance Name | Unique name identifier of the WhatsApp instance (required for most instance operations except "Get Status" which does not require it explicitly) |
Note: For the Get Status operation, the node does not require the "Instance Name" property as input because it calls a general status endpoint without specifying an instance name.
Output
The output JSON contains the response from the UazAPI /instance/status endpoint. This typically includes details about the current state of the WhatsApp instance such as:
- Connection status (e.g., connected, disconnected)
- QR code data if waiting for pairing
- Any error or warning messages related to the instance
- Other metadata about the instance's operational state
The exact structure depends on the UazAPI response but generally provides comprehensive status information useful for monitoring and decision-making in workflows.
No binary data output is produced by this operation.
Dependencies
- Requires an active credential setup providing:
- Base URL of the UazAPI service.
- API authentication tokens (e.g., admin token, instance token) managed securely within n8n credentials.
- The node uses HTTP requests authenticated via these credentials to communicate with the UazAPI endpoints.
Troubleshooting
Common Issues:
- Network connectivity problems preventing access to the UazAPI base URL.
- Invalid or expired API authentication tokens causing authorization failures.
- UazAPI service downtime or endpoint changes leading to unexpected errors.
Error Messages:
- Authentication errors: Check that the API key/token credentials are correctly configured and valid.
- HTTP request failures: Verify network access and correct base URL configuration.
- Unexpected response format: Confirm that the UazAPI version matches the node expectations.
Resolution Tips:
- Revalidate and update API credentials in n8n.
- Test connectivity to the UazAPI base URL outside n8n.
- Review UazAPI documentation or support channels for any recent changes.
Links and References
- UazAPI Official Documentation (example placeholder, replace with actual link if available)
- WhatsApp Automation Concepts: Useful for understanding instance management and messaging workflows.
- n8n HTTP Request Node Documentation: For understanding how authenticated HTTP requests work within n8n.
This summary focuses exclusively on the Instance - Get Status operation of the UazAPI node based on static analysis of the provided source code and property definitions.