Extremos de la fila

Los extremos de estado de la fila devuelven información de la fila 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 intervalos de devolución de llamada, el horario de atención y los días feriados. Usa esto para permitir que los sistemas de IA de voz decidan de forma dinámica si derivar una llamada a un agente en vivo o si ofrecer ventanas de devolución de llamada 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	cadena	Es el código de idioma de dos letras de la fila, en formato ISO 639-1 (por ejemplo, en o es). Obligatorio.
menu_id[]	cadena	Un solo ID de fila o un array de varios IDs de fila. Obligatorio.
menu_type	cadena	Es el tipo de menú. Los valores posibles son ivr_menu, mobile_menu y web_menu. Obligatorio.
callback_period_hours	integer	Es la duración total de la ventana futura en horas para la que se devolverán los períodos de intervalos de devolución de llamada. Debe ser un valor entre 1 y 24. Si se omite, se usa un período predeterminado de 4 horas, a menos que la programación basada en la capacidad esté habilitada para tu cuenta. Es opcional.
callback_start_from	cadena	Es el inicio de la ventana de búsqueda de horarios de devolución de llamada, en formato de fecha y hora ISO 8601 en la zona horaria de la cola o de la empresa. Si se omite, se establece de forma predeterminada en la hora actual (la hora del servidor convertida a la zona horaria de la cola o de la empresa). No debe ser en el pasado. 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,
                    "available_slots": 1
                },
                {
                    "date": "20260225",
                    "start_time": "17:45",
                    "end_time": "18:00",
                    "scheduled_calls": 0,
                    "max_slots": 1,
                    "available_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 devuelve las siguientes propiedades booleanas:

• after_hours: true si la fila no está disponible porque se encuentra en un estado fuera del horario de atención

• overcapacity: true si la cola no está disponible porque se encuentra en un estado de exceso de capacidad

Ejemplo de solicitud

Método: GET

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

Consulta

Clave	Valor	Descripción
menu_id	integer	Es el ID de la cola de la que deseas obtener información de disponibilidad. Obligatorio.
lang	cadena	Es el código de idioma de dos letras de la fila, en formato ISO 639-1. Obligatorio.
channel_type	cadena	Es 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
}