RessourcenSitzungen

Sitzungen

Erstellen, auflisten, aktualisieren und beenden Sie Desktop-Sitzungen über die Talkturo API — verwalten Sie Echtzeit-Coaching-Sitzungen für die Close AI Desktop-App.

curl -X GET "https://api.talkturo.com/api/sessions" \
  -H "Authorization: Bearer tk_example_9xmk7q2r"

{
  "success": true,
  "sessions": [
    {
      "id": "ses_7f3a2d1c",
      "accountId": "acc_4c9d8e1a",
      "status": "active",
      "platform": "close-desktop",
      "desktopTokenId": "dtk_a1b2c3d4",
      "startedAt": "2025-01-14T10:15:00.000Z",
      "endedAt": null,
      "metadata": {
        "workspace": "Acme SDR Team",
        "userEmail": "jane@acme.com"
      },
      "createdAt": "2025-01-14T10:15:00.000Z",
      "updatedAt": "2025-01-14T10:18:12.000Z"
    }
  ]
}

curl -X POST "https://api.talkturo.com/api/sessions" \
  -H "Authorization: Bearer tk_example_9xmk7q2r" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "close-desktop",
    "desktopTokenId": "dtk_a1b2c3d4",
    "metadata": {
      "workspace": "Acme SDR Team",
      "userEmail": "jane@acme.com"
    }
  }'

{
  "success": true,
  "session": {
    "id": "ses_7f3a2d1c",
    "accountId": "acc_4c9d8e1a",
    "status": "active",
    "platform": "close-desktop",
    "desktopTokenId": "dtk_a1b2c3d4",
    "startedAt": "2025-01-14T10:15:00.000Z",
    "endedAt": null,
    "metadata": {
      "workspace": "Acme SDR Team",
      "userEmail": "jane@acme.com"
    },
    "createdAt": "2025-01-14T10:15:00.000Z",
    "updatedAt": "2025-01-14T10:15:00.000Z"
  }
}

curl -X GET "https://api.talkturo.com/api/sessions/ses_7f3a2d1c" \
  -H "Authorization: Bearer tk_example_9xmk7q2r"

{
  "success": true,
  "session": {
    "id": "ses_7f3a2d1c",
    "accountId": "acc_4c9d8e1a",
    "status": "active",
    "platform": "close-desktop",
    "desktopTokenId": "dtk_a1b2c3d4",
    "startedAt": "2025-01-14T10:15:00.000Z",
    "endedAt": null,
    "metadata": {
      "workspace": "Acme SDR Team",
      "userEmail": "jane@acme.com"
    },
    "createdAt": "2025-01-14T10:15:00.000Z",
    "updatedAt": "2025-01-14T10:18:12.000Z"
  }
}

curl -X PATCH "https://api.talkturo.com/api/sessions/ses_7f3a2d1c" \
  -H "Authorization: Bearer tk_example_9xmk7q2r" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "ended",
    "endedAt": "2025-01-14T11:05:00.000Z",
    "metadata": {
      "workspace": "Acme SDR Team",
      "userEmail": "jane@acme.com",
      "callId": "call_92c4d7e1"
    }
  }'

{
  "success": true,
  "session": {
    "id": "ses_7f3a2d1c",
    "accountId": "acc_4c9d8e1a",
    "status": "ended",
    "platform": "close-desktop",
    "desktopTokenId": "dtk_a1b2c3d4",
    "startedAt": "2025-01-14T10:15:00.000Z",
    "endedAt": "2025-01-14T11:05:00.000Z",
    "metadata": {
      "workspace": "Acme SDR Team",
      "userEmail": "jane@acme.com",
      "callId": "call_92c4d7e1"
    },
    "createdAt": "2025-01-14T10:15:00.000Z",
    "updatedAt": "2025-01-14T11:05:02.000Z"
  }
}

curl -X DELETE "https://api.talkturo.com/api/sessions/ses_7f3a2d1c" \
  -H "Authorization: Bearer tk_example_9xmk7q2r"

{
  "success": true,
  "message": "Session deleted successfully"
}

curl -X POST "https://api.talkturo.com/api/sessions/end-all" \
  -H "Authorization: Bearer tk_example_9xmk7q2r"

{
  "success": true,
  "endedCount": 3
}

Verwaltung von Sitzungen

Verwalten Sie Desktop-Sitzungen für die Close AI Desktop-App mit REST-Endpunkten, die Sitzungen auflisten, neue Sitzungen erstellen, aktive Sitzungen aktualisieren, einzelne Sitzungen löschen und alle aktiven Sitzungen auf einmal beenden.

MethodeEndpunktZweck
GET/api/sessionsSitzungen für Ihr Konto auflisten
POST/api/sessionsEine neue Desktop-Sitzung erstellen
GET/api/sessions/{id}Eine einzelne Sitzung anhand ihrer ID abrufen
PATCH/api/sessions/{id}Metadaten oder Status einer Sitzung aktualisieren
DELETE/api/sessions/{id}Eine Sitzung löschen
POST/api/sessions/end-allAlle aktiven Sitzungen für Ihr Konto beenden

Diese Endpunkte unterstützen Desktop-Sitzungsabläufe für Echtzeit-Coaching in der Close AI Desktop-App. Verwenden Sie den Desktop-Authentifizierungsleitfaden, wenn Sie Desktop-Token oder den Anmeldeablauf separat implementieren.

GET /api/sessions

Listen Sie alle Sitzungen für das authentifizierte Konto ab. Verwenden Sie diesen Endpunkt, um aktive oder kürzlich erstellte Desktop-Sitzungen anzuzeigen.

