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 detailed information about a specific WhatsApp number by its ID. It is useful in scenarios where you need to fetch configuration or status details of a WhatsApp number managed within the SparkBot system, such as for monitoring, auditing, or integrating WhatsApp number data into workflows.

For example, you might use this node to:

Retrieve a WhatsApp number's profile and session details.
Include additional related data like agents assigned to the number, catalog items, or quick replies configured.
Exclude certain information such as session or profile data to reduce payload size.

Properties

Name	Meaning
WhatsApp Number ID	The unique identifier of the WhatsApp number to retrieve.
Include Options	Collection of options to customize the response:
Include	Select additional related information to include in the response. Options: Agents, Catalog, Quick Replies
Exclude	Select information to exclude from the response. Options: Session, Profile, Stats, Queue

Output

The node outputs a JSON object containing the details of the specified WhatsApp number. The structure includes core number information plus any optionally included or excluded sections based on the input properties:

Core number data (ID, status, etc.)
Optionally included arrays or objects for:
- Agents assigned to the number
- Business catalog linked to the number
- Quick replies configured for the number
Optionally excluded sections such as session info, profile details, statistics, or queue data

No binary data output is indicated for this operation.

Dependencies

Requires an active connection to the SparkBot WhatsApp API via an API key credential.
The node depends on the SparkBot API service being accessible and properly authenticated.
No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp Number ID will cause errors or empty responses.
- Network or authentication failures with the SparkBot API can result in request errors.
- Including or excluding incompatible options may lead to partial or unexpected data.
Error messages:
- Errors returned from the API typically include descriptive messages indicating missing parameters or authorization failures.
- If the node throws an error about loading devices, ensure the "WhatsApp Number ID" is valid and that the load options method is functioning correctly.
Resolutions:
- Verify the WhatsApp Number ID exists and is correct.
- Confirm API key credentials are valid and have sufficient permissions.
- Adjust include/exclude options to compatible combinations.

Links and References

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

SparkBotInstall