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
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
Files Actions
- Search Files
- Upload File
- Delete Files
- Get File Preview
- Download File
- Get File
- Update File
- Delete File
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

Channels → Get Channel

AI-generated

Overview

This node interacts with the SparkBot WhatsApp API, specifically allowing operations on various resources including Channels. The "Get Channel" operation retrieves detailed information about a specific WhatsApp channel associated with a given WhatsApp number.

Typical use cases include:

Fetching metadata or configuration details of a particular WhatsApp channel.
Managing multiple WhatsApp channels by retrieving their current state or settings.
Integrating channel data into workflows for reporting or automation purposes.

For example, a user might want to get the details of a marketing newsletter channel linked to a WhatsApp number to verify its status before sending messages.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the channel is associated.
Channel ID	The unique identifier of the channel to retrieve (e.g., `123000098765421000` or `123000098765421000@newsletter`).

Output

The node outputs JSON data representing the retrieved channel's details. This typically includes all relevant properties of the channel such as its ID, name, type, status, and any other metadata provided by the SparkBot API.

No binary data output is indicated for this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot API service being accessible and properly configured.
No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp Number or Channel ID parameters will cause errors.
- Network connectivity problems or incorrect API credentials can lead to authentication failures.
- Requesting a non-existent channel ID may result in a "channel not found" error.
Error messages and resolutions:
- "error": "Invalid API key" — Verify that the API key credential is correctly set up.
- "error": "Channel not found" — Confirm the Channel ID is correct and exists under the specified WhatsApp Number.
- Timeout or network errors — Check internet connection and SparkBot API availability.

Links and References

SparkBot WhatsApp API Documentation (example link; replace with actual if available)
n8n documentation on creating custom nodes

SparkBotInstall