API Estimated Wait Time

Ce point de terminaison d'API renvoie le temps d'attente estimé calculé par file d'attente.

Vous pouvez l'utiliser pour afficher des temps d'attente estimés personnalisés pour les canaux d'assistance sur des pages Web ou des applications mobiles en dehors du SDK Contact Center AI Platform (CCAI Platform), ou pour des notifications ou des déclencheurs personnalisés.

Exemple de requête

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

Paramètres

ID	Nom du champ	Type	Obligatoire	Description	Valeurs	Remarques
1	menu_id	id	Non	La réponse filtre tous les menus (files d'attente) du sous-menu de ce menu, y compris ce menu.	Menu racine (par défaut) Menu spécifique	Si rien n'est transmis, la structure complète de la file d'attente est renvoyée.
2	channel_type	enum	Non	Renvoie les menus d'un canal spécifique.	voice_call chat	Paramètre facultatif
3	menu_type	enum	Non	Renvoie les menus de types spécifiques.	ivr_menu mobile_menu web_menu Tous (par défaut)	facultatif
4	wait[from]	int	Non	Renvoie les enregistrements si leur temps d'attente est supérieur à la valeur.		Validation : entier positif uniquement
5	wait[to]	int	Non	Renvoie les enregistrements si leur temps d'attente est inférieur à la valeur.		Validation : entier positif uniquement
6	lang	enum	Oui	Structure de la file d'attente pour récupérer le temps d'attente estimé	Ex. : "en" "es" "fr" "de" "it" "ja" "ko" "pt" "pt-BR" "sv"

Réponses

ID	Nom du champ	Type	Obligatoire	Description
1	menu_id	id	oui	Clé étrangère du point de terminaison d'API du gestionnaire /menus
2	wait	INT	oui	Temps d'attente en minutes
3	Chemin matérialisé	Chaîne	Oui	Chemin matérialisé tel qu'il apparaît dans l'API /menus

Exemple

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

Code d'état : 200

Le temps d'attente estimé pour l'ID de menu 10 est de 120 secondes (ou deux minutes).