API Estimated Wait Time

Questo endpoint API restituisce il tempo di attesa stimato (EWT) calcolato per ogni coda.

Può essere utilizzato per le visualizzazioni EWT dei canali di assistenza personalizzati su pagine web o app mobile al di fuori dell'SDK Contact Center AI Platform (CCAI Platform) o per notifiche o trigger personalizzati.

Esempio di richiesta

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

Parametri

ID	Nome campo	Tipo	Obbligatorio	Descrizione	Valori	Note
1	menu_id	id	No	La risposta filtrerà tutti i menu (code) nel sottomenu del menu, incluso il menu	Menu principale (impostazione predefinita) Menu specifico	Se non viene passato nulla, verrà restituita l'intera struttura della coda
2	channel_type	enum	No	Restituisce i menu di un canale specifico	voice_call chat	Parametro facoltativo
3	menu_type	enum	No	Restituisce i menu di tipi specifici	ivr_menu mobile_menu web_menu Tutti (impostazione predefinita)	facoltativo
4	wait[from]	int	No	Restituisce i record se hanno un'attesa maggiore del valore		Convalida:solo numeri interi positivi
5	wait[to]	int	No	Restituisce i record se hanno un'attesa inferiore al valore		Convalida:solo numeri interi positivi
6	lang	enum	Sì	Struttura della coda per recuperare l'EWT	Esempio: "en" "es" "fr" "de" "it" "ja" "ko" "pt" "pt-BR" "sv"

Risposte

ID	Nome campo	Tipo	Obbligatorio	Descrizione
1	menu_id	id	sì	Chiave esterna per l'endpoint API del gestore /menus
2	wait	INT	sì	Tempo di attesa in minuti
3	Percorso materializzato	Stringa	Sì	Percorso materializzato come trovato nell'API /menus

Esempio

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
    }
]

Codice di stato: 200

Il tempo di attesa stimato per l'ID menu 10 è di 120 secondi (o due minuti)