Endpoint dei tempi di attesa

Contact Center AI Platform (CCAI Platform) fornisce l'endpoint Tempo di attesa per ottenere i tempi di attesa attuali per le code di diversi tipi di canali.

Tempo di attesa

Parametro Obbligatorio Tipo di dati Definizione
lang VERO Stringa Codice lingua della coda. (ad es. "it")
menu_id FALSE Numero intero La risposta filtrerà tutti i menu nell'albero secondario di quel menu, incluso il menu stesso.
menu_type FALSE Stringa Restituisce menu di tipi specifici. Valori possibili: ivr_menu, mobile_menu, web_menu.
channel_type FALSE Stringa Restituisce i menu di un canale specifico. Valori possibili: voice_call, chat.
wait[from] FALSE Numero intero Restituisce i record se hanno un'attesa superiore al valore.
wait[to] FALSE Numero intero Restituisce i record se hanno un'attesa inferiore al valore.

Endpoint:

Method: GET
Type: 
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/wait_times

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Esempio di richiesta e risposte

Le sezioni seguenti forniscono richieste di esempio all'endpoint.

Tempi di attesa per le code mobile

Questo esempio mostra come recuperare i tempi di attesa per le code mobile.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
lang it
menu_type mobile_menu

Body: None

Risposta: tempi di attesa per le code mobile
[
    {
        "menu_id": 29,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Laptop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 42,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Desktop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 43,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Smart Phone",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    }
]

Codice di stato: 200

Tempi di attesa tra wait[from] e wait[to]

Questo esempio mostra come recuperare le chiamate con tempi di attesa compresi tra i valori di attesa da e attesa a.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
lang it
wait[from] 5
wait[to] 15

Body: None

Risposta: tempi di attesa tra wait[from] e wait[to]
[
    {
        "menu_id": 3,
        "menu_type": "web_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Web App",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 29,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Laptop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 42,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Desktop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 44,
        "menu_type": "web_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Mobile App",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 43,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Smart Phone",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    }
]

Codice di stato: 200

Tempi di attesa della chiamata vocale per le code mobile superiori a 5 secondi

Questo esempio mostra come recuperare le chiamate vocali da cellulare con un tempo di attesa superiore a 5 secondi.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
lang it
menu_type mobile_menu
channel_type voice_call
wait[from] 5

Body: None

Risposta: tempi di attesa della chiamata vocale per le code mobile superiori a 5 secondi
[
    {
        "menu_id": 29,
        "menu_type": "mobile_menu",
        "voice_call": 10,
        "materialized_path": "Laptop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 42,
        "menu_type": "mobile_menu",
        "voice_call": 10,
        "materialized_path": "Desktop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 43,
        "menu_type": "mobile_menu",
        "voice_call": 10,
        "materialized_path": "Smart Phone",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    }
]

Codice di stato: 200

Tempi di attesa per un menu specifico

Questo esempio mostra come recuperare i tempi di attesa per un ID menu specifico.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
lang it
menu_id 9

Body: None

Risposta: tempi di attesa per un menu specifico
[
    {
        "menu_id": 9,
        "menu_type": "ivr_menu",
        "voice_call": 10,
        "materialized_path": "Death Star",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    }
]

Codice di stato: 200

Tempi di attesa per tutte le chiamate vocali

Questo esempio mostra come recuperare i tempi di attesa per tutte le chiamate vocali correnti.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
lang it
channel_type voice_call

Body: None

Risposta: tempi di attesa per tutte le chiamate vocali
[
    {
        "menu_id": 3,
        "menu_type": "web_menu",
        "voice_call": 10,
        "materialized_path": "Web App",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 9,
        "menu_type": "ivr_menu",
        "voice_call": 10,
        "materialized_path": "Death Star",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 29,
        "menu_type": "mobile_menu",
        "voice_call": 10,
        "materialized_path": "Laptop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 41,
        "menu_type": "ivr_menu",
        "voice_call": 10,
        "materialized_path": "Lock Star",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 42,
        "menu_type": "mobile_menu",
        "voice_call": 10,
        "materialized_path": "Desktop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 44,
        "menu_type": "web_menu",
        "voice_call": 10,
        "materialized_path": "Mobile App",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 43,
        "menu_type": "mobile_menu",
        "voice_call": 10,
        "materialized_path": "Smart Phone",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    }
]

Codice di stato: 200

Tempi di attesa per le code in inglese

Questo esempio mostra come recuperare tutti i tempi di attesa per le code che hanno la lingua inglese.

Richiesta

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Chiave Valore Descrizione
lang it

Body: None

Risposta: tempi di attesa per le code in inglese
[
    {
        "menu_id": 3,
        "menu_type": "web_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Web App",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 9,
        "menu_type": "ivr_menu",
        "voice_call": 10,
        "materialized_path": "Death Star",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 29,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Laptop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 41,
        "menu_type": "ivr_menu",
        "voice_call": 10,
        "materialized_path": "Lock Star",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 42,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Desktop",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 44,
        "menu_type": "web_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Mobile App",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    },
    {
        "menu_id": 43,
        "menu_type": "mobile_menu",
        "chat": 10,
        "voice_call": 10,
        "materialized_path": "Smart Phone",
        "logged_in_agents": 3,
        "available_agents": 2,
        "breakthrough_agents": 1
    }
]

Codice di stato: 200