API de Estimated Wait Time

Este extremo de API muestra el tiempo de espera estimado (EWT) calculado por cola.

Se puede usar para mostrar el EWT del canal de asistencia personalizada en páginas web o apps para dispositivos móviles fuera del SDK de Contact Center AI Platform (CCAI Platform) o para notificaciones o activadores personalizados.

Ejemplo de solicitud

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

Parámetros

ID	Nombre del campo	Tipo	Obligatorio	Descripción	Valores	Notas
1	menu_id	id	No	La respuesta filtrará todos los menús (colas) en el submenú de ese menú, incluido el menú.	Menú raíz (predeterminado) Menú específico	Si no se pasa nada, se mostrará toda la estructura de la cola.
2	channel_type	enum	No	Muestra los menús de un canal específico.	voice_call chat	Parámetro opcional
3	menu_type	enum	No	Muestra los menús de tipos específicos.	ivr_menu mobile_menu web_menu Todos (predeterminado)	opcional
4	wait[from]	int	No	Muestra los registros si tienen una espera mayor que el valor.		Validación:Solo números enteros positivos
5	wait[to]	int	No	Muestra los registros si tienen una espera menor que el valor.		Validación:Solo números enteros positivos
6	lang	enum	Sí	Estructura de la cola para recuperar el EWT	P. ej.: "en" "es" "fr" "de" "it" "ja" "ko" "pt" "pt-BR" "sv"

Respuestas

ID	Nombre del campo	Tipo	Obligatorio	Descripción
1	menu_id	id	sí	Clave externa para el extremo de la API del administrador de /menus
2	wait	INT	sí	Tiempo de espera en minutos
3	Ruta de acceso materializada	String	Sí	Ruta de acceso materializada que se encuentra en la API de /menus

Ejemplo

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

Código de estado: 200

El tiempo de espera estimado del ID de menú 10 es de 120 segundos (o dos minutos).