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 retrieve the status of a specific WhatsApp user by their status ID. It is useful in scenarios where you need to check or monitor the current status information of a WhatsApp user associated with a particular WhatsApp number managed via SparkBot.

Practical examples include:

Fetching a user's current WhatsApp status message or presence for customer support automation.
Monitoring user statuses to trigger workflows based on status changes.
Integrating WhatsApp user status data into CRM or analytics platforms.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which to fetch the user status. This is selected from available WhatsApp numbers linked to the account.
Status ID	The unique identifier of the user status to retrieve. It must be a hexadecimal string of length 20-22 or 24 characters.

Output

The node outputs JSON data representing the details of the requested user status. This typically includes fields such as the status content, timestamp, and any metadata provided by the SparkBot API about that status entry.

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

Dependencies

Requires an active connection to the SparkBot WhatsApp API.
Needs an API key credential configured in n8n for authenticating requests to the SparkBot service.
The node depends on internal methods grouped under user status operations within the bundled codebase.

Troubleshooting

Common issues:
- Invalid or missing Status ID format: Ensure the Status ID is a valid hexadecimal string of the correct length.
- Incorrect WhatsApp Number selection: Verify that the WhatsApp number (device) exists and is correctly linked.
- Authentication errors: Confirm that the API key credential is properly set up and has sufficient permissions.
- Network or API downtime: Check connectivity and SparkBot service status.
Error messages:
- Errors related to "status not found" indicate the Status ID does not exist or is inaccessible.
- Authentication failures will prompt errors about invalid credentials.
- Input validation errors if required parameters are missing or malformed.

Resolving these usually involves verifying input parameters, checking credential configuration, and ensuring the SparkBot API is operational.

Links and References

SparkBot WhatsApp API Documentation (example link, replace with actual)
n8n documentation on Creating Custom Nodes
General info on WhatsApp Business API usage and status management

SparkBotInstall