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 integrates with the SparkBot WhatsApp API to manage chat files associated with WhatsApp numbers. Specifically, the Download File operation under the Chat Files resource allows users to download a file that was shared or received in a WhatsApp chat.

Typical use cases include:

Automatically retrieving media files (images, videos, documents) sent or received via WhatsApp for archiving or processing.
Integrating WhatsApp file downloads into workflows such as CRM updates, content moderation, or backup systems.
Enabling automated handling of customer-shared files in support or sales automation scenarios.

For example, a user can configure this node to download an image file sent by a customer on WhatsApp and then upload it to a cloud storage service or analyze it with an AI service.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the file will be downloaded. This identifies the specific WhatsApp account.
File ID	The ID of the file to download. This uniquely identifies the file within the selected WhatsApp number's chat files.

Output

The node outputs JSON data representing the downloaded file's details and content. While the exact structure depends on the API response, typically it includes metadata about the file (such as filename, size, MIME type) and the file content itself.

If the file is binary (e.g., images, videos), the node may output the file data in a binary format suitable for further processing or saving within n8n workflows.

Dependencies

Requires an active connection to the SparkBot WhatsApp API.
Needs an API key credential configured in n8n to authenticate requests.
The node relies on dynamic loading methods to fetch available WhatsApp numbers and files (getDevices and getFiles), so proper API access and permissions are necessary.

Troubleshooting

Common issues:
- Invalid or expired API key leading to authentication errors.
- Incorrect WhatsApp number or file ID causing "file not found" errors.
- Network connectivity problems preventing API calls.
Error messages:
- "error": "File not found" — Verify the File ID and WhatsApp Number are correct and correspond to existing files.
- "error": "Authentication failed" — Check that the API key credential is valid and has not expired.
- Timeout or network errors — Ensure stable internet connection and that the SparkBot API endpoint is reachable.

Resolving these usually involves verifying credentials, confirming input parameters, and checking network status.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n Documentation on Creating Custom Nodes (for extending or debugging nodes)

Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

SparkBotInstall