Endpoints de fila

Os endpoints de status da fila retornam informações para determinar se uma chamada deve ser desviada.

Status da fila

Fornece dados em tempo real para filas de atendimento, incluindo tempos de espera estimados, disponibilidade de agentes, capacidade de agendamento de retorno de ligação, horário de funcionamento e feriados. Use isso para permitir que os sistemas de IA de voz decidam dinamicamente se devem encaminhar uma ligação para um atendente ou oferecer horários de retorno de ligação agendados para quem está ligando. Para mais informações, consulte O endpoint de status da fila.

Exemplo de solicitação

Método: GET

URL: https://{subdomain}.{domain}/apps/api/v1/queues/status

Cabeçalhos

Chave	Valor	Descrição
Content-Type	application/json
Aceitar	application/json

Consulta

Chave	Valor	Descrição
lang	string	O código de idioma de duas letras da fila, no formato ISO 639-1 (por exemplo, en ou es). Obrigatório.
menu_id[]	string	Um único ID de fila ou uma matriz de vários IDs de fila. Obrigatório.
menu_type	string	O tipo de menu. Os valores possíveis são ivr_menu, mobile_menu e web_menu. Obrigatório.
callback_period_hours	integer	O comprimento total da janela futura em horas para retornar períodos de callback-slot. Precisa ser menor ou igual a 8 horas. O padrão é 4 horas. Opcional.
callback_start_from	string	O início da janela de pesquisa de slot de retorno de chamada, no formato de data e hora ISO 8601 na fila ou no fuso horário da empresa. Se omitido, o padrão será o horário atual (horário do servidor convertido para o fuso horário da fila ou da empresa). Não pode estar no passado e precisa ser de, no máximo, 24 horas no futuro. Opcional.

Exemplo de resposta

{
    "queues": [
        {
            "menu_id": 2,
            "menu_type": "ivr_menu",
            "lang": "en",
            "materialized_path": "IVR Support",
            "current_queue_ewt": 18000,
            "scheduled_callback_ewt": 0,
            "logged_in_agents": 0,
            "available_agents": 0,
            "breakthrough_agents": 0,
            "callback_periods": [
                {
                    "date": "20260225",
                    "start_time": "17:30",
                    "end_time": "17:45",
                    "scheduled_calls": 0,
                    "max_slots": 1
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_slots": 1
                }
            ],
            "hoops": {
                "current_status": 0,
                "time_zone": "America/Los_Angeles",
                "start_of_hoops": "2026-02-25T09:00:00-08:00",
                "end_of_hoops": "2026-02-25T18:00:00-08:00",
                "hoops_early_cutoff_minutes": null
            },
            "holiday": {
                "current_status": 0,
                "holiday_name": null,
                "time_range_all_day": null,
                "time_range_start_time": null,
                "time_range_end_time": null,
                "time_zone": "America/Los_Angeles"
            }
        }
    ]
}

Disponibilidade da fila

Receba o status de disponibilidade de uma fila antes de redirecionar uma sessão para ela. Este endpoint retorna as seguintes propriedades booleanas:

• after_hours: true se a fila estiver indisponível porque está em um estado após o horário de expediente

• overcapacity: true se a fila estiver indisponível por estar em um estado de excesso de capacidade

Exemplo de solicitação

Método: GET

URL: https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses

Consulta

Chave	Valor	Descrição
menu_id	integer	O ID da fila para a qual você quer informações de disponibilidade. Obrigatório.
lang	string	O código de idioma de duas letras da fila, no formato ISO 639-1. Obrigatório.
channel_type	string	O tipo de canal. Os valores possíveis são call e chat. Obrigatório.

Exemplo de resposta

{
  "menu_id": 1,
  "lang": "en",
  "channel_type": "call",
  "after_hour": false,
  "overcapacity": true
}