Estimated Wait Time API

Dieser API-Endpunkt gibt die berechnete geschätzte Wartezeit (Estimated Wait Time, EWT) pro Warteschlange zurück.

Dies kann für benutzerdefinierte EWT-Anzeigen für Supportkanäle auf Webseiten oder in mobilen Apps außerhalb des Contact Center AI Platform (CCAI Platform) SDK oder für benutzerdefinierte Benachrichtigungen oder Trigger verwendet werden.

Beispielanfrage

URL: http://{subdomain}.{domain}/apps/api/v1/wait_times

Parameter

ID	Feldname	Typ	Erforderlich	Beschreibung	Werte	Hinweise
1	menu_id	id	Nein	In der Antwort werden alle Menüs (Warteschlangen) im Untermenü dieses Menüs gefiltert, einschließlich des Menüs selbst.	Stammmenü (Standard) Bestimmtes Menü	Wenn nichts übergeben wird, wird die gesamte Warteschlangenstruktur zurückgegeben.
2	channel_type	enum	Nein	Gibt Menüs eines bestimmten Kanals zurück	voice_call chat	Optionaler Parameter
3	menu_type	enum	Nein	Gibt Menüs bestimmter Typen zurück	ivr_menu mobile_menu web_menu Alle (Standard)	optional
4	wait[from]	int	Nein	Gibt Datensätze zurück, wenn sie eine Wartezeit haben, die größer als der Wert ist.		Bestätigung:Nur positive Intention
5	wait[to]	int	Nein	Gibt Datensätze zurück, wenn die Wartezeit kleiner als der Wert ist		Bestätigung:Nur positive Intention
6	lang	enum	Ja	Warteschlangenstruktur zum Abrufen des EWT	Beispiel: „en“, „es“, „fr“, „de“ „it“ „ja“ „ko“ „pt“ "pt-BR" "sv"

Antworten

ID	Feldname	Typ	Erforderlich	Beschreibung
1	menu_id	id	Ja	Fremdschlüssel für den API-Endpunkt „/menus“
2	wait	GANZZAHL	Ja	Wartezeit in Minuten
3	Materialisierter Pfad	String	Ja	Materialisierter Pfad, wie er in der /menus API gefunden wird

Beispiel

http://{subdomain}.{domain}/apps/api/v1/wait_times?lang=en&menu_id=10

[
    {
        "menu_id": 10,
        "menu_type": "ivr_menu",
        "voice_call": 120,
        "materialized_path": "Subscription",
        "logged_in_agents": 3,
        "available_agents": 0,
        "breakthrough_agents": 1
    }
]

Statuscode:200

Die geschätzte Wartezeit für die Menü-ID 10 beträgt 120 Sekunden (oder 2 Minuten).