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 → Join Channel

AI-generated

Overview

This node allows you to join a WhatsApp channel using the SparkBot WhatsApp API. It supports joining channels either by providing an invite code or an invite URL. This functionality is useful for automating the process of joining specific WhatsApp channels programmatically, which can be beneficial in scenarios such as managing community groups, customer support channels, or broadcast lists within WhatsApp.

For example, you might use this node to automatically join a marketing channel when onboarding a new user or to join a support channel to monitor incoming messages.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) that will perform the join operation.
Join Method	Method to join the channel. Options: "Invite Code" or "Invite URL".
Invite Code	The invitation code to join the channel (required if Join Method is "Invite Code").
Invite URL	The invitation URL to join the channel (required if Join Method is "Invite URL").

Output

The node outputs JSON data representing the result of the join channel operation. The exact structure depends on the API response from the SparkBot service but typically includes confirmation of the join action and any relevant metadata about the joined channel.

No binary data output is indicated.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node relies on the SparkBot API endpoints related to channel operations.
Proper configuration of the WhatsApp number (device) is necessary to perform actions on behalf of that number.

Troubleshooting

Common issues:
- Invalid or expired invite codes or URLs will cause the join operation to fail.
- Using a WhatsApp number (device) that is not properly registered or authenticated with the SparkBot API may result in errors.
- Network or API connectivity issues can prevent successful execution.
Error messages:
- Errors related to invalid invite codes/URLs usually indicate that the provided invitation details are incorrect or no longer valid.
- Authentication errors suggest problems with the API key or device registration.
Resolutions:
- Verify the invite code or URL is correct and active.
- Ensure the API key credential is valid and has the necessary permissions.
- Confirm the WhatsApp number/device is correctly set up and linked.
- Check network connectivity and API endpoint availability.

Links and References

WhatsApp Channels Invitation (for understanding invite URLs)
SparkBot API documentation (refer to your SparkBot API provider's official docs for detailed usage)

SparkBotInstall