SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node interacts with the SparkBot WhatsApp API to manage outbound messages. Specifically, the "Delete Message" operation under the "Outbound Messages" resource allows users to delete a previously sent outbound message by its ID. This can be useful in scenarios where a message was sent in error or needs to be retracted.

Practical examples include:

  • Automatically deleting messages that contain sensitive information after a certain condition is met.
  • Removing messages that failed delivery or are no longer relevant.
  • Managing message lifecycle programmatically within automated workflows.

Properties

Name Meaning
Message ID The unique identifier of the outbound message to delete.
Force Delete Whether to force deletion of the message even if it has already been delivered or is processing. Options: true or false.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm whether the message was successfully deleted or provide details about the failure.

If the node supports binary data output (not indicated here), it would relate to any files or media associated with the message, but for this operation, the output is purely JSON confirming deletion status.

Dependencies

  • Requires an API key credential for authenticating with the SparkBot WhatsApp API.
  • The node depends on the external SparkBot WhatsApp API service to perform message deletion.
  • Proper network connectivity and valid permissions on the API key are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Message ID: The node requires a valid message ID; ensure the ID exists and is correctly provided.
    • Permission errors: The API key must have rights to delete messages.
    • Attempting to delete a message that is already delivered or processing without setting "Force Delete" to true may fail.
  • Error messages:

    • "Message not found": Check that the Message ID is correct.
    • "Unauthorized" or "Permission denied": Verify API key credentials and permissions.
    • "Cannot delete message": May occur if the message is delivered or processing and force delete is false; try enabling force delete.

Links and References

Discussion