SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node enables sending a reaction emoji to a specific WhatsApp message via the SparkBot WhatsApp API. It is useful for automating interactions where acknowledging or responding to messages with emojis is needed, such as customer support workflows, chatbots, or engagement tracking.

Typical use cases include:

  • Sending a thumbs-up or other emoji reaction to confirm receipt of a message.
  • Removing a previously sent reaction by using a special "-" emoji.
  • Automating reactions in group chats or channels to streamline communication.

Properties

Name Meaning
WhatsApp number The target SparkBot Number ID used to send the reaction. This identifies which WhatsApp number/account will deliver the reaction.
Target Type of target chat: Phone (individual), Group, or Channel. Determines where the reaction will be sent.
Phone Number The recipient's phone number in international E.164 format (e.g., +1234567890). Required if Target is "Phone".
Group ID The ID of the target group chat (e.g., 12345678902401234@g.us). Required if Target is "Group".
Channel ID The ID of the target channel (e.g., 12345678902402200@newsletter). Required if Target is "Channel".
Message ID to React to The unique ID of the WhatsApp message to which the reaction emoji will be applied. Must be a valid hexadecimal string between 18 and 32 characters.
Emoji Reaction The emoji character to send as a reaction (e.g., πŸ‘). Use "-" to remove an existing reaction.
Options Additional optional settings including:
- Priority (Normal, High, Low)
- Custom label for categorization
- Reference ID
- Team agent on whose behalf the message is sent
- Real-time sending mode toggle
- Delivery queue mode
- Maximum retries
- Post-delivery chat actions (assign, resolve, label, metadata management)
Message Expiration Defines a time-to-live (TTL) for the reaction message, specified as seconds, duration (e.g., "1h"), or a specific date/time.
Mark Chat as Read Boolean flag to notify WhatsApp that previous unread messages are read after sending the reaction (blue double-check).
Typing simulation Number of seconds (0-30) to simulate typing or recording status before sending the reaction.
Quote Message Optionally quote another message by its ID when sending the reaction. Must be in the same conversation.
Strict Message Order Ensures 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 reaction operation. This typically includes confirmation details such as message IDs, status, or error information if the reaction failed.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • Needs proper configuration of the SparkBot number (WhatsApp account) to send messages.
  • Dependent on the availability of the target chat (phone, group, or channel) and valid message IDs.
  • Optional dependencies include team agents, labels, departments, and other entities for advanced options.

Troubleshooting

  • Invalid phone number format: Ensure the phone number is in E.164 format (e.g., +1234567890). Errors occur if the regex validation fails.
  • Invalid message ID: The message ID must be a hexadecimal string of length 18, 20, 24, or 32 characters. Incorrect IDs cause validation errors.
  • Reaction emoji issues: Using unsupported emojis or invalid characters may cause failures. Use standard emojis or "-" to remove reactions.
  • Delivery failures: If the message cannot be delivered due to network or API issues, check API credentials and SparkBot number status.
  • Queue mode conflicts: Using real-time delivery modes while sending many messages per minute can lead to bans or throttling by WhatsApp.
  • Permission errors: Assigning chats or performing post-delivery actions requires valid team agent or department IDs.
  • Typing simulation limits: Values outside 0-30 seconds are rejected.

Links and References

Discussion