Warteschlangenendpunkte

Die Endpunkte für den Warteschlangenstatus geben Warteschlangeninformationen zurück, um zu bestimmen, ob ein Anruf umgeleitet werden soll.

Status der Warteschlange

Bietet Echtzeitdaten für Blattwarteschlangen, einschließlich geschätzter Wartezeiten, Verfügbarkeit von Kundenservicemitarbeitern, Kapazität für Rückrufzeitfenster, Geschäftszeiten und Feiertage. Damit können Voice-KI-Systeme dynamisch entscheiden, ob ein Anruf an einen Kundenservicemitarbeiter eskaliert oder dem Anrufer ein geplanter Rückruf angeboten werden soll. Weitere Informationen finden Sie unter The queue status endpoint.

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 aus zwei Buchstaben bestehende 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-Zeiträume zurückgegeben werden sollen. Muss kleiner oder gleich 8 Stunden sein. Der Standardwert ist 4 Stunden. Optional.
callback_start_from	String	Der Beginn des Zeitfensters für die Suche nach Rückruf-Slots im ISO 8601-Datetime-Format in der Warteschlangen- oder Unternehmenszeitzone. Wenn keine Angabe gemacht wird, wird standardmäßig die aktuelle Uhrzeit verwendet (Serverzeit, die in die Zeitzone der Warteschlange oder des Unternehmens umgerechnet wird). Darf nicht in der Vergangenheit liegen und darf höchstens 24 Stunden in der Zukunft 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
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_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 für eine 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 Feierabendstatus 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 abrufen 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
}