Actions20
- Customer Actions
- Whatsapp Web Actions
- Whatsapp Gupshup Actions
Overview
This node, named "Cloudia," enables sending messages through various resources including WhatsApp via the Gupshup platform. Specifically, the Send Document Template operation under the Whatsapp Gupshup resource allows users to send templated document messages to customers on WhatsApp using predefined templates managed by Gupshup.
Typical use cases include:
- Automating customer communication with personalized document templates (e.g., invoices, contracts).
- Sending standardized documents to multiple recipients efficiently.
- Integrating WhatsApp messaging into business workflows for notifications or confirmations.
For example, a business can send an invoice template populated with customer-specific data and a link to the document hosted online, directly to the customer's WhatsApp number.
Properties
Name | Meaning |
---|---|
Cloudia API Key | An API key string used for authentication if not using stored credentials. |
Channel Integration ID | Numeric ID identifying the specific WhatsApp channel integration to send the message through. |
Phone Number | The recipient's phone number in international format (e.g., 5511999999999). |
Name | The name of the customer to personalize the message. |
Template ID | Identifier of the WhatsApp message template to be used for sending the document. |
Template Parameters | A collection of parameters to fill variables defined within the selected template. Each parameter has a value. |
Media URL | URL pointing to the media/document file to be sent as part of the template message. |
Additional Fields | Optional additional fields that can be added to extend the message payload (currently empty in definition). |
Output
The node outputs a JSON array where each element corresponds to the response from the Cloudia API for each input item processed. The structure of each output JSON object depends on the API response but generally includes confirmation details about the sent message.
No binary data output is produced by this node.
Dependencies
- Requires access to the Cloudia API service.
- Needs either an API key provided directly in the node property or configured credentials for authentication.
- The
Channel Integration ID
must correspond to a valid WhatsApp channel set up in the Cloudia/Gupshup platform. - Internet connectivity to reach the Cloudia API endpoints.
Troubleshooting
- Invalid API Key or Missing Credentials: If authentication fails, ensure the API key is correct and active or that credentials are properly configured.
- Incorrect Channel Integration ID: Using an invalid or inactive channel ID will cause message sending failures.
- Malformed Phone Number: Phone numbers must be in the correct international format without spaces or special characters.
- Template ID Not Found: Ensure the template ID exists and is approved in the Gupshup WhatsApp account.
- Missing Required Fields: All required properties such as phone number, template ID, media URL, and customer name must be provided.
- Network Issues: Connectivity problems may cause request timeouts or failures.
Error messages thrown by the node typically indicate unsupported resources or operations if misconfigured, or relay API error messages returned by Cloudia.
Links and References
- Gupshup WhatsApp API Documentation
- WhatsApp Business API Templates
- Cloudia API General Documentation (if publicly available)