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 allows users to create a "Quick Reply" for WhatsApp via the SparkBot API. Quick Replies are predefined shortcut messages that can be sent quickly in conversations, improving response efficiency and consistency. This is particularly useful for customer support teams or sales agents who frequently send repetitive messages.

For example, a user might create a quick reply with the shortcut "hours" that sends the message "Our business hours are 9 AM to 5 PM, Monday through Friday." This saves time by avoiding typing the same message repeatedly.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) where the quick reply will be created.
Shortcut	A keyword shortcut (2-25 characters) used to trigger the quick reply.
Message	The content of the quick reply message (4-6000 characters).
Permission	Access permission level for the quick reply: Public, Read-only, or Private.
Include Media File	Whether to attach a media file along with the quick reply (true/false).
File ID	If including a media file, the ID of the previously uploaded file to attach (24 character hex).
Keywords	Optional list of up to 3 alphanumeric keywords associated with the quick reply.

Output

The node outputs JSON data representing the result of the quick reply creation operation. This typically includes details about the newly created quick reply such as its ID, shortcut, message content, permissions, and any attached media file information.

If a media file is included, the output will reflect the association of that file with the quick reply but does not output binary data directly.

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 (device) must be registered and available in the system.
If attaching media files, those files must have been previously uploaded and their IDs known.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number ID: Ensure the device ID is correct and loaded properly.
- Shortcut length errors: Shortcut must be between 2 and 25 characters.
- Message length errors: Message content must be between 4 and 6000 characters.
- File attachment errors: If including a media file, the file ID must be valid and correspond to an uploaded file.
- Permission value errors: Permission must be one of Public, Read-only, or Private.
Error messages:
- "Invalid device ID": Check the WhatsApp number selection.
- "Shortcut too short or too long": Adjust the shortcut length.
- "Message content invalid": Verify message length and content.
- "File ID required when including media": Provide a valid file ID if including media.
- Authentication errors: Verify API key credentials and connectivity.

Links and References

SparkBot WhatsApp API Documentation
n8n documentation on Creating Custom Nodes

SparkBotInstall