API Estimated Wait Time

Esse endpoint de API retorna o tempo de espera estimado (EWT, na sigla em inglês) calculado por fila.

Ele pode ser usado para mostrar o EWT do canal de suporte personalizado em páginas da Web ou apps para dispositivos móveis fora do SDK da Contact Center AI Platform (CCAI Platform) ou para notificações ou acionadores personalizados.

Exemplo de solicitação

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

Parâmetros

ID	Nome do campo	Tipo	Obrigatório	Descrição	Valores	Observações
1	menu_id	ID	Não	A resposta vai filtrar todos os menus (filas) no submenu do menu, incluindo o próprio menu	Menu raiz (padrão) Menu específico	Se nada for transmitido, vai retornar toda a estrutura da fila
2	channel_type	enum	Não	Retorna menus de um canal específico	voice_call chat	Parâmetro opcional
3	menu_type	enum	Não	Retorna menus de tipos específicos	ivr_menu mobile_menu web_menu Todos (padrão)	opcional
4	wait[from]	int	Não	Retorna registros se eles tiverem um tempo de espera maior que o valor		Validação:somente int positivo
5	wait[to]	int	Não	Retorna registros se eles tiverem um tempo de espera menor que o valor		Validação:somente int positivo
6	lang	enum	Sim	Estrutura da fila para recuperar o EWT	Exemplo: "en" "es" "fr" "de" "it" "ja" "ko" "pt" "pt-BR" "sv"

Respostas

ID	Nome do campo	Tipo	Obrigatório	Descrição
1	menu_id	ID	sim	Chave estrangeira para o endpoint da API do gerenciador /menus
2	wait	INT	sim	Tempo de espera em minutos
3	Caminho materializado	String	Sim	Caminho materializado encontrado na API /menus

Exemplo

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 status:200

O tempo de espera estimado do ID do menu 10 é de 120 segundos (ou dois minutos)