Zum Inhalt

Anrufzusammenfassungen

Verwende einen API-Schlüssel oder REST-OAuth-Access-Token. Scopes und deine aktuellen Workspace-Rechte gelten gemeinsam. Die Beispiele verwenden fiktive Daten.

gespeicherte Anrufzusammenfassungen auflisten

GET /api/external/v1/call-summaries

Scope: call-summaries:read

Liest gespeicherte Anrufzusammenfassungen für einen Zeitraum.

  • Auswahl nach Anrufbeginn: from einschließlich, to ausschließlich. Beide Grenzen mit Zeitzone angeben.
  • Alle Seiten abrufen. Die Ergebnisse enthalten gespeicherte nicht leere Zusammenfassungen und geschwärzte Einträge.
  • Bei Schwärzung sind Zusammenfassung und Rufnummern null. Es werden keine Transkripte oder neu erzeugten Zusammenfassungen geliefert.

Ein leeres Ergebnis beweist nicht, dass keine Anrufe stattfanden.

Parameter

Name Position Typ Pflicht Beschreibung
from Query string (date-time) Ja Anrufbeginn ab dieser Grenze einschließlich, mit Zeitzone.
Beispiel: 2026-11-02T00:00:00+01:00
to Query string (date-time) Ja Anrufbeginn bis zu dieser Grenze ausschließlich, mit Zeitzone; muss nach from liegen.
Beispiel: 2026-11-03T00:00:00+01:00
page Query integer (int32) Nein Seitenindex ab 0.
Regeln: 0–100000
Standard: 0
size Query integer (int32) Nein Ergebnisse pro Seite.
Regeln: 1–100
Standard: 25

Antwort 200

Erfolgreich.

Header Typ Beschreibung
Cache-Control string Die Antwort darf nicht zwischengespeichert werden.
Beispiel: no-store

application/json

Feld Typ Beschreibung
items Liste von object Ergebnisse dieser Seite.
page integer (int32) Aktueller Seitenindex, beginnend bei 0.
size integer (int32) Angeforderte Anzahl der Ergebnisse pro Seite.
totalElements integer (int64) Gesamtzahl der passenden Ergebnisse.
totalPages integer (int32) Gesamtzahl der Ergebnisseiten.
items — Felder
Feld Typ Beschreibung
callRecordId string (uuid) ID des Anrufdatensatzes.
fromNumber string Gespeicherte Anrufernummer; null bei Schwärzung.
toNumber string Gespeicherte Zielrufnummer; null bei Schwärzung.
startTime string (date-time) Startzeit des Anrufs.
endTime string (date-time) Endzeit des Anrufs; null, wenn er noch nicht beendet ist.
durationSeconds integer (int64) Anrufdauer in Sekunden; null, wenn sie noch nicht vorliegt.
direction string Richtung des Anrufs.
purpose string Dem Anruf zugeordneter Zweck.
Werte: INBOUND_AI, OUTBOUND_CAMPAIGN, FORWARDING_LEG, SCREENING_LEG
isForwarded boolean Ob der Anruf weitergeleitet wurde.
isConferenceCall boolean Ob der Anruf eine Konferenz verwendet hat.
excludedFromBilling boolean Ob dieser Anruf von der Abrechnung ausgenommen ist.
piiRedacted boolean Ob personenbezogene Anrufdaten geschwärzt wurden.
summary string Gespeicherte Anrufzusammenfassung; null bei Schwärzung.
{
  "items": [
    {
      "callRecordId": "00000000-0000-0000-0000-000000000001",
      "fromNumber": null,
      "toNumber": null,
      "startTime": "2026-11-02T09:00:00Z",
      "endTime": "2026-11-02T09:03:00Z",
      "durationSeconds": 180,
      "direction": "string",
      "purpose": "INBOUND_AI",
      "isForwarded": false,
      "isConferenceCall": false,
      "excludedFromBilling": false,
      "piiRedacted": false,
      "summary": "The caller requested a callback about a service appointment."
    }
  ],
  "page": 0,
  "size": 25,
  "totalElements": 1,
  "totalPages": 1
}
Fehlerantworten
Status Bedeutung
400 Ungültige Eingabe, Auswahl oder Zeitgrenzen.
401 Fehlender, abgelaufener oder ungültiger Zugang. Der Body kann leer sein.
403 Benötigter Scope oder aktuelles Benutzerrecht fehlt. Der Body kann leer sein.
429 Gemeinsames Workspace-Budget überschritten. Retry-After abwarten; unklare Schreibvorgänge nicht blind wiederholen.
503 Vorübergehend nicht verfügbar. Unklare Schreibvorgänge vor erneutem Versuch prüfen.

Fehler-Body

Feld Typ Beschreibung
status integer HTTP-Statuscode.
error string Beschreibung des Fehlers.
details any Weitere Fehlerdetails, sofern vorhanden.
Regeln: null erlaubt
code string Maschinenlesbarer Fehlercode.
params object Zusätzliche Werte zum Fehlercode.
fieldErrors object Validierungsfehler nach Eingabefeld.

Bei 429 oder 503 den Header Retry-After (Sekunden) beachten. Unklare Schreibvorgänge vor einem neuen Versuch prüfen.