Skip to content

KAZOO Support Channels

This documentation is curated by 2600Hz as part of the KAZOO open source project. Join our community forums here for peer support. Only features in the docs.2600hz.com/supported space are included as part of our 2600Hz Support Services plan.

Queue Events#

Create#

The create event indicates that a queue has started running.

{
    "action":"event",
    "subscribed_key":"qubicle.queue",
    "subscription_key":"qubicle.queue.{ACCOUNT_ID}.*",
    "name":"create",
    "routing_key":"qubicle.queue.{ACCOUNT_ID}.{QUEUE_ID}",
    "data":{
        "account_id": "{ACCOUNT_ID}",
        "app_name": "qubicle",
        "app_version": "{VERSION}",
        "event_category": "qubicle-queue",
        "event_name": "create",
        "event_timestamp": {SERVER_TIMESTAMP},
        "msg_id": "{MSG_ID}",
        "queue_id": "{QUEUE_ID}",
        "pid": "{PROCESS_PID}",
        "stats": {
            "estimated_wait": {EST_WAIT_TIME},
            "average_wait": {AVG_WAIT_TIME},
            "recipient_count": {RECIPIENT_COUNT},
            "active_session_count": {ACTIVE_SESSION_COUNT},
            "total_sessions": {TOTAL_SESSION_COUNT},
            "missed_sessions": {MISSED_COUNT},
            "abandoned_sessions": {ABANDONED_COUNT}
        }
    }
}

Delete#

The delete event indicates that a queue is no longer running.

{
    "action":"event",
    "subscribed_key":"qubicle.queue",
    "subscription_key":"qubicle.queue.{ACCOUNT_ID}.*",
    "name":"delete",
    "routing_key":"qubicle.queue.{ACCOUNT_ID}.{QUEUE_ID}",
    "data":{
        "account_id": "{ACCOUNT_ID}",
        "app_name": "qubicle",
        "app_version": "{VERSION}",
        "event_category": "qubicle-queue",
        "event_name": "delete",
        "event_timestamp": {SERVER_TIMESTAMP},
        "msg_id": "{MSG_ID}",
        "reason": "{REASON}",
        "queue_id": "{QUEUE_ID}",
        "stats": {
            "estimated_wait": {EST_WAIT_TIME},
            "average_wait": {AVG_WAIT_TIME},
            "recipient_count": {RECIPIENT_COUNT},
            "active_session_count": {ACTIVE_SESSION_COUNT},
            "total_sessions": {TOTAL_SESSION_COUNT},
            "missed_sessions": {MISSED_COUNT},
            "abandoned_sessions": {ABANDONED_COUNT}
        }
    }
}

Join#

{
    "action":"event",
    "subscribed_key":"qubicle.queue",
    "subscription_key":"qubicle.queue.{ACCOUNT_ID}.*",
    "name":"join",
    "routing_key":"qubicle.queue.{ACCOUNT_ID}.{QUEUE_ID}",
    "data":{
        "account_id": "{ACCOUNT_ID}",
        "app_name": "qubicle",
        "app_version": "{VERSION}",
        "event_category": "qubicle-queue",
        "event_name": "join",
        "event_timestamp": {SERVER_TIMESTAMP},
        "join_time": {JOIN_TIME},
        "join_position": {JOIN_POSITION},
        "est_wait_time": {ESTIMATED_WAIT_TIME},
        "msg_id": "{MSG_ID}",
        "queue_id": "{QUEUE_ID}",
        "session_id": "{SESSION_ID}",
        "stats": {
            "estimated_wait": {EST_WAIT_TIME},
            "average_wait": {AVG_WAIT_TIME},
            "recipient_count": {RECIPIENT_COUNT},
            "active_session_count": {ACTIVE_SESSION_COUNT},
            "total_sessions": {TOTAL_SESSION_COUNT},
            "missed_sessions": {MISSED_COUNT},
            "abandoned_sessions": {ABANDONED_COUNT}
        }
    }
}

Leave#

{
    "action":"event",
    "subscribed_key":"qubicle.queue",
    "subscription_key":"qubicle.queue.{ACCOUNT_ID}.*",
    "name":"leave",
    "routing_key":"qubicle.queue.{ACCOUNT_ID}.{QUEUE_ID}",
    "data":{
        "account_id": "{ACCOUNT_ID}",
        "app_name": "qubicle",
        "app_version": "{VERSION}",
        "event_category": "qubicle-queue",
        "event_name": "leave",
        "event_timestamp": {SERVER_TIMESTAMP},
        "msg_id": "{MSG_ID}",
        "queue_id": "{QUEUE_ID}",
        "reason": "{REASON}",
        "session_id": "{SESSION_ID}",
        "total_wait_time": {TOTAL_WAIT_TIME},
        "stats": {
            "estimated_wait": {EST_WAIT_TIME},
            "average_wait": {AVG_WAIT_TIME},
            "recipient_count": {RECIPIENT_COUNT},
            "active_session_count": {ACTIVE_SESSION_COUNT},
            "total_sessions": {TOTAL_SESSION_COUNT},
            "missed_sessions": {MISSED_COUNT},
            "abandoned_sessions": {ABANDONED_COUNT}
        }
    }
}

Delivered#

{
    "action":"event",
    "subscribed_key":"qubicle.queue",
    "subscription_key":"qubicle.queue.{ACCOUNT_ID}.*",
    "name":"delivered",
    "routing_key":"qubicle.queue.{ACCOUNT_ID}.{QUEUE_ID}",
    "data":{
        "account_id": "{ACCOUNT_ID}",
        "app_name": "qubicle",
        "app_version": "{VERSION}",
        "event_category": "qubicle-queue",
        "event_name": "delivered",
        "event_timestamp": {SERVER_TIMESTAMP},
        "msg_id": "{MSG_ID}",
        "queue_id": "{QUEUE_ID}",
        "recipient_id": "{USER_ID}",
        "session_id": "{SESSION_ID}",
        "total_wait_time": {TOTAL_WAIT_TIME},
        "stats": {
            "abandoned_sessions": {ABANDONED_COUNT},
            "active_session_count": {ACTIVE_SESSION_COUNT},
            "average_wait": {AVG_WAIT_TIME},
            "estimated_wait": {EST_WAIT_TIME},
            "longest_wait": {LONGEST_WAIT},
            "missed_sessions": {MISSED_COUNT},
            "recipient_count": {RECIPIENT_COUNT},
            "total_sessions": {TOTAL_SESSION_COUNT},
            "total_wait_time": {TOTAL_WAIT_TIME}
        }
    }
}