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 integrates with the SparkBot WhatsApp API to manage WhatsApp numbers. Specifically, the Create Number operation under the WhatsApp Numbers resource allows users to create and register a new WhatsApp number within their SparkBot account.

Typical use cases include:

Automating the provisioning of WhatsApp numbers for customer support or marketing campaigns.
Managing multiple WhatsApp numbers programmatically as part of a larger communication platform.
Quickly setting up new WhatsApp channels with specific billing plans and configurations.

For example, a business could use this node to automatically add a new WhatsApp number with a "Business" subscription plan and assign it an alias for easy identification in their system.

Properties

Name	Meaning
Alias	Alias or name for the WhatsApp number (2-30 characters). Used to identify the number internally.
Billing Plan	Subscription plan for the WhatsApp number. Options: Professional, Business, Enterprise, Gateway Professional, Gateway Business, Gateway Enterprise, Platform Professional, Platform Business, Platform Enterprise.
Additional Options	Collection of optional settings:
- Description	Optional description for the WhatsApp number (max 80 characters).
- Agent IDs	List of agent IDs to provide shared chat access (only applicable for Platform plans).
- Payment Intent	Payment intent ID string (starts with "pi_"), likely related to payment processing or invoicing.

Output

The node outputs JSON data representing the result of the create number operation. This typically includes details about the newly created WhatsApp number such as its ID, alias, billing plan, status, and any other metadata returned 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 service being accessible and properly configured.
No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

Common issues:
- Invalid alias length (must be between 2 and 30 characters).
- Unsupported or misspelled billing plan option.
- Providing agent IDs when using non-Platform plans will have no effect.
- Incorrect or missing payment intent ID format.
- Network or authentication errors if the API key is invalid or expired.
Error messages:
- Errors from the API will be surfaced as error messages in the node output.
- If the node is set to continue on fail, errors will appear in the JSON output under an error property.
- To resolve, verify input parameters, ensure valid API credentials, and check network connectivity.

Links and References

SparkBot WhatsApp API Documentation (hypothetical link, replace with actual if available)
n8n documentation on Creating Custom Nodes
General WhatsApp Business API info: https://developers.facebook.com/docs/whatsapp

If you need further details on other operations or resources, feel free to ask!

SparkBotInstall