SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node integrates with the SparkBot WhatsApp API to manage WhatsApp numbers among other resources. Specifically, for the Delete Number operation under the WhatsApp Numbers resource, it allows users to delete a WhatsApp number from their SparkBot account by specifying its unique ID.

Common scenarios where this node is beneficial include:

  • Cleaning up or deactivating WhatsApp numbers that are no longer in use.
  • Managing active WhatsApp numbers programmatically as part of automation workflows.
  • Integrating WhatsApp number lifecycle management into broader customer engagement or communication pipelines.

For example, a user might automate the removal of WhatsApp numbers that have been inactive for a certain period or remove test numbers after completing QA cycles.

Properties

Name Meaning
WhatsApp Number ID The unique identifier of the WhatsApp number to delete. This ID must be provided to specify which number to remove.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation details such as success status or any relevant metadata returned by the SparkBot API upon deletion.

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 the API key having sufficient permissions to delete WhatsApp numbers.
  • No additional environment variables or external services are explicitly required beyond the API key.

Troubleshooting

  • Common Issues:

    • Providing an invalid or non-existent WhatsApp Number ID will likely cause the operation to fail.
    • Insufficient permissions associated with the API key can prevent deletion.
    • Network connectivity issues or SparkBot API downtime may cause errors.
  • Error Messages:

    • Errors related to "number not found" indicate the specified WhatsApp Number ID does not exist.
    • Authentication errors suggest problems with the API key credentials.
    • Rate limiting or quota exceeded errors may occur if too many requests are made in a short time.
  • Resolutions:

    • Verify the WhatsApp Number ID is correct and currently exists.
    • Ensure the API key used has the necessary rights to perform deletions.
    • Check network connectivity and SparkBot service status.
    • Implement error handling in workflows to manage rate limits gracefully.

Links and References

Discussion