Die Contact Center AI Platform (CCAI Platform) bietet den Endpunkt Wait time, um die aktuellen Wartezeiten für Warteschlangen verschiedener Kanaltypen abzurufen.
Wartezeit
| Parameter | Erforderlich | Datentyp | Definition |
|---|---|---|---|
| lang | TRUE | String | Sprachcode der Warteschlange. (z.B. „en“) |
| menu_id | FALSE | Ganzzahl | Die Antwort filtert alle Menüs im Unterbaum dieses Menüs, einschließlich des Menüs selbst. |
| menu_type | FALSE | String | Gibt Menüs bestimmter Typen zurück. Mögliche Werte: ivr_menu, mobile_menu, web_menu. |
| channel_type | FALSE | String | Gibt Menüs eines bestimmten Channels zurück. Mögliche Werte: voice_call, chat. |
| wait[from] | FALSE | Ganzzahl | Gibt Datensätze zurück, wenn die Wartezeit größer als der Wert ist. |
| wait[to] | FALSE | Ganzzahl | Gibt Datensätze zurück, wenn die Wartezeit unter dem Wert liegt. |
Endpunkt:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/wait_times
Überschriften:
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| Content-Type | application/json |
Beispielanfrage und -antworten
In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.
Wartezeiten für mobile Warteschlangen
In diesem Beispiel wird gezeigt, wie Sie die Wartezeiten für die mobilen Warteschlangen abrufen.
Anfrage
Überschriften:
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| Content-Type | application/json |
Suchanfrage
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| lang | de | |
| menu_type | mobile_menu |
Body: None
Antwort: Wartezeiten für mobile Warteschlangen
[
{
"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
}
]
Statuscode:200
Wartezeiten zwischen „wait[from]“ und „wait[to]“
In diesem Beispiel wird gezeigt, wie Sie die Anrufe abrufen, die Wartezeiten zwischen den Werten „wait from“ und „wait to“ haben.
Anfrage
Überschriften:
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| Content-Type | application/json |
Suchanfrage
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| lang | de | |
| wait[from] | 5 | |
| wait[to] | 15 |
Body: None
Antwort: Wartezeiten zwischen wait[from] und 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
}
]
Statuscode:200
Wartezeiten für Sprachanrufe für mobile Warteschlangen von mehr als 5 Sekunden
In diesem Beispiel wird gezeigt, wie Sie die Mobilfunkanrufe abrufen, die eine Wartezeit von mehr als 5 Sekunden haben.
Anfrage
Überschriften:
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| Content-Type | application/json |
Suchanfrage
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| lang | de | |
| menu_type | mobile_menu | |
| channel_type | voice_call | |
| wait[from] | 5 |
Body: None
Antwort: Wartezeiten für Sprachanrufe für mobile Warteschlangen von mehr als 5 Sekunden
[
{
"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
}
]
Statuscode:200
Wartezeiten für ein bestimmtes Menü
In diesem Beispiel wird gezeigt, wie Sie die Wartezeiten für eine bestimmte Menü-ID abrufen.
Anfrage
Überschriften:
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| Content-Type | application/json |
Suchanfrage
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| lang | de | |
| menu_id | 9 |
Body: None
Antwort: Wartezeiten für ein bestimmtes Menü
[
{
"menu_id": 9,
"menu_type": "ivr_menu",
"voice_call": 10,
"materialized_path": "Death Star",
"logged_in_agents": 3,
"available_agents": 2,
"breakthrough_agents": 1
}
]
Statuscode:200
Wartezeiten für alle Sprachanrufe
In diesem Beispiel wird gezeigt, wie Sie die Wartezeiten für alle aktuellen Sprachanrufe abrufen.
Anfrage
Überschriften:
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| Content-Type | application/json |
Suchanfrage
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| lang | de | |
| channel_type | voice_call |
Body: None
Antwort: Wartezeiten für alle Sprachanrufe
[
{
"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
}
]
Statuscode:200
Wartezeiten für englischsprachige Warteschlangen
In diesem Beispiel wird gezeigt, wie alle Wartezeiten für die Warteschlangen mit der Sprache Englisch abgerufen werden.
Anfrage
Überschriften:
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| Content-Type | application/json |
Suchanfrage
| Schlüssel | Wert | Beschreibung |
|---|---|---|
| lang | de |
Body: None
Antwort: Wartezeiten für englischsprachige Warteschlangen
[
{
"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
}
]
Statuscode:200