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 "Get Messages" operation under the "Chat Messages" resource allows users to retrieve WhatsApp chat messages from a specified WhatsApp number (device). This node is useful for scenarios where you want to analyze, archive, or process WhatsApp conversations programmatically. For example, businesses can use it to fetch customer support chat histories, monitor message delivery statuses, or filter messages by type or date for reporting purposes.

Practical examples include:

Fetching all inbound text messages received after a certain date.
Retrieving media messages (images, videos) sent in a specific group chat.
Filtering messages by delivery status such as only those that failed to send.
Paginating through large volumes of chat messages with sorting options.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which to retrieve messages.
Filters	A collection of optional filters to narrow down the messages returned:
- Flow	Filter messages by direction: Inbound or Outbound.
- Delivery Status	Filter messages by delivery acknowledgment status: Pending, Sent, Delivered, Read, Failed.
- WhatsApp IDs	Filter messages by one or more WhatsApp message IDs (WID).
- Search	Search messages by text content, contact name, or media filename.
- Chat ID	Filter messages by the WhatsApp ID of the chat (user, group, or channel).
- From	Return messages sent from a given phone number or WhatsApp WID.
- To	Return messages received to a given phone number or WhatsApp WID.
- Chat Type	Filter messages by chat type: Chat, Group, Channel, Community.
- Reference	Filter messages by an exact match on the reference field.
- Message Type	Filter messages by type: Text, Image, Audio, Voice, Video, Document, Contact, Location, System.
- Sync Messages	Boolean flag indicating whether to sync messages from the WhatsApp session if no messages are available locally.
- Begin From Message ID	Return newest messages starting from the given message ID.
- End At Message ID	Return oldest messages starting from the given message ID.
- Created After	Return messages created after the specified date/time.
- Created Before	Return messages created before the specified date/time.
- Include	Include nested related documents per message: Contact, Chat, Media.
- Sort	Sort messages by date: Recent First or Oldest First.
- Results Page Size	Number of results to return per page.
- Page Number	Page number to return (starting from 0).
- Skip Messages	Number of previous messages to skip (only applicable if syncing messages).

Output

The output is a JSON array where each item represents a chat message matching the specified filters. Each message object may include:

Core message details such as message ID, timestamp, sender and receiver info, message content, and message type.
Delivery status and metadata.
Optionally included nested objects depending on the "Include" property:
- Contact information related to the message.
- Chat details (e.g., group or channel info).
- Media metadata if the message contains media attachments.

If binary data is involved (e.g., media files), it would be represented accordingly, but this operation primarily returns structured JSON data about messages.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API service.
The node depends on the external SparkBot WhatsApp API to fetch messages.
Proper configuration of the WhatsApp number (device) within the connected account is necessary.
The node uses internal methods to load options dynamically for devices and groups.

Troubleshooting

No messages returned: Ensure the correct WhatsApp number (device) is selected and that messages exist for the applied filters. If using sync, verify the WhatsApp session is active.
Authentication errors: Confirm that the API key credential is valid and has sufficient permissions.
Invalid filter values: Check that filter values like message IDs, dates, and chat IDs are correctly formatted.
Pagination issues: When paginating, ensure page numbers and sizes are set appropriately; zero-based indexing applies.
Timeouts or slow responses: Large queries with many filters or large page sizes may cause delays; try reducing page size or narrowing filters.

Links and References

SparkBot WhatsApp API Documentation
WhatsApp Business API Concepts
n8n Documentation on Creating Custom Nodes

SparkBotInstall