Endpoint delle code

Gli endpoint dello stato della coda restituiscono informazioni sulla coda per determinare se deviare una chiamata.

Stato della coda

Fornisce dati in tempo reale per le code foglia, inclusi tempi di attesa stimati, disponibilità degli agenti, capacità degli slot di richiamata, orari di apertura e festività. Utilizza questa funzionalità per consentire ai sistemi di AI vocale di decidere in modo dinamico se inoltrare una chiamata a un agente live o offrire finestre di richiamata pianificate al chiamante. Per saperne di più, consulta L'endpoint dello stato della coda.

Esempio di richiesta

Metodo: GET

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

Intestazioni

Chiave	Valore	Descrizione
Content-Type	application/json
Accetta	application/json

Query

Chiave	Valore	Descrizione
lang	string	Il codice lingua a due lettere per la coda, nel formato ISO 639-1 (ad esempio, en o es). Obbligatorio.
menu_id[]	string	Un singolo ID coda o un array di più ID coda. Obbligatorio.
menu_type	string	Il tipo di menu. I valori possibili sono ivr_menu, mobile_menu e web_menu. Obbligatorio.
callback_period_hours	integer	La lunghezza totale della finestra futura in ore per cui restituire i periodi degli slot di richiamata. Deve essere inferiore o uguale a 8 ore. Il valore predefinito è 4 ore. Facoltativo.
callback_start_from	string	L'inizio della finestra di ricerca degli slot di richiamata, nel formato data/ora ISO 8601 nel fuso orario della coda o dell'azienda. Se omesso, il valore predefinito è l'ora corrente (ora del server convertita nel fuso orario della coda o dell'azienda). Non deve essere nel passato e deve essere al massimo 24 ore nel futuro. Facoltativo.

Esempio di risposta

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

Disponibilità della coda

Ottieni lo stato di disponibilità di una coda prima di deviare una sessione. Questo endpoint restituisce le seguenti proprietà booleane:

• after_hours: true se la coda non è disponibile perché è in uno stato di orario di chiusura

• overcapacity: true se la coda non è disponibile perché è in uno stato di sovraccarico

Esempio di richiesta

Metodo: GET

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

Query

Chiave	Valore	Descrizione
menu_id	integer	L'ID della coda per cui vuoi informazioni sulla disponibilità. Obbligatorio.
lang	string	Il codice lingua a due lettere per la coda, nel formato ISO 639-1. Obbligatorio.
channel_type	string	Il tipo di canale. I valori possibili sono call e chat. Obbligatorio.

Esempio di risposta

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