Abfrageparameter

query
statusstring

Filtern Sie Sitzungen nach Status. Typische Werte sind active und ended.

query
limitinteger

Begrenzt die Anzahl der zurückgegebenen Sitzungen.

query
offsetinteger

Überspringt eine Anzahl von Ergebnissen für die Paginierung.

Antwortfelder

successboolean

Gibt an, ob die Anfrage erfolgreich war.

sessionsarray

Enthält die Liste der Sitzungsobjekte für das authentifizierte Konto.

sessions[].idstring

Die eindeutige Sitzungs-ID.

sessions[].accountIdstring

Die Konto-ID, der die Sitzung gehört.

sessions[].statusstring

Der aktuelle Sitzungsstatus.

sessions[].platformstring

Die Client-Plattform, die die Sitzung erstellt hat.

sessions[].desktopTokenIdstring

Die ID des Desktop-Tokens, das mit der Sitzung verknüpft ist.

sessions[].startedAtstring

Der ISO 8601-Zeitstempel, zu dem die Sitzung gestartet wurde.

sessions[].endedAtstring

Der ISO 8601-Zeitstempel, zu dem die Sitzung beendet wurde, oder null, wenn sie noch aktiv ist.

sessions[].metadataobject

Zusätzliche Sitzungsmetadaten, die zusammen mit der Sitzung gespeichert werden.

sessions[].createdAtstring

Der ISO 8601-Zeitstempel, zu dem die Sitzung erstellt wurde.

sessions[].updatedAtstring

Der ISO 8601-Zeitstempel der letzten Aktualisierung der Sitzung.

POST /api/sessions

Erstellen Sie eine neue Desktop-Sitzung, wenn sich ein Benutzer in der Close AI Desktop-App anmeldet oder eine neue Coaching-Sitzung startet.

Request-Body

body
platformstring
Required

Die Plattform, die die Sitzung erstellt. Verwenden Sie für Desktop-Sitzungen close-desktop.

body
desktopTokenIdstring
Required

Die ID des Desktop-Tokens, das für diese Sitzung verwendet wird.

body
metadataobject

Optionale Metadaten für die Sitzung, zum Beispiel Workspace- oder Benutzerdetails.

Antwortfelder

successboolean

Gibt an, ob die Sitzung erfolgreich erstellt wurde.

sessionobject

Das neu erstellte Sitzungsobjekt.

GET /api/sessions/{id}

Rufen Sie eine einzelne Sitzung anhand ihrer ID ab. Verwenden Sie diesen Endpunkt, wenn Sie den Status oder die Metadaten einer bestimmten Desktop-Sitzung prüfen müssen.

Pfadparameter

path
idstring
Required

Die eindeutige ID der Sitzung, die Sie abrufen möchten.

Antwortfelder

successboolean

Gibt an, ob die Anfrage erfolgreich war.

sessionobject

Das Sitzungsobjekt, das der angegebenen ID entspricht.

PATCH /api/sessions/{id}

Aktualisieren Sie eine bestehende Sitzung, um ihren Status zu ändern oder Metadaten zu ergänzen. Verwenden Sie diesen Endpunkt typischerweise, wenn eine Sitzung endet oder wenn die Desktop-App zusätzliche Kontextdaten sendet.

Pfadparameter

path
idstring
Required

Die eindeutige ID der Sitzung, die Sie aktualisieren möchten.

Request-Body

body
statusstring

Aktualisiert den Sitzungsstatus, zum Beispiel auf active oder ended.

body
endedAtstring

Setzt den ISO 8601-Zeitstempel, zu dem die Sitzung beendet wurde.

body
metadataobject

Ersetzt oder erweitert die mit der Sitzung gespeicherten Metadaten, abhängig von der Implementierung des Endpunkts.

Antwortfelder

successboolean

Gibt an, ob die Sitzung erfolgreich aktualisiert wurde.

sessionobject

Das aktualisierte Sitzungsobjekt.

Wenn Sie eine Sitzung beenden, senden Sie status mit dem Wert ended zusammen mit endedAt, damit Sitzungsdauer und Aktivitätsstatus konsistent bleiben.

DELETE /api/sessions/{id}

Löschen Sie eine einzelne Sitzung anhand ihrer ID. Verwenden Sie diesen Endpunkt, wenn Sie eine Sitzung entfernen müssen, anstatt sie nur als beendet zu markieren.

Pfadparameter

path
idstring
Required

Die eindeutige ID der Sitzung, die Sie löschen möchten.

Antwortfelder

successboolean

Gibt an, ob die Sitzung erfolgreich gelöscht wurde.

messagestring

Eine Bestätigungsnachricht nach erfolgreicher Löschung.

POST /api/sessions/end-all

Beenden Sie alle aktiven Sitzungen für das authentifizierte Konto in einer einzigen Anfrage. Das ist nützlich, wenn Sie Desktop-Zugriff global widerrufen oder nach einer Sicherheitsmaßnahme alle laufenden Sitzungen schließen müssen.

Antwortfelder

successboolean

Gibt an, ob die Anfrage erfolgreich war.

endedCountinteger

Die Anzahl der Sitzungen, die in dieser Anfrage beendet wurden.

Dieser Endpunkt kann mehrere aktive Desktop-Sitzungen gleichzeitig beenden. Verwenden Sie ihn nur, wenn Sie alle laufenden Sitzungen für das Konto absichtlich schließen möchten.

Verwandte Ressourcen

Desktop-Authentifizierung

Close AI Desktop-App

Was this page helpful?