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 WhatsApp sessions, specifically allowing users to reset a WhatsApp session associated with a particular WhatsApp number (device). Resetting a session can be useful in scenarios where the session becomes unresponsive, corrupted, or when you want to clear stored data and queued messages to start fresh.

Practical examples include:

Clearing all chat history and queued messages for a specific WhatsApp number to troubleshoot issues.
Waiting for a device to become available before proceeding with further automation steps.
Selectively deleting only queued messages without affecting stored chats or contacts.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) whose session you want to reset. This is selected from available devices.
Options	Collection of optional flags to customize the reset behavior:
- Delete All Data	Whether to delete all stored chats, messages, and contacts data associated with the device.
- Wait For Session	Whether to wait for the device to become available before completing the operation (may delay response up to 2 minutes).
- Empty Queue	Whether to delete all queued messages currently pending in the device's message queue.

Output

The node outputs JSON data representing the result of the reset session operation. This typically includes confirmation of the reset action and any relevant status information returned by the SparkBot API.

No binary data output is produced by this node.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot service being accessible and the specified WhatsApp number (device) being registered and recognized by the API.
The "WhatsApp Number" options are dynamically loaded via a method that fetches available devices from the API.

Troubleshooting

Common Issues:
- Invalid or expired API key leading to authentication failures.
- Specifying a WhatsApp number (device) that does not exist or is not registered.
- Network connectivity problems preventing communication with the SparkBot API.
- Long delays if "Wait For Session" option is enabled and the device takes time to become available.
Error Messages:
- Authentication errors: Check that the API key credential is correctly configured and valid.
- Device not found: Verify the WhatsApp number ID is correct and the device is active.
- Timeout waiting for session: If using the wait option, ensure the device is online and reachable.

Resolving these usually involves verifying credentials, checking device IDs, and ensuring network access to the SparkBot API.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n Documentation on Creating Custom Nodes
General WhatsApp Business API concepts for context on sessions and devices.

SparkBotInstall