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

The node integrates with the SparkBot WhatsApp API to perform various operations related to WhatsApp messaging and management. Specifically, for the Queue resource with the Get Queue Status operation, it retrieves the current status of the message queue associated with a specified WhatsApp number. This is useful for monitoring message flow, understanding backlog, or managing message dispatching in automated WhatsApp communication workflows.

Practical examples include:

Checking if there are pending messages waiting to be sent on a particular WhatsApp number.
Monitoring queue length to optimize message sending rates.
Integrating queue status checks into larger automation flows to trigger alerts or adjust behavior based on queue load.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number whose message queue status you want to retrieve. Options are dynamically loaded from available WhatsApp numbers configured in the system.

Output

The output is a JSON object representing the status of the message queue for the selected WhatsApp number. It typically includes details such as the number of messages currently queued, their states, and possibly timestamps or identifiers relevant to the queue.

If the node supports binary data output (not indicated here), it would represent any files or media related to the queue status, but this operation primarily returns JSON data.

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 numbers requires that the system has WhatsApp numbers registered and accessible via the API.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number ID: Ensure the selected WhatsApp number exists and is correctly loaded.
- Authentication errors: Verify that the API key credential is valid and has necessary permissions.
- Network or API downtime: Check connectivity to the SparkBot API endpoint.
Error messages:
- Errors returned by the API will be surfaced in the node output if "Continue On Fail" is enabled.
- Typical error messages might include "Unauthorized", "Not Found", or "Invalid parameter".
Resolutions:
- Confirm credentials and permissions.
- Validate input parameters.
- Retry after network issues resolve.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n documentation on Creating Custom Nodes

SparkBotInstall