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, specifically allowing management of WhatsApp sessions. The "Reboot session" operation under the "WhatsApp session" resource enables users to reboot a WhatsApp device session remotely. This can be useful in scenarios where a WhatsApp session becomes unresponsive or needs to be refreshed without manual intervention on the device.

Practical examples include:

Automatically rebooting a WhatsApp session if message sending fails due to session issues.
Forcing a session reboot during maintenance windows.
Synchronizing session data after reboot to ensure up-to-date status.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) whose session you want to reboot. Loaded dynamically from available devices.
Options	Collection of optional flags to customize the reboot behavior:
- Force Reboot	Whether to force the device reboot even if it is already stopped (boolean).
- Wait For Session	Whether to wait for the device session to become available after reboot, which may delay response up to 90 seconds (boolean).
- Force Sync	Whether to force synchronization of the device session after reboot (boolean).

Output

The node outputs JSON data representing the result of the reboot operation. This typically includes status information about the reboot request and possibly updated session details. The exact structure depends on the API response but generally confirms whether the reboot was successful.

No binary data output is involved in this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node relies on dynamic loading of WhatsApp device IDs via a method named getDevices.
Network connectivity to the SparkBot API endpoint is necessary.
No additional environment variables are explicitly required beyond the API key.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp Number (device ID): Ensure the device ID is selected from the dynamically loaded options.
- API authentication failures: Verify that the API key credential is correctly configured and has sufficient permissions.
- Timeout when waiting for session availability: If "Wait For Session" is enabled, the node may take up to 90 seconds; network delays or device issues could cause longer waits or failures.
Error Messages:
- Errors returned by the API will be surfaced as error messages in the node output.
- If the node is set to continue on failure, errors will appear in the JSON output under an error field.
Resolutions:
- Double-check device IDs and API credentials.
- Retry with "Force Reboot" enabled if the session does not reboot normally.
- Disable "Wait For Session" if immediate response is preferred and handle session availability separately.

Links and References

SparkBot WhatsApp API Documentation (example placeholder, replace with actual URL if known)
n8n Documentation on Creating Custom Nodes
General WhatsApp Business API concepts for session management.

SparkBotInstall