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 chat message. The "Get Message Details" operation under the "Chat Messages" resource allows users to fetch metadata and content related to a particular message sent or received via a specified WhatsApp number.

Typical use cases include:

Auditing or logging message details for compliance or record-keeping.
Fetching message status or content for customer support follow-up.
Integrating message data into CRM or analytics platforms.

For example, a user might input a WhatsApp number and a message ID to retrieve the full details of that message, such as its timestamp, sender info, and message content.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the message was sent or received.
Message ID	The unique identifier of the WhatsApp message (hexadecimal ID) whose details are fetched.

Output

The output is a JSON object containing detailed information about the requested WhatsApp message. This typically includes fields such as:

Message content (text, media references, etc.)
Sender and recipient identifiers
Timestamp and status metadata
Any additional message attributes provided by the SparkBot API

If the node supports binary data (e.g., media files attached to messages), it would be included in the binary output field, representing the actual file content.

Dependencies

Requires an active connection to the SparkBot WhatsApp API.
Needs an API key credential configured in n8n for authentication.
The node depends on internal methods that handle various resources; for this operation, it specifically calls the chat message operations handler.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number or message ID parameters will cause errors.
- Network or authentication failures when connecting to the SparkBot API.
- Message ID not found if the message does not exist or belongs to a different WhatsApp number.
Error messages:
- Errors indicating missing required parameters should be resolved by providing valid inputs.
- Authentication errors require checking the API key credential configuration.
- Not found errors suggest verifying the correctness of the message ID and WhatsApp number.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n documentation on Creating Custom Nodes
General WhatsApp Business API guides for understanding message IDs and device numbers

SparkBotInstall