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 chat contact associated with a given WhatsApp number. The "Get Contact Details" operation under the "Chat Contacts" resource fetches comprehensive data about a contact, optionally including related entities such as chat history.

Common scenarios where this node is beneficial include:

Fetching up-to-date contact details for customer support or CRM integration.
Retrieving contact metadata before sending personalized messages.
Auditing or analyzing communication history with a particular contact.

For example, a user might input a WhatsApp number and a contact ID to get the contact's profile information and optionally include recent chat data to understand the context of previous interactions.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which to retrieve the contact details.
Contact ID	The unique identifier of the contact (e.g., `447362053576@c.us`) whose details are fetched.
Include Items	Optional related entities to include in the response. Currently supports: `Chat` (includes chat history related to the contact).

Output

The output is a JSON object containing the detailed information of the specified contact. This includes standard contact fields such as name, phone number, status, and possibly other metadata depending on the API response.

If the "Include Items" property includes "Chat," the output will also contain related chat data associated with the contact, providing conversation history or message summaries.

No binary data output is indicated for this operation.

Dependencies

Requires an active connection to the SparkBot WhatsApp API.
Needs an API key credential configured in n8n to authenticate requests.
The node depends on the internal method executeChatContactOperations to perform the actual API call for this resource and operation.

Troubleshooting

Missing or invalid WhatsApp Number: Ensure that the WhatsApp number (device) provided is valid and correctly loaded via the node’s device loading method.
Invalid Contact ID: The contact ID must be in the correct format (e.g., 447362053576@c.us). Incorrect IDs will result in errors or empty responses.
API Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
Network or API Downtime: Temporary connectivity issues or API service interruptions can cause failures; retry after some time.
Empty or incomplete response: If "Include Items" is used, ensure the requested related entities exist for the contact.

Error messages typically reflect these issues and should guide users to check their inputs and credentials.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n documentation on Creating Custom Nodes
WhatsApp contact ID format explanation: Usually <phone_number>@c.us for individual contacts.

Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

SparkBotInstall