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 manage WhatsApp sessions, specifically allowing users to request an authentication code for a WhatsApp number. This operation is useful when setting up or re-authenticating a WhatsApp device session, such as when connecting a new phone number or forcing a new login session.

Typical use cases include:

Initiating the WhatsApp login process by requesting an authentication code sent to a specified phone number.
Forcing a new authentication code request by destroying any existing session tied to the WhatsApp number.
Managing multiple WhatsApp devices/numbers within an automation workflow.

For example, you might use this node to programmatically trigger sending an auth code to a user's phone during onboarding or to reset a session if connectivity issues occur.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number/device to request the auth code for. Loaded dynamically from available devices.
Force New Authentication	Boolean flag indicating whether to destroy any existing session and force a new authentication code request.
Phone Number	The phone number in E.164 format (e.g., +16001234560) to which the authorization code will be sent. Required if the device was never connected before.

Output

The node outputs JSON data representing the result of the authentication code request operation. This typically includes status information about the request, such as success confirmation or error details.

No binary data output is involved in this operation.

Dependencies

Requires an active connection to the SparkBot WhatsApp API via an API key credential configured in n8n.
The node depends on dynamic loading of available WhatsApp devices/numbers to populate the "WhatsApp Number" property.
Proper network access to the SparkBot service endpoint is necessary.

Troubleshooting

Common Issues:
- Requesting an auth code for a device that does not exist or is not registered may fail.
- Providing an invalid or improperly formatted phone number (not in E.164 format) can cause errors.
- Attempting to request a new auth code without setting the "Force New Authentication" flag when a session already exists may not behave as expected.
Error Messages:
- Errors related to missing or invalid phone numbers usually indicate the need to provide a valid E.164 formatted number.
- Authentication failures may require checking the API key credential configuration.
- Network or API errors should be resolved by verifying connectivity and SparkBot service status.

Links and References

E.164 Phone Number Formatting
SparkBot WhatsApp API documentation (refer to your service provider's official docs for detailed API usage)

SparkBotInstall