Warteschlangenendpunkte

Die Endpunkte für den Warteschlangenstatus geben Warteschlangeninformationen zurück, anhand derer bestimmt werden kann, ob ein Anruf umgeleitet werden soll.

Warteschlangenstatus

Stellt Echtzeitdaten für Blattwarteschlangen bereit, einschließlich geschätzter Wartezeiten, Agentenverfügbarkeit, Kapazität für Rückrufzeitfenster, Betriebszeiten und Feiertage. Damit können Voice-KI-Systeme dynamisch entscheiden, ob ein Anruf an einen Live-Agenten weitergeleitet werden soll oder ob dem Anrufer geplante Rückruffunktionen angeboten werden sollen. Weitere Informationen finden Sie unter Endpunkt für den Warteschlangenstatus.

Beispielanfrage

Methode: GET

URL: https://{subdomain}.{domain}/apps/api/v1/queues/status

Header

Schlüssel	Wert	Beschreibung
Content-Type	application/json
Akzeptieren	application/json

Abfrage

Schlüssel	Wert	Beschreibung
lang	String	Der zweistellige Sprachcode für die Warteschlange im ISO 639-1-Format (z. B. en oder es). Erforderlich.
menu_id[]	String	Eine einzelne Warteschlangen-ID oder ein Array mit mehreren Warteschlangen-IDs. Erforderlich.
menu_type	String	Der Menütyp. Mögliche Werte sind ivr_menu, mobile_menu und web_menu. Erforderlich.
callback_period_hours	integer	Die Gesamtlänge des zukünftigen Zeitfensters in Stunden, für das Callback-Slot-Zeiträume zurückgegeben werden sollen. Muss zwischen 1 und 24 liegen. Wenn keine Angabe gemacht wird, wird ein standardmäßiges 4-Stunden-Fenster verwendet, es sei denn, für Ihr Konto ist die kapazitätsbasierte Planung aktiviert. Optional.
callback_start_from	String	Der Beginn des Suchfensters für Rückrufzeitfenster im ISO 8601-Datums-/Uhrzeitformat in der Zeitzone der Warteschlange oder des Unternehmens. Wenn keine Angabe gemacht wird, wird standardmäßig die aktuelle Zeit verwendet (Serverzeit, die in die Zeitzone der Warteschlange oder des Unternehmens umgerechnet wird). Darf nicht in der Vergangenheit liegen. Optional.

Beispielantwort

{
    "queues": [
        {
            "menu_id": 2,
            "menu_type": "ivr_menu",
            "lang": "en",
            "materialized_path": "IVR Support",
            "current_queue_ewt": 18000,
            "scheduled_callback_ewt": 0,
            "logged_in_agents": 0,
            "available_agents": 0,
            "breakthrough_agents": 0,
            "callback_periods": [
                {
                    "date": "20260225",
                    "start_time": "17:30",
                    "end_time": "17:45",
                    "scheduled_calls": 0,
                    "max_slots": 1,
                    "available_slots": 1
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_slots": 1,
                    "available_slots": 1
                }
            ],
            "hoops": {
                "current_status": 0,
                "time_zone": "America/Los_Angeles",
                "start_of_hoops": "2026-02-25T09:00:00-08:00",
                "end_of_hoops": "2026-02-25T18:00:00-08:00",
                "hoops_early_cutoff_minutes": null
            },
            "holiday": {
                "current_status": 0,
                "holiday_name": null,
                "time_range_all_day": null,
                "time_range_start_time": null,
                "time_range_end_time": null,
                "time_zone": "America/Los_Angeles"
            }
        }
    ]
}

Verfügbarkeit der Warteschlange

Rufen Sie den Verfügbarkeitsstatus einer Warteschlange ab, bevor Sie eine Sitzung dorthin umleiten. Dieser Endpunkt gibt die folgenden booleschen Eigenschaften zurück:

• after_hours: true, wenn die Warteschlange nicht verfügbar ist, weil sie sich im Status „Außerhalb der Geschäftszeiten“ befindet

• overcapacity: true, wenn die Warteschlange nicht verfügbar ist, weil sie überlastet ist

Beispielanfrage

Methode: GET

URL: https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses

Abfrage

Schlüssel	Wert	Beschreibung
menu_id	integer	Die ID der Warteschlange, für die Sie Verfügbarkeitsinformationen erhalten möchten. Erforderlich.
lang	String	Der zweistellige Sprachcode für die Warteschlange im ISO 639-1-Format. Erforderlich.
channel_type	String	Der Kanaltyp. Die möglichen Werte sind call und chat. Erforderlich.

Beispielantwort

{
  "menu_id": 1,
  "lang": "en",
  "channel_type": "call",
  "after_hour": false,
  "overcapacity": true
}