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 manage WhatsApp chats. Specifically, the Unarchive Chat operation under the Chats resource allows users to unarchive a previously archived chat on a specified WhatsApp number. This is useful in scenarios where archived conversations need to be restored for active communication or follow-up.

Practical examples:

A customer support team wants to reopen a resolved chat that was archived to continue assisting the customer.
A sales agent needs to unarchive a group chat to add new participants or update the conversation.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the chat will be unarchived.
Chat ID	The unique identifier of the chat to unarchive. Examples include user chats (`447362053576@c.us`) or group chats (`44736205357600000000@g.us`).

Output

The node outputs JSON data representing the result of the unarchive chat operation. This typically includes confirmation details such as the chat ID and status indicating the chat has been successfully unarchived.

If the operation fails, the output JSON may contain an error message describing the issue.

No binary data output is involved in this operation.

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 be registered and active within the SparkBot system.
The chat ID must correspond to an existing archived chat on the specified WhatsApp number.

Troubleshooting

Common issues:
- Providing an invalid or inactive WhatsApp number ID.
- Using a chat ID that does not exist or is not archived.
- Network or authentication failures with the SparkBot API.
Error messages:
- "Chat not found": The provided chat ID does not exist on the device.
- "Chat is not archived": Attempting to unarchive a chat that is already active.
- "Authentication failed": Invalid or missing API key credential.
Resolutions:
- Verify the WhatsApp number ID is correct and active.
- Confirm the chat ID corresponds to an archived chat.
- Ensure the API key credential is valid and has necessary permissions.
- Check network connectivity and SparkBot service status.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n Documentation on Creating Custom Nodes
WhatsApp Business API general info: https://www.whatsapp.com/business/api

Note: The above summary is based solely on static analysis of the provided source code and property definitions.

SparkBotInstall