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 Channels" operation of the Channels resource in this node allows users to retrieve information about communication channels associated with a specific WhatsApp number. This is useful for managing and monitoring the different channels through which messages can be sent or received on that WhatsApp device.

Typical use cases include:

Listing all available channels for a given WhatsApp number to understand how messages are routed.
Filtering channels by permission type to find those with specific access rights.
Paginating through large sets of channels when many exist for a device.

For example, a user might want to fetch all channels linked to their WhatsApp business number to audit permissions or integrate channel data into a CRM system.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) for which to retrieve channels.
Permission	(Optional) Filter channels by a specific permission type.
Results Page Size	(Optional) Number of results to return per page; defaults to 20.
Page Number	(Optional) The page number to retrieve, starting from 0 for the first page.

Output

The output is an array of JSON objects representing the channels retrieved for the specified WhatsApp number. Each object contains details about a single channel, such as its identifier, permissions, and other metadata relevant to the channel's configuration and status.

If the node supports binary data output for channels (not indicated explicitly here), it would typically represent media or files associated with channels, but this operation primarily returns JSON data describing channels.

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 channel data.
Proper configuration of the API key credential within n8n is necessary for successful execution.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number ID will result in errors or empty responses.
- Incorrect API key or authentication failure will prevent data retrieval.
- Requesting pages beyond the available range may return empty results.
Error messages:
- Authentication errors indicate problems with the API key; verify and update credentials.
- Validation errors for required parameters mean the WhatsApp number ID was not provided.
- Network or API downtime errors require checking connectivity or service status.

Links and References

SparkBot WhatsApp API Documentation (generic link, replace with actual if known)
n8n documentation on Creating Custom Nodes
Pagination concepts in APIs: API Pagination Best Practices

SparkBotInstall