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 details about chat files associated with a specific WhatsApp number. The "Get File Details" operation under the "Chat Files" resource allows users to fetch metadata or information about a particular file that has been sent or received via WhatsApp on the specified device.

Common scenarios where this node is beneficial include:

Retrieving detailed information about media files (images, videos, documents) shared in WhatsApp chats for auditing or processing.
Integrating WhatsApp file metadata into other systems such as CRMs or document management platforms.
Automating workflows that require validation or logging of WhatsApp file exchanges.

Practical example:

A user wants to automatically log all images received on a WhatsApp business number into a database. Using this node, they can get the file details by specifying the WhatsApp number and the file ID, then extract relevant metadata for storage.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number/device from which to retrieve the file details.
File ID	The unique identifier of the file whose details are to be fetched.

Output

The node outputs a JSON object containing the details of the requested file. This typically includes metadata such as file name, size, type, timestamp, and possibly URLs or references to download the file content.

If the node supports binary data output (not explicitly shown here), it would represent the actual file content or a downloadable stream related to the file.

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.
The "WhatsApp Number" must correspond to a valid registered device within the SparkBot system.
Proper permissions and API access rights to query file details are necessary.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp Number or File ID parameters will cause errors.
- Network connectivity problems or incorrect API credentials may result in authentication failures.
- Requesting details for a non-existent or deleted file will likely return an error or empty response.
Error messages and resolutions:
- "Invalid WhatsApp Number": Verify the device ID is correct and registered.
- "File not found": Confirm the File ID exists and belongs to the specified WhatsApp number.
- "Authentication failed": Check that the API key credential is correctly set up and has required permissions.
- "Network error": Ensure stable internet connection and that the SparkBot API endpoint is reachable.

Links and References

SparkBot WhatsApp API Documentation (hypothetical link)
n8n documentation on Creating Custom Nodes
General WhatsApp Business API concepts for understanding file handling.

SparkBotInstall