Contact Center AI Platform (CCAI Platform) fournit le point de terminaison Wait time pour obtenir les temps d'attente actuels des files d'attente de différents types de canaux.
Temps d'attente
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| lang | TRUE | Chaîne | Code de langue de la file d'attente. (par exemple, "fr") |
| menu_id | FALSE | Integer | La réponse filtrera tous les menus de la sous-arborescence de ce menu, y compris ce menu. |
| menu_type | FALSE | Chaîne | Renvoie des menus de types spécifiques. Valeurs possibles : ivr_menu, mobile_menu, web_menu. |
| channel_type | FALSE | Chaîne | Renvoie les menus d'un canal spécifique. Valeurs possibles : voice_call, chat). |
| wait[from] | FALSE | Integer | Renvoie les enregistrements si leur temps d'attente est supérieur à la valeur. |
| wait[to] | FALSE | Integer | Renvoie les enregistrements si leur temps d'attente est inférieur à la valeur. |
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/wait_times
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Exemple de requête et de réponses
Les sections suivantes fournissent des exemples de requêtes au point de terminaison.
Temps d'attente pour les files d'attente sur mobile
Cet exemple montre comment récupérer les temps d'attente pour les files d'attente mobiles.
Requête
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Requête
| Clé | Valeur | Description |
|---|---|---|
| lang | en | |
| menu_type | mobile_menu |
Corps : aucun
Temps d'attente pour les files d'attente mobiles
[
{
"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
}
]
Code d'état : 200
Temps d'attente entre wait[from] et wait[to]
Cet exemple montre comment récupérer les appels dont les temps d'attente sont compris entre les valeurs "wait from" (attente à partir de) et "wait to" (attente jusqu'à).
Requête
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Requête
| Clé | Valeur | Description |
|---|---|---|
| lang | en | |
| wait[from] | 5 | |
| wait[to] | 15 |
Corps : aucun
Réponse : Temps d'attente entre wait[from] et 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
}
]
Code d'état : 200
Temps d'attente des appels vocaux pour les files d'attente mobiles supérieures à cinq secondes
Cet exemple montre comment récupérer les appels vocaux mobiles dont le temps d'attente est supérieur à cinq secondes.
Requête
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Requête
| Clé | Valeur | Description |
|---|---|---|
| lang | en | |
| menu_type | mobile_menu | |
| channel_type | voice_call | |
| wait[from] | 5 |
Corps : aucun
Réponse : temps d'attente des appels vocaux pour les files d'attente mobiles supérieurs à cinq secondes
[
{
"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
}
]
Code d'état : 200
Temps d'attente pour un menu spécifique
Cet exemple montre comment récupérer les temps d'attente pour un ID de menu spécifique.
Requête
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Requête
| Clé | Valeur | Description |
|---|---|---|
| lang | en | |
| menu_id | 9 |
Corps : aucun
Réponse : temps d'attente pour un menu spécifique
[
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
Code d'état : 200
Temps d'attente pour tous les appels vocaux
Cet exemple montre comment récupérer les temps d'attente pour tous les appels vocaux en cours.
Requête
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Requête
| Clé | Valeur | Description |
|---|---|---|
| lang | en | |
| channel_type | voice_call |
Corps : aucun
Temps d'attente pour tous les appels vocaux
[
{
"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
}
]
Code d'état : 200
Temps d'attente pour les files d'attente en anglais
Cet exemple montre comment récupérer tous les temps d'attente pour les files d'attente dont la langue est l'anglais.
Requête
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Requête
| Clé | Valeur | Description |
|---|---|---|
| lang | en |
Corps : aucun
Réponse : temps d'attente pour les files d'attente en anglais
[
{
"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
}
]
Code d'état : 200