WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

Queue → Set Queue Status

AI-generated

Overview

This node interacts with the WaliChat WhatsApp API to manage the status of message queues associated with WhatsApp numbers. Specifically, the "Set Queue Status" operation allows users to control how messages are processed for a given WhatsApp number by setting the queue's processing state.

Common scenarios where this node is beneficial include:

  • Temporarily pausing message delivery during maintenance or downtime without losing incoming messages.
  • Rejecting new messages while still delivering existing queued messages, useful when limiting new interactions but finishing ongoing conversations.
  • Freezing the queue to stop all message delivery and reject new messages, for emergency stops or compliance reasons.
  • Forcing immediate delivery of all queued messages for a short period, which can be used to catch up on backlog after a pause.

Practical example:

  • A customer support team wants to pause message delivery during off-hours but still accept new messages to be handled later. They set the queue status to "Pause".
  • When ready to resume, they set the status back to "Active" and optionally force delivery to clear the backlog quickly.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number whose message queue status you want to set. This is selected from available devices.
Status The desired queue processing status. Options:
- Active: Deliver messages and accept new ones.
- Pause: Do not deliver messages but accept new ones.
- Reject: Deliver existing messages but reject new ones.
- Freeze: Do not deliver messages and reject new ones.
Force Delivery Boolean flag to force delivery of all queued messages immediately for 30 minutes. Only effective if status is "Active" or "Reject".

Output

The node outputs JSON data representing the result of the queue status update operation. The exact structure depends on the API response but generally includes confirmation of the new status and any relevant metadata about the queue.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the WaliChat WhatsApp API via an API key credential configured in n8n.
  • The node relies on the WaliChat API endpoints that manage message queues for WhatsApp numbers.
  • The "WhatsApp Number" property dynamically loads available devices from the API.

Troubleshooting

  • Common issues:

    • Invalid or missing WhatsApp number ID: Ensure the selected device exists and is correctly loaded.
    • Insufficient permissions or invalid API key: Verify the API key credential is valid and has rights to modify queue statuses.
    • Using "Force Delivery" with unsupported statuses (other than "Active" or "Reject") will have no effect.
  • Error messages:

    • Errors returned from the API typically indicate invalid parameters or authentication failures.
    • If the node throws errors related to loading devices, check network connectivity and API availability.
  • Resolution tips:

    • Double-check the WhatsApp number selection.
    • Confirm API credentials and permissions.
    • Use the "Force Delivery" option only with appropriate statuses.

Links and References

Discussion