Actions17
Overview
This node enables sending WhatsApp messages through the Z-API WhatsApp service. Specifically, for the Message resource and Send Video operation, it sends a video file to a specified phone number or group via WhatsApp by providing a video URL and optional caption.
Common scenarios where this node is useful include:
- Automating marketing campaigns by sending promotional videos.
- Customer support workflows that require sharing tutorial or product videos.
- Broadcasting event highlights or announcements in video format to groups or individual contacts.
Example: Sending a product demo video with a caption "Check out our latest features!" to a customer’s WhatsApp number.
Properties
| Name | Meaning |
|---|---|
| Instance | The Z-API instance ID used to identify your WhatsApp API session. |
| Token | The Z-API token for authenticating API requests. |
| Client Token | The client token required for additional API authentication headers. |
| Phone | The recipient's phone number or group ID where the video will be sent. |
| Video URL | The direct URL of the video file to send via WhatsApp. |
| Caption | Optional text caption to accompany the video message. |
Output
The node outputs a JSON object representing the response from the Z-API WhatsApp service after attempting to send the video message. This typically includes status information about the message delivery, such as success confirmation or error details.
No binary data output is produced by this operation.
Dependencies
- Requires access to the Z-API WhatsApp service.
- Needs valid credentials: an instance ID, a token, and a client token for authentication.
- The node makes HTTP POST requests to the Z-API endpoints.
- Proper network connectivity to reach
https://api.z-api.iois necessary.
Troubleshooting
- Invalid Credentials: If the instance ID, token, or client token are incorrect or expired, the API will reject the request. Verify and update credentials accordingly.
- Invalid Phone Number or Group ID: Ensure the phone number or group ID is correctly formatted and registered on WhatsApp.
- Video URL Issues: The video URL must be publicly accessible and directly link to a video file. Private URLs or unsupported formats may cause failures.
- API Rate Limits: Excessive requests might lead to throttling; monitor usage and respect API limits.
- Error Messages: The node throws errors if the operation is not supported or parameters are missing. Check error messages for guidance and ensure all required fields are provided.
Links and References
- Z-API WhatsApp Documentation (for detailed API usage and credential setup)
- WhatsApp Business API Overview (general background on WhatsApp messaging APIs)