Auf dieser Seite wird beschrieben, wie Sie beim Aufrufen der Endpunkte der Manager API Paginierung und Tailing verwenden.
Seitenumbruch
Die Paginierung wird für die meisten Endpunkte der Manager API unterstützt. Ausnahmen finden Sie unter Endpunkt für aktualisierte Datensätze abrufen.
Seitengröße festlegen
Standardmäßig geben Manager-API-Endpunkte Seiten mit 100 Datensätzen zurück. Sie können diese Zahl mit dem Abfrageparameter per ändern.
Verwenden Sie den folgenden Endpunkt, um die Seitengröße festzulegen:
/manager/api/v1/agents?per=50
Dadurch wird die Seitengröße auf 50 Datensätze festgelegt.
Bestimmte Seite anfordern
Mit dem Abfrageparameter page können Sie eine bestimmte Seite mit Datensätzen anfordern.
Verwenden Sie den folgenden Endpunkt, um eine bestimmte Seite anzufordern:
/manager/api/v1/agents?page=2
Dadurch wird die zweite Seite mit Datensätzen zurückgegeben.
Alle verfügbaren Datensätze abrufen
Standardmäßig gibt die Manager API 100 Datensätze auf einer Antwortseite zurück. Sie können die Anzahl der Datensätze auf einer Seite jedoch ändern, indem Sie die Seitengröße festlegen. Bei den Endpunkten, die Paginierung unterstützen, enthält der Antwortheader die Gesamtzahl der verfügbaren Datensätze. Wenn diese Zahl Ihre Seitengröße überschreitet, müssen Sie die API mehrmals aufrufen, um alle Datensätze abzurufen. In der Manager API wird nicht explizit angegeben, dass weitere Datensätze zurückgegeben werden müssen.
So rufen Sie alle verfügbaren Datensätze ab:
Rufen Sie einen Manager-API-Endpunkt auf, der die Paginierung unterstützt. Weitere Informationen finden Sie unter Paginierung. Der Antwortheader gibt an, wie viele Datensätze zurückgegeben werden müssen.
Vergleichen Sie die Anzahl der zurückzugebenden Datensätze mit Ihrer Seitengröße. Wenn die Anzahl der zurückzugebenden Datensätze kleiner als die Seitengröße ist, wurden alle Datensätze zurückgegeben. Ist dies nicht der Fall, fahren Sie mit dem nächsten Schritt fort.
Rufen Sie den Endpunkt noch einmal auf und geben Sie die nächste Seite mit Datensätzen an. Weitere Informationen finden Sie unter Eine bestimmte Seite anfordern. Wiederholen Sie diesen Schritt, bis alle Ihre Datensätze zurückgegeben werden.
Endpunkt nach aktualisierten Datensätzen durchsuchen
Google rät von der Verwendung der Paginierung für die API-Endpunkte call, chat und agent activity ab, da wir keine optimalen Ergebnisse garantieren können. Stattdessen empfehlen wir, diese API-Endpunkte für aktualisierte Datensätze zu verwenden. Einen API-Endpunkt zu tailen bedeutet, ihn kontinuierlich aufzurufen, um Datensätze abzurufen, die seit Ihrer letzten Anfrage neu oder aktualisiert wurden.
Calls API-Endpunkt verfolgen
Wenn ein Anrufeintrag geändert wird, wird der updated_at-Zeitstempel aktualisiert. Mit dem Zeitstempel können Sie die Anrufdatensätze angeben, die Sie beim Aufrufen des Calls API-Endpunkt abrufen möchten.
So rufen Sie den Calls API-Endpunkt alle 60 Minuten ab:
Stellen Sie eine Anfrage an den Calls API-Endpunkt (
/manager/api/v1/calls) und geben Sie die folgenden Abfrageparameter an:updated_at[from]: Geben Sie an, dass Sie Datensätze möchten, die zu diesem Zeitpunkt oder danach aktualisiert wurden.sort_column: Geben Sie das Feld an, nach dem die Datensätze sortiert werden sollen.sort_direction: Gibt die Sortierrichtung der Datensätze in der Antwort an.
Das folgende Beispiel zeigt ein Bash-Skript, in dem der Befehl
curlverwendet wird:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com/" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/calls?updated_at[from]=${TIMESTAMP}&sort_column=updated_at&sort_direction=asc" | jqDie Calls API gibt eine Antwort ähnlich der folgenden zurück:
[ { "id": 100, ... "updated_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "updated_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "updated_at": "2025-01-03T00:00:00Z" } ]Antwortobjekte, die am oder nach dem von Ihnen angegebenen Zeitstempel aktualisiert wurden, werden nach Datum in aufsteigender Reihenfolge zurückgegeben. Verwenden Sie den
updated_at-Zeitstempel aus dem letzten Objekt in dieser Antwort für den Zeitstempel in Ihrem nächsten Aufruf des Endpunkts.Rufen Sie den Call API-Endpunkt 60 Minuten später auf. Die aktualisierten Anrufdatensätze seit Ihrer letzten Anfrage werden zurückgegeben.
Wiederholen Sie den vorherigen Schritt, um das Tailing des Endpunkts fortzusetzen.
Chats API-Endpunkt anpassen
Wenn ein Chatdatensatz geändert wird, wird der updated_at-Zeitstempel aktualisiert. Mit dem Zeitstempel können Sie die Chatdatensätze angeben, die Sie beim Aufrufen des Chats API-Endpunkt abrufen möchten.
So rufen Sie den Chats API-Endpunkt alle 60 Minuten ab:
Stellen Sie eine Anfrage an den Chats API-Endpunkt (
/manager/api/v1/chats) und geben Sie die folgenden Abfrageparameter an:updated_at[from]: Geben Sie an, dass Sie Datensätze möchten, die zu diesem Zeitpunkt oder danach aktualisiert wurden.sort_column: Geben Sie das Feld an, nach dem die Datensätze sortiert werden sollen.sort_direction: Gibt die Sortierrichtung der Datensätze in der Antwort an.
Das folgende Beispiel zeigt ein Bash-Skript, in dem der Befehl
curlverwendet wird:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com/" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3.. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/chats?updated_at[from]=${TIMESTAMP}&sort_column=updated_at&sort_direction=asc" | jqDie Chats API gibt eine Antwort ähnlich der folgenden zurück:
[ { "id": 100, ... "updated_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "updated_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "updated_at": "2025-01-03T00:00:00Z" } ]Es werden Antwortobjekte zurückgegeben, die am oder nach dem angegebenen Zeitstempel aktualisiert wurden. Sie sind nach Datum in aufsteigender Reihenfolge sortiert. Verwenden Sie den
updated_at-Zeitstempel aus dem letzten Objekt in dieser Antwort für den Zeitstempel in Ihrem nächsten Aufruf des Endpunkts.Rufen Sie den API-Endpunkt 60 Minuten später noch einmal auf. Die aktualisierten Chataufzeichnungen seit Ihrer letzten Anfrage werden zurückgegeben.
Wiederholen Sie den vorherigen Schritt, um das Tailing des Endpunkts fortzusetzen.
Agent Activity API-Endpunkt anpassen
Im Gegensatz zu den Chat- und Anrufaufzeichnungen werden die Agent-Aktivitätsprotokolle nicht aktualisiert und haben daher keinen updated_at-Zeitstempel. Mit dem started_at-Zeitstempel können Sie die Aktivitätsdatensätze angeben, die beim Aufrufen des Agent Activity API-Endpunkt abgerufen werden sollen.
So rufen Sie den Agent Activity API-Endpunkt alle 60 Minuten ab:
Senden Sie eine Anfrage an den Agent Activity API-Endpunkt (
/manager/api/v1/agent_activity_logs) und geben Sie die folgenden Abfrageparameter an:started_at[from]: Geben Sie an, dass Sie Aktivitätsprotokolle für Aktivitäten wünschen, die an oder nach diesem Zeitpunkt begonnen haben.sort_column: Geben Sie das Feld an, nach dem die Datensätze sortiert werden sollen.sort_direction: Gibt die Sortierrichtung der Datensätze in der Antwort an.
Das folgende Beispiel zeigt ein Bash-Skript, in dem der Befehl
curlverwendet wird:# 1. Define your environment variables (usually set in your shell or .env file) export API_HOSTNAME="ccaip-host.uc1.ccaiplatform.com/" export API_USER="ccaip-host" export API_PASS="CCAI Platform API Key" # 2. Calculate the timestamp for 60 minutes ago in ISO 8601 format (UTC) # For macOS (BSD date): # TIMESTAMP=$(date -v-60M -u +"%Y-%m-%dT%H:%M:%SZ") # For Linux (GNU date): TIMESTAMP=$(date --date='60 minutes ago' -u +"%Y-%m-%dT%H:%M:%SZ") # 3. Execute the curl command # -u handles the Base64 encoding for Basic Auth automatically curl -g -u "${API_USER}:${API_PASS}" \ "https://${API_HOSTNAME}/manager/api/v1/agent_activity_logs?started_at[from]=${TIMESTAMP}&sort_column=started_at&sort_direction=asc" | jqDie Agent Activity API gibt eine Antwort ähnlich der folgenden zurück:
[ { "id": 100, ... "started_at": "2025-01-01T00:00:00Z" }, { "id": 98, ... "started_at": "2025-01-02T00:00:00Z" }, { "id": 150, ... "started_at": "2025-01-03T00:00:00Z" } ]Es werden Antwortobjekte zurückgegeben, die am oder nach dem angegebenen Zeitstempel begonnen haben. Sie werden nach Datum in aufsteigender Reihenfolge sortiert. Verwenden Sie den
started_at-Zeitstempel aus dem letzten Objekt in dieser Antwort für den Zeitstempel in Ihrem nächsten Aufruf des Endpunkts.Rufen Sie den API-Endpunkt für Agent-Aktivitäten 60 Minuten später noch einmal auf. Die aktualisierten Agent Activity Log-Einträge seit Ihrer letzten Anfrage werden zurückgegeben.
Wiederholen Sie den vorherigen Schritt, um das Tailing des Endpunkts fortzusetzen.