SparkBot

Interact with SparkBot WhatsApp API

Actions148

Chats Actions
- Archive Chat
- Unarchive Chat
- Delete Chat
- Bulk Update Chats
- Get Chats
- Get Chat Details
- Send Typing Status
- Sync Device Chats
- Sync Chat Messages
- Update Chat Read Status
- Set Chat Status
- Get Group Participants
- Assign Chat
- Unassign Chat
- Create Chat Note
- Delete Chat Note
- Update Chat Labels
- Update Chat Attributes
Chat Contacts Actions
- Get Contacts
- Get Contact Details
- Create Contact
- Update Contact
- Update Contact Metadata
- Upsert Contact Metadata
- Delete Contact
- Bulk Create Contacts
- Block Contacts
- Unblock Contacts
Chat Messages Actions
- Get Messages
- Get Message Details
- Get Message Delivery Info
- Edit Message
- Delete Message
Chat Files Actions
- Get Files
- Get File Details
- Download File
Files Actions
- Delete Files
- Search Files
- Upload File
- Get File Preview
- Download File
- Get File
- Update File
- Delete File
Team Actions
- Get Team Members
- Update Team Member
- Delete Team Members
- Get Device Team Members
- Create Team Member
- Grant Device Access
- Revoke Device Access
Labels Actions
- Get Labels
- Create Label
- Update Label
- Delete Label
Departments Actions
- Get Departments
- Create Department
- Update Department
- Delete Department
Quick replies Actions
- Get Quick Replies
- Create Quick Reply
- Update Quick Reply
- Delete Quick Replies
Queue Actions
- Get Queue Status
- Set Queue Status
- Route Queue
- Empty Queue
WhatsApp session Actions
- Sync session
- Start session
- Scan QR
- Reset session
- Reboot session
- Get session health
- Request Authentication Code
WhatsApp profile Actions
- Get Profile
- Update Profile
- Get Profile Image
- Update Profile Image
Business catalog Actions
- Get My Catalog
- Query Business Catalog
Campaigns Actions
- Get Campaigns
- Get Campaign
- Update Campaign Status
- Get Campaign Contacts
- Delete Campaign
Meeting Links Actions
- Get Meeting Links
- Create Meeting Link
- Delete Meeting Links
User Status Actions
- Get User Status
- Get User Status by ID
- Update User Status
- Delete User Status
Webhooks Actions
- Get Webhooks
- Create Webhook
- Get Webhook
- Update Webhook
- Delete Webhook
- Enable Webhook
- Get Webhook Logs
Other Actions
- Verify number exists
- Validate phone numbers
- Send API request
Send messages Actions
- Send text message
- Send multimedia message
- Send scheduled message
- Send poll message
- Send votes in a poll
- Delete votes in a poll
- Send meeting event
- Send meeting confirmation
- Send location
- Send contacts
- Send reaction
- Send catalog product
- Forward message
Outbound Messages Actions
- Search Messages
- Get Message
- Update Message
- Delete Message
WhatsApp Numbers Actions
- Get Numbers
- Get Number by ID
- Create Number
- Update Number
- Delete Number
- Delete Chats
Groups Actions
- Get Groups
- Get Group
- Create Group
- Update Group
- Update Group Image
- Add Participants
- Update Participants
- Remove Participants
- Get Pending Members
- Approve Members
- Reject Members
- Get Invite Code
- Revoke Invite Code
- Join Group
- Leave Group
Channels Actions
- Get Channels
- Get Channel
- Create Channel
- Update Channel
- Update Channel Image
- Delete Channel
- Join Channel
- Search Channels

Overview

This node integrates with the SparkBot WhatsApp API to manage queued WhatsApp messages. Specifically, the Route Queue operation under the Queue resource allows users to reroute queued messages from one WhatsApp number (device) to another target WhatsApp number (device). This is useful in scenarios where message handling needs to be dynamically redirected, such as transferring message queues between different agents or devices for load balancing, failover, or operational reasons.

Practical examples:

Automatically rerouting all pending messages from a device that is going offline to another active device.
Redirecting message queues during shift changes among customer support agents.
Managing message flow by routing queues to specialized devices based on message content or priority.

Properties

Name	Meaning
WhatsApp Number	The ID of the source WhatsApp number/device whose queued messages are to be routed.
Target WhatsApp Number ID	The ID of the target WhatsApp number/device to which the queued messages will be rerouted.

Both properties require selecting from available WhatsApp devices loaded dynamically via the getDevices method.

Output

The node outputs JSON data representing the result of the queue routing operation. This typically includes confirmation details about the rerouting action, such as success status and any relevant metadata returned by the SparkBot API.

No binary data output is indicated for this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot service being accessible and properly configured.
Dynamic loading of WhatsApp devices requires the API to provide device information.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp device IDs can cause failures in rerouting.
- Network or authentication errors with the SparkBot API may prevent successful execution.
- Attempting to route queues when no messages are queued might return empty or error responses.
Error messages:
- Errors related to invalid device IDs usually indicate incorrect selection or expired device references.
- Authentication errors suggest problems with the provided API key credential.
- Timeout or connectivity errors imply network issues or API unavailability.

Resolution tips:

Verify that both source and target WhatsApp numbers are valid and currently registered devices.
Ensure the API key credential is correctly set up and has necessary permissions.
Check network connectivity and SparkBot API status.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n documentation on Creating Custom Nodes
General WhatsApp Business API concepts for queue management and message routing.

SparkBotInstall