Maytapi icon

Maytapi

Integrate with Maytapi WhatsApp Unofficial API

Actions55

Queue → Clear Queue

AI-generated

Overview

The "Clear Queue" operation of the Maytapi node allows users to clear the message queue for a specific WhatsApp phone instance managed via the Maytapi WhatsApp Unofficial API. This is useful in scenarios where queued messages need to be discarded or reset, such as when troubleshooting message delivery issues or resetting the state of a WhatsApp instance's outgoing message queue.

Practical examples:

  • Clearing accumulated unsent messages after a network outage.
  • Resetting the message queue before starting a new batch of communications.
  • Managing message flow by removing stale or unwanted queued messages.

Properties

Name Meaning
Phone ID Source Select how to provide the Phone ID: either "From Credentials" (uses Phone ID stored in credentials) or "Custom" (enter a custom Phone ID).
Phone ID The WhatsApp instance Phone ID to target. Required if "Phone ID Source" is set to "Custom".

Output

The output JSON contains the response from the Maytapi API after attempting to clear the message queue. It typically includes success status and any relevant messages returned by the API.

Example structure:

{
  "success": true,
  "message": "Queue cleared successfully"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Maytapi WhatsApp Unofficial API.
  • The Phone ID must be provided either via credentials or manually as a custom input.
  • The node makes HTTP requests to the Maytapi API endpoint https://api.maytapi.com/api.

Troubleshooting

  • Error: "Phone ID is required."
    Occurs if no Phone ID is provided either in credentials or as a custom value. Ensure that the Phone ID is correctly set in credentials or entered manually.

  • API request failures may occur due to invalid API keys, network issues, or incorrect Phone IDs. Verify API credentials and network connectivity.

  • If the queue does not clear as expected, confirm that the Phone ID corresponds to an active WhatsApp instance and that the Maytapi service is operational.

Links and References

Discussion