Actions148
- Send messages Actions
- Outbound Messages Actions
- WhatsApp Numbers Actions
- Groups Actions
- Channels Actions
- Chats Actions
- Chat Contacts Actions
- Chat Messages Actions
- Chat Files Actions
- Team Actions
- Labels Actions
- Departments Actions
- Files Actions
- Quick replies Actions
- Queue Actions
- WhatsApp session Actions
- WhatsApp profile Actions
- Business catalog Actions
- Campaigns Actions
- Meeting Links Actions
- User Status Actions
- Webhooks Actions
- Other Actions
Overview
The "Empty Queue" operation for the Queue resource in this node allows users to delete queued WhatsApp messages from a specified WhatsApp number (device). This operation is useful for managing and cleaning up message queues, especially when you want to remove pending or scheduled messages that are no longer needed.
Common scenarios include:
- Clearing all queued messages before sending a new batch.
- Removing specific messages by their IDs.
- Deleting messages targeted to certain phone numbers or groups.
- Cleaning messages within a particular date range.
- Skipping scheduled messages if you want to preserve future deliveries.
Practical example:
If you have a WhatsApp number with many unsent messages queued due to network issues or errors, you can use this operation to empty the queue entirely or selectively based on filters, ensuring your queue is clean and ready for new messages.
Properties
| Name | Meaning |
|---|---|
| WhatsApp Number | The ID of the WhatsApp number (device) whose message queue you want to empty. |
| Wait for Completion | Whether to wait until all queued messages are deleted before returning a response. This may take up to 90 seconds. |
| Skip Scheduled Messages | If enabled, scheduled messages that will be delivered in the future will not be deleted. |
| Filter Type | The type of filter to apply when emptying the queue. Options: None (delete all), Message IDs, Phone Numbers, Group/Broadcast IDs, Date Range. |
| Message IDs | (Shown if Filter Type is "Message IDs") List of queued message IDs (24-character hexadecimal strings) to delete. |
| Phone Numbers | (Shown if Filter Type is "Phone Numbers") List of phone numbers in E164 format (e.g., +447362053576) whose queued messages should be deleted. |
| Group/Broadcast IDs | (Shown if Filter Type is "Group/Broadcast IDs") List of group or broadcast WhatsApp IDs (e.g., 447362053576-000000000@g.us) whose queued messages to delete. |
| Date Filters | (Shown if Filter Type is "Date Range") Collection with optional "Created Before" and/or "Created After" dates to filter messages by creation date. |
Output
The output JSON contains the result of the empty queue operation. Typically, it will confirm which messages were deleted or provide status information about the queue clearing process.
If the "Wait for Completion" option is enabled, the output confirms completion after all deletions are processed.
No binary data output is expected from this operation.
Dependencies
- Requires an API key credential for authenticating with the Wassenger WhatsApp API.
- The node depends on the external Wassenger WhatsApp API service to perform queue management operations.
- Proper configuration of the WhatsApp number (device) in the connected Wassenger account is necessary.
Troubleshooting
Common Issues:
- Invalid WhatsApp number ID: Ensure the device ID corresponds to a valid WhatsApp number configured in your Wassenger account.
- Incorrect message IDs or phone numbers: Verify that message IDs are 24-character hex strings and phone numbers follow E164 format.
- Timeout when waiting for completion: The "Wait for Completion" option can take up to 90 seconds; if the operation times out, try disabling this option or check API responsiveness.
- Permission or authentication errors: Confirm that the API key credential is valid and has sufficient permissions.
Error Messages:
- Errors related to invalid parameters usually indicate incorrect input values for filters.
- API errors might return messages about rate limits or unauthorized access; resolving these requires checking API key validity and usage limits.
Links and References
- Wassenger API Documentation (for detailed API capabilities and message queue management)
- E.164 Phone Number Format (for correct phone number formatting)