Actions148
- Chats Actions
- Chat Contacts Actions
- Chat Messages Actions
- Chat Files Actions
- Files Actions
- Team Actions
- Labels Actions
- Departments Actions
- Quick replies Actions
- Queue Actions
- WhatsApp session Actions
- WhatsApp profile Actions
- Business catalog Actions
- Campaigns Actions
- Meeting Links Actions
- User Status Actions
- Webhooks Actions
- Other Actions
- Send messages Actions
- Outbound Messages Actions
- WhatsApp Numbers Actions
- Groups Actions
- Channels Actions
Overview
This node enables sending multimedia messages via the SparkBot WhatsApp API. It supports sending various media types such as images, documents, videos, and audio files to individual phone numbers, groups, or channels on WhatsApp. The node is useful for automating communication workflows that require rich media content delivery, such as marketing campaigns, customer support with attachments, or broadcasting multimedia announcements.
Practical examples include:
- Sending a promotional video to a list of customers.
- Delivering product brochures as PDF documents to a group chat.
- Sharing audio messages or voice notes in a channel.
- Automating multimedia notifications triggered by events in other systems.
Properties
| Name | Meaning |
|---|---|
| WhatsApp number | The target SparkBot Number ID used for message delivery. This identifies the WhatsApp number/account from which the message will be sent. |
| Target | Type of target chat: Phone (individual), Group, or Channel. |
| Phone Number | Target phone number in international E.164 format (e.g., +1234567890). Required if Target is "Phone". |
| Group ID | The ID of the target WhatsApp group chat (e.g., 12345678902401234@g.us). Required if Target is "Group". |
| Channel ID | The ID of the target WhatsApp channel (e.g., 12345678902402200@newsletter). Required if Target is "Channel". |
| File URL | URL of the media file to send (image, document, video, audio). Required for sending multimedia messages. |
| Message | Text message content to be sent alongside or separately from media. |
| Options | Collection of optional settings including: - Priority (Normal, High, Low) - Custom label to categorize the message - Reference ID for tracking - Team agent to send on behalf of - Real-time sending mode toggle - Delivery queue mode (default, always queue, never queue, opportunistic) - Maximum retries for delivery - Post-delivery chat actions (assign, resolve, label management, metadata updates) |
| Message Expiration | Defines time-to-live (TTL) for the message using seconds, duration string (e.g., "1h"), or specific date/time when the message expires. |
| Mark Chat as Read | Boolean flag to notify WhatsApp that previous unread messages in the chat are read after this message is delivered (blue double-check). |
| Typing simulation | Number of seconds (2-30) to simulate typing or recording status before sending the message; 0 disables this feature. |
| Quote Message | Message ID to quote when sending this message, allowing replies to specific messages within the same conversation. |
| Strict Message Order | Boolean to ensure messages are sent in strict order to the target chat, useful for chatbots or sequences. Not compatible with real-time or never queue delivery modes. |
Output
The node outputs JSON data representing the result of the message sending operation. This typically includes details such as message IDs, status, timestamps, and any metadata returned by the SparkBot API confirming successful delivery or errors.
If binary data is involved (e.g., media files), it is handled internally by the API and not directly output by the node.
Dependencies
- Requires an API key credential for authenticating with the SparkBot WhatsApp API.
- Network access to the URLs of media files to be sent.
- Proper configuration of SparkBot WhatsApp numbers, groups, and channels within the SparkBot platform.
- Optional dependencies on team agents, labels, departments, and other entities managed via SparkBot for advanced message routing and post-delivery actions.
Troubleshooting
- Invalid phone number format: Ensure phone numbers follow the E.164 format (e.g., +1234567890). The node validates this and will throw an error if invalid.
- Missing required fields: For example, if Target is "Group" but no Group ID is provided, the node will fail. Always provide required properties based on the selected target type.
- Media URL issues: The media URL must be valid and accessible. Invalid URLs or unsupported media types will cause message sending to fail.
- Delivery queue misconfiguration: Using real-time delivery modes ("never queue") at high message rates can lead to bans by WhatsApp. Use queue modes appropriately.
- Agent or department assignment errors: When specifying post-delivery chat actions involving agents or departments, ensure the IDs are valid 24-character hexadecimal strings.
- Message quoting restrictions: Quoting only works for messages within the same conversation and requires valid message IDs.
- Typing simulation and strict order incompatibility: Strict message order cannot be used with live mode or never queue options.