Actions10
Overview
This node integrates with the Z-API service to send various types of WhatsApp messages programmatically. Specifically, the Send GIF operation under the Send Message resource allows users to send GIF media files to a specified phone number via WhatsApp.
Common scenarios for this node include automating customer engagement, sending promotional or informational GIFs, and enhancing chatbot interactions with rich media content.
For example, a marketing automation workflow could use this node to send a branded GIF to customers after they sign up or complete a purchase.
Properties
| Name | Meaning |
|---|---|
| Instance ID | Your Z-API Instance ID used to identify your messaging instance. |
| Instance Token | Your Z-API Instance Token for authenticating API requests (kept secret). |
| Client Token | Your Z-API Client Token for additional authentication (kept secret). |
| Phone | The recipient's phone number in international format (e.g., 5511999999999). Required field. |
| URL or Base64 | The URL or base64-encoded string of the GIF media to be sent. Required field. |
| Additional Fields | Optional settings including: • Delay Message: seconds to wait before sending the message (1-15). • Delay Typing: seconds to show "Typing..." status before sending (0-15). • Message ID to Reply: ID of a message to reply to. |
Output
The node outputs an array of JSON objects representing the response from the Z-API service for each message sent. Each object contains details about the success or failure of the message delivery.
If the operation succeeds, the output JSON typically includes confirmation data such as message IDs or status codes returned by the API.
No binary data is output by this node; it strictly returns JSON responses.
Dependencies
- Requires access to the Z-API WhatsApp messaging service.
- Requires three credentials: Instance ID, Instance Token, and Client Token for authentication.
- The node makes HTTP POST requests to the Z-API endpoints.
- No additional environment variables are required beyond the provided credentials.
Troubleshooting
- Invalid Credentials: If the Instance ID, Instance Token, or Client Token are incorrect or expired, the API will reject requests. Verify and update these tokens in the node configuration.
- Invalid Phone Number Format: Ensure the phone number is in the correct international format without spaces or special characters.
- Invalid Media URL/Base64: The GIF URL must be accessible and valid, or the base64 string must be correctly encoded. Otherwise, the API may return errors.
- Unknown Operation Error: If an unsupported operation is selected, the node throws an error indicating the operation is not known.
- Delays Out of Range: Delay values must be within the allowed range (Delay Message: 1-15 seconds, Delay Typing: 0-15 seconds). Values outside this range may cause errors.
- Reply Message ID: If replying to a message, ensure the message ID exists and is valid; otherwise, the reply may fail.
To resolve errors, check the error message details returned by the node and verify all input parameters and credentials.
Links and References
- Z-API Official Documentation (for API details and credential management)
- WhatsApp Business API Media Messages (general reference on media message formats)