Supported Queue Actions

Here are the actions supported for the queue key.

activate_queue

This action activates the currently selected queue. If the queue is not in the present (it is in the past or future), an error is shown. If the queue is deactivated, the queue gets re-activated and the deactivation time is truncated. This table describes the parameters supported for the activate_queue action:

Parameter	Mandatory	Type	Description
action_time	no	String	Time and date of the action in current resource's time zone. If not set - the current time is used (on the moment of close message processing). Date/time in ISO 8601 format with possible forms: YYYY-MM-DD hh:mm:ss YYYY-MM-DD hh:mm hh:mm:ss hh:mm If the "date" part is omitted then the current resource's date is used.

Examples of the "close" message

Without specifying the action time:

{
    "apiVersion": 1,
    "method": "close"
    "actions": [
        {
            "entity": "queue",
            "action": "activate_queue"
        }
    ]
}

Specifying the action time:

{
    "apiVersion": 1,
    "method": "close"
    "actions": [
        {
            "entity": "queue",
            "action": "activate_queue",
            "action_time": "2021-01-02 03:04:05"
        }
    ]
}

deactivate_queue

This action deactivates the current selected queue. If the queue is not in the present (it is in the past or future) or the queue has started or pending activities, an error is thrown. This table describes the parameters supported for the deactivate queue action:

Parameter	Mandatory	Type	Description
action_time	no	String	Time and date of the action in current resource's time zone. If not set - the current time is used (on the moment of close message processing). Date/time in ISO 8601 format with possible forms: YYYY-MM-DD hh:mm:ss YYYY-MM-DD hh:mm hh:mm:ss hh:mm If the "date" part is omitted then the current resource's date is used.

Examples of the "close" message

Without specifying the action time:

{
    "apiVersion": 1,
    "method": "close"
    "actions": [
        {
            "entity": "queue",
            "action": "deactivate_queue"
        }
    ]
}

Specifying the action time:

{
    "apiVersion": 1,
    "method": "close"
    "actions": [
        {
            "entity": "queue",
            "action": "deactivate_queue",
            "action_time": "2021-02-03 04:05:06"
        }
    ]
}