SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Send messages → Send text message

AI-generated

Overview

This node enables sending text messages via the SparkBot WhatsApp API. It supports sending messages to individual phone numbers, groups, or channels associated with a selected SparkBot number (device). The node is useful for automating WhatsApp communications such as customer support replies, marketing broadcasts, notifications, or chatbot interactions.

Practical examples include:

  • Sending a personalized text message to a customer’s phone number.
  • Broadcasting announcements to a WhatsApp group or channel.
  • Automating chat sequences with typing simulation and message quoting.
  • Managing message delivery priority and retry behavior.

Properties

Name Meaning
WhatsApp number The target SparkBot Number ID used to send the message. This identifies the WhatsApp account/device from which the message will be sent.
Target Type of target chat: Phone (individual phone number), Group (WhatsApp group chat), or Channel (broadcast channel).
Phone Number Target phone number in international E.164 format (e.g., +1234567890). Required if Target is Phone.
Group ID ID of the target WhatsApp group chat (e.g., 12345678902401234@g.us). Required if Target is Group.
Channel ID ID of the target WhatsApp channel (e.g., 12345678902402200@newsletter). Required if Target is Channel.
Message Text content of the message to be sent (up to 6000 characters).
Options Collection of optional settings including:
- Priority: Normal, High, Low
- Label: Custom label to categorize the message
- Reference ID: Custom reference string
- Team Agent: Send on behalf of an agent
- Live mode: Real-time sending without queue
- Delivery Queue Mode: Default, Always Queue, Never Queue, Opportunistic
- Maximum Retries: Number of delivery retries
- Chat Actions: Post-delivery actions like assign chat, resolve, add/remove labels, set metadata, etc.
Message Expiration Defines time-to-live (TTL) for the message using seconds, duration (e.g., "1h"), or specific date/time.
Mark Chat as Read Boolean to notify WhatsApp that previous unread messages are read after this message is delivered (blue double-check). Requires WhatsApp read confirmation enabled.
Typing simulation Seconds (0-30) to simulate typing or recording status before sending the message. Set 0 to disable.
Quote Message Message ID (18-32 hex characters) to quote when sending this message, referencing a previous message in the same conversation.
Strict Message Order Boolean to ensure messages are sent in strict order to the target chat. Useful for chatbots and sequences. Not compatible with live mode or never queue options.

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 were involved (not applicable here), it would represent media files or attachments sent.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • The node depends on SparkBot services for device management, group/channel lookup, team agents, labels, departments, and message delivery.
  • Proper configuration of SparkBot credentials and permissions is necessary.
  • Some options depend on dynamic loading of devices, groups, channels, labels, team agents, and departments via API calls.

Troubleshooting

  • Invalid phone number format: Ensure phone numbers use the E.164 format (e.g., +1234567890). The node validates this with a regex.
  • Missing required fields: Depending on the target type, either phone number, group ID, or channel ID must be provided.
  • Delivery failures: If messages fail to deliver, check the delivery queue mode and retry settings. Avoid using real-time modes ("never" queue) for high-volume messaging to reduce risk of WhatsApp bans.
  • Agent or department assignment errors: When performing chat actions like assigning chats, ensure valid 24-character hexadecimal IDs are used.
  • Typing simulation conflicts: Using typing simulation with live mode or strict message order may cause issues; these options are incompatible.
  • Message quoting restrictions: Quoted message IDs must be from the same conversation and match length/format requirements.
  • API authentication errors: Verify the API key credential is correctly configured and has sufficient permissions.

Links and References

Discussion