Extremos de la fila

Los extremos de estado de la cola muestran información de la cola para determinar si se debe desviar una llamada.

Estado de la cola

Proporciona datos en tiempo real para las colas de hojas, incluidos los tiempos de espera estimados, la disponibilidad de los agentes, la capacidad de los espacios de devolución de llamadas, el horario de atención y los días festivos. Usa esta opción para permitir que los sistemas de IA de voz decidan de forma dinámica si se debe derivar una llamada a un agente en vivo o si se deben ofrecer ventanas de devolución de llamadas programadas a la persona que llama. Para obtener más información, consulta El extremo de estado de la cola.

Ejemplo de solicitud

Método: GET

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

Encabezados

Clave Valor Descripción
Content-Type application/json
Aceptar application/json

Consulta

Clave Valor Descripción
lang string El código de idioma de dos letras de la cola, en formato ISO 639-1 (por ejemplo, en o es). Obligatorio.
menu_id[] string Un solo ID de cola o un array de varios IDs de cola. Obligatorio.
menu_type string El tipo de menú. Los valores posibles son ivr_menu, mobile_menu y web_menu. Obligatorio.
callback_period_hours integer La duración total de la ventana futura en horas para la que se mostrarán los períodos de espacios de devolución de llamadas. Debe ser menor o igual a 8 horas. El valor predeterminado es de 4 horas. Es opcional.
callback_start_from string El inicio de la ventana de búsqueda de espacios de devolución de llamadas, en formato de fecha y hora ISO 8601 en la zona horaria de la cola o la empresa. Si se omite, se establece de forma predeterminada la hora actual (hora del servidor convertida a la zona horaria de la cola o la empresa). No debe estar en el pasado y debe ser como máximo 24 horas en el futuro. Es opcional.

Respuesta de ejemplo

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

Disponibilidad de la cola

Obtén el estado de disponibilidad de una cola antes de desviar una sesión a ella. Este extremo muestra las siguientes propiedades booleanas:

  • after_hours: true si la cola no está disponible porque está en un estado fuera de horario

  • overcapacity: true si la cola no está disponible porque está en un estado de sobrecapacidad

Ejemplo de solicitud

Método: GET

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

Consulta

Clave Valor Descripción
menu_id integer El ID de la cola para la que deseas obtener información de disponibilidad. Obligatorio.
lang string El código de idioma de dos letras de la cola, en formato ISO 639-1. Obligatorio.
channel_type string El tipo de canal. Los valores posibles son call y chat. Obligatorio.

Respuesta de ejemplo

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