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 interacts with the SparkBot WhatsApp API to manage message queue processing status for a specified WhatsApp number. Specifically, the "Set Queue Status" operation allows users to control how messages are handled in the queue — whether messages should be delivered, paused, rejected, or frozen.

Common scenarios where this node is beneficial include:

Temporarily pausing message delivery during maintenance or downtime without losing incoming messages.
Rejecting new messages while still delivering existing queued messages, useful when limiting load.
Freezing the queue to stop all message processing and reject new messages, for emergency stops.
Forcing immediate delivery of all queued messages for a limited time to catch up on backlog.

Practical example: A customer support team wants to pause message delivery during shift changes but still accept new messages to avoid losing any. They can set the queue status to "Pause" using this node.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number whose message queue status you want to control.
Status	The desired queue processing status: - Active: Deliver messages and accept new ones. - Pause: Do not deliver messages but accept new ones. - Reject: Deliver existing messages but reject new ones. - Freeze: Do not deliver messages and reject new ones.
Force Delivery	Boolean flag to force delivery of all queued messages immediately for 30 minutes. Only works if status is "Active" or "Reject".

Output

The node outputs JSON data representing the result of the queue status update operation. This typically includes confirmation details such as the updated status and any relevant metadata returned by the SparkBot API.

No binary data output is produced by 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.
The "WhatsApp Number" must be valid and associated with the authenticated account.

Troubleshooting

Invalid WhatsApp Number: If the provided WhatsApp number ID is incorrect or not linked to your account, the API will likely return an error. Verify the number ID via the device list.
Unauthorized / Authentication Errors: Ensure that the API key credential is correctly set up and has sufficient permissions.
Unsupported Status with Force Delivery: The "Force Delivery" option only works when the status is set to "Active" or "Reject". Using it with "Pause" or "Freeze" may cause errors or be ignored.
Network Issues: Connectivity problems with the SparkBot API endpoint can cause failures. Check network access and retry.
API Rate Limits: Excessive requests might be throttled; handle errors gracefully and implement retries if needed.

Links and References

SparkBot WhatsApp API Documentation (example link, replace with actual)
n8n Documentation on Creating Custom Nodes
General info on WhatsApp Business API queue management concepts

SparkBotInstall