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 groups. Specifically, the "Get Groups" operation under the "Groups" resource allows users to retrieve group chats associated with a selected WhatsApp number (device). This is useful for scenarios where you want to list or manage WhatsApp groups linked to a particular WhatsApp account.

Practical examples include:

Fetching all group chats of a specific WhatsApp number to display in a dashboard.
Filtering groups by type (e.g., standard groups vs broadcast lists) for targeted messaging or analytics.
Paginating through large sets of groups to process them in batches.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which to fetch groups.
Filter by Kind	Filters groups by their kind; options are: "Group" (standard group chats) and "Broadcast" (broadcast lists). Only applicable when fetching device group chats.
Results Page Size	Number of results to return per page when listing groups.
Page Number	The page number to retrieve, starting from 0, used for pagination of group results.

Output

The node outputs JSON data representing the groups retrieved from the specified WhatsApp number. Each item in the output array corresponds to a group chat with details as provided by the SparkBot API. The exact structure depends on the API response but typically includes group identifiers, names, types (group or broadcast), and possibly metadata about participants or messages.

No binary data output is indicated for this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot API service being accessible and properly configured.
The "WhatsApp Number" property must correspond to a valid registered WhatsApp device within the SparkBot system.
The node uses internal methods to load available devices dynamically.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp number/device ID will cause the operation to fail.
- Network or authentication errors if the API key is incorrect or expired.
- Pagination parameters out of range may result in empty responses.
Error Messages:
- Errors returned from the API will be surfaced in the node's output if "Continue On Fail" is enabled.
- Typical error messages might include "Unauthorized", "Device not found", or "Invalid page number".
Resolutions:
- Verify that the API key credential is correctly set up and has necessary permissions.
- Ensure the WhatsApp number/device ID exists and is active.
- Adjust pagination parameters to valid ranges.

Links and References

SparkBot WhatsApp API Documentation (hypothetical link)
n8n Documentation on Creating Custom Nodes
General WhatsApp Business API concepts for understanding group chats and broadcasts.

SparkBotInstall