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 information about WhatsApp numbers associated with the user's account. Specifically, the "Get Numbers" operation under the "WhatsApp Numbers" resource allows users to fetch a list of WhatsApp numbers filtered by various criteria such as IDs, status, session status, or search terms. This is useful for managing and monitoring multiple WhatsApp numbers in automation workflows.

Common scenarios:

Fetching all operative WhatsApp numbers to send messages or perform further actions.
Filtering numbers by session status (e.g., online or offline) to determine availability.
Searching for specific numbers by phone number, alias, or ID.
Paginating through large sets of WhatsApp numbers for batch processing.

Practical example:
A customer support team uses this node to get all currently operative WhatsApp numbers that are online, then routes incoming messages accordingly or triggers notifications if any number goes offline.

Properties

Name	Meaning
Filters	A collection of filters to narrow down the WhatsApp numbers returned:
- WhatsApp Number IDs	Filter by specific WhatsApp number IDs (multiple values allowed).
- Status	Filter by the status of the WhatsApp numbers. Options: Operative, Pending, Disabled, Removed.
- Session Status	Filter by the session status of the WhatsApp numbers. Options: Authorize, Online, Timeout, Offline, Error.
- Search Term	Search WhatsApp numbers by phone number, alias, or ID using a text string.
- Results Page Size	Number of results to return per page (default 50).
- Page Number	The page number to retrieve, starting from 0 (default 0).

Output

The node outputs an array of JSON objects representing WhatsApp numbers matching the specified filters. Each object contains details about a WhatsApp number such as its ID, phone number, alias, status, session status, and other metadata provided by the SparkBot API.

If binary data were involved (not applicable here), it would be summarized accordingly, but this operation returns only 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.
No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

Common issues:
- Incorrect or missing API key credential will cause authentication failures.
- Using invalid filter values (e.g., unsupported status or session status) may result in empty responses or errors.
- Pagination parameters out of range might lead to no results returned.
Error messages:
- Authentication errors typically indicate invalid or expired API keys; recheck and update credentials.
- Validation errors on filters suggest checking the allowed options for status and session status.
- Network or API downtime errors require verifying connectivity and SparkBot service status.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n documentation on Creating Custom Nodes
General info on WhatsApp Business API usage and management

SparkBotInstall