Actions17
Overview
This node integrates with the Z-API WhatsApp service to send various types of WhatsApp messages and perform related chat actions. Specifically, the "Send Text" operation under the "Message" resource allows users to send plain text messages to individual phone numbers or groups via WhatsApp.
Common scenarios where this node is beneficial include:
- Automating customer notifications or alerts through WhatsApp.
- Sending personalized messages in bulk campaigns.
- Integrating WhatsApp messaging into workflows for support, marketing, or transactional communication.
For example, a business could use this node to automatically send order confirmations or appointment reminders as WhatsApp messages to customers.
Properties
| Name | Meaning |
|---|---|
| Instance | Your Z-API instance ID, identifying your WhatsApp API instance. |
| Token | Your Z-API token used for authenticating API requests. |
| Client Token | Your Z-API client token required for authorization headers in API calls. |
| Phone | The recipient's phone number or group ID where the message will be sent. |
| Message | The text content of the WhatsApp message to send. |
Output
The node outputs a JSON array where each element corresponds to the response from the Z-API after sending the message. The structure of each response depends on the API but generally includes status information about the message delivery.
No binary data output is produced by this operation.
Example output snippet (simplified):
[
{
"sent": true,
"messageId": "some-message-id",
"phone": "120363029102538932-group"
}
]
Dependencies
- Requires an active Z-API WhatsApp instance with valid credentials: instance ID, token, and client token.
- The node makes HTTP POST requests to the Z-API endpoints.
- Proper network connectivity to
https://api.z-api.iois necessary. - No additional environment variables are required beyond the provided credentials.
Troubleshooting
- Invalid Credentials: If the instance ID, token, or client token are incorrect or expired, the API will reject requests. Verify and update credentials accordingly.
- Incorrect Phone Number Format: Ensure the phone number or group ID is correctly formatted as expected by Z-API (e.g., including country code).
- API Rate Limits: Excessive requests may lead to throttling; monitor usage limits on your Z-API account.
- Network Issues: Connectivity problems can cause request failures; check firewall and internet access.
- Error Messages: The node throws errors if the operation is unsupported or parameters are missing. Review error messages for guidance and ensure all required fields are set.