Zum Hauptinhalt springen

Ordner

Ein Ordner organisiert Aufnahmen in einem Baum und steuert, wer sie sieht. Diese Endpunkte lesen und ändern Ordner, verwalten ihre Freigaben und ordnen Aufnahmen zu.

Jeder Endpunkt unten zeigt in der Mitte seine Parameter und Antwortfelder und rechts ein Anfragebeispiel mit Beispielantwort.

Basis-URL https://api.sally.ioVersion v1.0 aktuell, noch nicht eingefrorenSo funktioniert die Versionierung

Listet die Aufnahmeordner auf, auf die der Aufrufer zugreifen kann (paginiert, optional gefiltert)​

GET/v1.0/directories/{directoryId}/folders

Führt persönliche, freigegebene und Team-Ordner in einer Liste zusammen. Paginierung über ?page + ?pageSize (max. 100, im Speicher angewendet). Ein optionaler Teilstring in ?search wird mit dem Ordnernamen abgeglichen (ohne Beachtung der Groß- und Kleinschreibung). Übergib ?parentRecordingFolderId, um nur die direkten Unterordner eines Ordners aufzulisten; lass den Parameter weg, um alle Ordner aufzulisten.

Feldübersicht aus der Spezifikation

Felder der Antwort:

  • page / pageSize / total / hasMore: Paginierungsrahmen (aktuelle Seite, Seitengröße, Gesamtanzahl, ob weitere Seiten folgen).
  • items (array): die Ordner auf dieser Seite. Jeder Eintrag enthält:
    • folderId (string): Id des Ordners.
    • name (string): Anzeigename des Ordners.
    • description (string | null): Beschreibung des Ordners; null, wenn nicht gesetzt.
    • ownerUserId (string): Id des Nutzers, dem der Ordner gehört.
    • parentFolderId (string | null): Id des übergeordneten Ordners; null, wenn es ein Ordner der obersten Ebene ist.
    • isOwner (boolean): true, wenn der Aufrufer Owner des Ordners ist.
    • isFavorite (boolean): true, wenn der Aufrufer den Ordner als Favorit markiert hat.
    • accessLevel (string, einer von none/read/readWrite): die effektive Zugriffsstufe des Aufrufers auf den Ordner.
    • recordingsCount (number): Anzahl der Aufnahmen im Ordner.
    • createdOn (string): Erstellungszeitstempel (ISO 8601).
    • modifiedOn (string): Zeitstempel der letzten Änderung (ISO 8601).

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

  • pagenumberoptional

    Seitennummer, beginnend bei 1. Standard: 1.

  • pageSizenumberoptional

    Einträge pro Seite. Standard: 25, maximal 100.

  • searchstringoptional

    Teilstring-Suche im Ordnernamen ohne Beachtung der Groß- und Kleinschreibung. Der Suchbegriff darf am Anfang, in der Mitte oder am Ende stehen.

  • parentRecordingFolderIdstringoptional

    Id des übergeordneten Aufnahmeordners.

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: accessLevel, createdOn, description, folderId, isFavorite, isOwner, modifiedOn, name, ownerUserId, parentFolderId, recordingsCount.

    Beispiel: accessLevel,createdOn

Antwort: je Eintrag in items

  • folderIdstringPflicht

    Id des Ordners.

  • namestringPflicht

    Anzeigename des Ordners.

  • descriptionstringPflichtkann null sein

    Beschreibung des Ordners; null, wenn nicht gesetzt.

  • ownerUserIdstringPflicht

    Id des Nutzers, dem der Ordner gehört.

  • parentFolderIdstringPflichtkann null sein

    Id des übergeordneten Ordners; null, wenn es ein Ordner der obersten Ebene ist.

  • isOwnerbooleanPflicht

    True, wenn der Aufrufer Owner des Ordners ist.

  • isFavoritebooleanPflicht

    True, wenn der Aufrufer den Ordner als Favorit markiert hat.

  • accessLevelstringPflicht

    Die effektive Zugriffsstufe des Aufrufers auf den Ordner.

    Erlaubte Werte: nonereadreadWrite
  • recordingsCountnumberPflicht

    Anzahl der Aufnahmen im Ordner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Jede Seite trägt außerdem page, pageSize, total, hasMore.

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

POST/v1.0/directories/{directoryId}/folders/search

Durchsucht Aufnahmeordner. Führt persönliche, freigegebene und Team-Ordner in einer Liste zusammen und paginiert im Speicher.

Feldübersicht aus der Spezifikation

Body-Felder:

  • search (string, optional): Teilstring für den Ordnernamen, ohne Beachtung der Groß- und Kleinschreibung.
  • parentRecordingFolderId (string, optional): listet nur die direkten Unterordner dieses Ordners auf; weglassen für alle Ordner.
  • page (number, optional, Standard 1): Seitennummer, beginnend bei 1.
  • pageSize (number, optional, Standard 25): Seitengröße (max. 100).

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: accessLevel, createdOn, description, folderId, isFavorite, isOwner, modifiedOn, name, ownerUserId, parentFolderId, recordingsCount.

    Beispiel: accessLevel,createdOn

Request-Body application/json

  • searchstringoptionalkann null sein

    Teilstring-Suche im Ordnernamen ohne Beachtung der Groß- und Kleinschreibung. Der Suchbegriff darf am Anfang, in der Mitte oder am Ende stehen.

  • parentRecordingFolderIdstringoptionalkann null sein

    Listet nur die direkten Unterordner dieses Ordners auf; weglassen für alle Ordner.

  • pagenumberoptional

    Seite (beginnend bei 1, Standard 1).

  • pageSizenumberoptional

    Seitengröße (Standard 25, max. 100).

Antwort: je Eintrag in items

  • folderIdstringPflicht

    Id des Ordners.

  • namestringPflicht

    Anzeigename des Ordners.

  • descriptionstringPflichtkann null sein

    Beschreibung des Ordners; null, wenn nicht gesetzt.

  • ownerUserIdstringPflicht

    Id des Nutzers, dem der Ordner gehört.

  • parentFolderIdstringPflichtkann null sein

    Id des übergeordneten Ordners; null, wenn es ein Ordner der obersten Ebene ist.

  • isOwnerbooleanPflicht

    True, wenn der Aufrufer Owner des Ordners ist.

  • isFavoritebooleanPflicht

    True, wenn der Aufrufer den Ordner als Favorit markiert hat.

  • accessLevelstringPflicht

    Die effektive Zugriffsstufe des Aufrufers auf den Ordner.

    Erlaubte Werte: nonereadreadWrite
  • recordingsCountnumberPflicht

    Anzahl der Aufnahmen im Ordner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Jede Seite trägt außerdem page, pageSize, total, hasMore.

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Gibt einen einzelnen Aufnahmeordner zurück​

GET/v1.0/directories/{directoryId}/folders/{folderId}

Der Aufrufer muss Mitglied des Unternehmenskontos sein und mindestens Lesezugriff auf den Ordner haben, sonst 404/403. accessLevel gibt den effektiven Zugriff des Aufrufers wieder.

Feldübersicht aus der Spezifikation

Felder der Antwort:

  • folderId (string): Id des Ordners.
  • name (string): Anzeigename des Ordners.
  • description (string | null): Beschreibung des Ordners; null, wenn nicht gesetzt.
  • ownerUserId (string): Id des Nutzers, dem der Ordner gehört.
  • parentFolderId (string | null): Id des übergeordneten Ordners; null, wenn es ein Ordner der obersten Ebene ist.
  • isOwner (boolean): true, wenn der Aufrufer Owner des Ordners ist.
  • isFavorite (boolean): true, wenn der Aufrufer den Ordner als Favorit markiert hat.
  • accessLevel (string, einer von none/read/readWrite): die effektive Zugriffsstufe des Aufrufers auf den Ordner.
  • recordingsCount (number): Anzahl der Aufnahmen im Ordner.
  • createdOn (string): Erstellungszeitstempel (ISO 8601).
  • modifiedOn (string): Zeitstempel der letzten Änderung (ISO 8601).

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • folderIdstringPflicht

    Id des Ordners.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: accessLevel, createdOn, description, folderId, isFavorite, isOwner, modifiedOn, name, ownerUserId, parentFolderId, recordingsCount.

    Beispiel: accessLevel,createdOn

Antwort

  • folderIdstringPflicht

    Id des Ordners.

  • namestringPflicht

    Anzeigename des Ordners.

  • descriptionstringPflichtkann null sein

    Beschreibung des Ordners; null, wenn nicht gesetzt.

  • ownerUserIdstringPflicht

    Id des Nutzers, dem der Ordner gehört.

  • parentFolderIdstringPflichtkann null sein

    Id des übergeordneten Ordners; null, wenn es ein Ordner der obersten Ebene ist.

  • isOwnerbooleanPflicht

    True, wenn der Aufrufer Owner des Ordners ist.

  • isFavoritebooleanPflicht

    True, wenn der Aufrufer den Ordner als Favorit markiert hat.

  • accessLevelstringPflicht

    Die effektive Zugriffsstufe des Aufrufers auf den Ordner.

    Erlaubte Werte: nonereadreadWrite
  • recordingsCountnumberPflicht

    Anzahl der Aufnahmen im Ordner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Aktualisiert einen Aufnahmeordner (Name, Beschreibung, übergeordneter Ordner)​

PATCH/v1.0/directories/{directoryId}/folders/{folderId}

Aktualisiert die Metadaten des Ordners. Nur die übergebenen Felder werden geändert (teilweise); die Freigaben bleiben unberührt (verwende dafür PUT .../folders/{folderId}/shares). Erfordert Lese- und Schreibzugriff auf den Ordner. Gibt den aktualisierten Ordner zurück.

Feldübersicht aus der Spezifikation

Body-Felder:

  • name (string, optional): neuer Ordnername; weglassen, um ihn unverändert zu lassen.
  • description (string, optional): neue Beschreibung; null entfernt sie, weglassen, um sie unverändert zu lassen.
  • parentFolderId (string, optional): Id des neuen übergeordneten Ordners, unter den dieser Ordner verschoben wird; null macht ihn zu einem Ordner der obersten Ebene, weglassen, um ihn unverändert zu lassen.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • folderIdstringPflicht

    Id des Ordners.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: accessLevel, createdOn, description, folderId, isFavorite, isOwner, modifiedOn, name, ownerUserId, parentFolderId, recordingsCount.

    Beispiel: accessLevel,createdOn

Request-Body application/json

  • namestringoptional

    Neuer Ordnername (weglassen, um ihn unverändert zu lassen).

  • descriptionstringoptionalkann null sein

    Neue Ordnerbeschreibung; null zum Entfernen, weglassen, um sie unverändert zu lassen.

  • parentFolderIdstringoptionalkann null sein

    Id des neuen übergeordneten Ordners, unter den dieser Ordner verschoben wird; null macht ihn zu einem Ordner der obersten Ebene, weglassen, um ihn unverändert zu lassen.

Antwort

  • folderIdstringPflicht

    Id des Ordners.

  • namestringPflicht

    Anzeigename des Ordners.

  • descriptionstringPflichtkann null sein

    Beschreibung des Ordners; null, wenn nicht gesetzt.

  • ownerUserIdstringPflicht

    Id des Nutzers, dem der Ordner gehört.

  • parentFolderIdstringPflichtkann null sein

    Id des übergeordneten Ordners; null, wenn es ein Ordner der obersten Ebene ist.

  • isOwnerbooleanPflicht

    True, wenn der Aufrufer Owner des Ordners ist.

  • isFavoritebooleanPflicht

    True, wenn der Aufrufer den Ordner als Favorit markiert hat.

  • accessLevelstringPflicht

    Die effektive Zugriffsstufe des Aufrufers auf den Ordner.

    Erlaubte Werte: nonereadreadWrite
  • recordingsCountnumberPflicht

    Anzahl der Aufnahmen im Ordner.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601).

  • modifiedOnstringPflicht

    Zeitstempel der letzten Änderung (ISO 8601).

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Gibt die Freigaben eines Aufnahmeordners zurück​

GET/v1.0/directories/{directoryId}/folders/{folderId}/shares

Direkte Nutzer-Freigaben, Team-Freigaben und geerbte Freigaben (von übergeordneten Ordnern). Jede Freigabe enthält nur Ids + Zugriffsstufe; Details zu Nutzern und Teams erhältst du über die Mitgliedschafts- und Team-Endpunkte.

Feldübersicht aus der Spezifikation

Felder der Antwort:

  • userShares (array): direkte Nutzer-Freigaben des Ordners. Jeder Eintrag enthält:
    • userId (string): Id des Nutzers, für den dieser Ordner freigegeben ist.
    • accessLevel (string, einer von none/read/readWrite): dem Nutzer gewährte Zugriffsstufe.
  • teamShares (array): Team-Freigaben des Ordners. Jeder Eintrag enthält:
    • teamId (string): Id des Teams, für das dieser Ordner freigegeben ist.
    • accessLevel (string, einer von none/read/readWrite): dem Team gewährte Zugriffsstufe.
  • inheritedShares (array): von übergeordneten Ordnern geerbte Freigaben (schreibgeschützt). Jeder Eintrag enthält:
    • userId (string): Id des Nutzers, der den Zugriff erbt.
    • accessLevel (string, einer von none/read/readWrite): geerbte Zugriffsstufe.
    • inheritedFromFolderId (string): Id des übergeordneten Ordners, von dem der Zugriff geerbt wird.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • folderIdstringPflicht

    Id des Ordners.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: inheritedShares, teamShares, userShares.

    Beispiel: inheritedShares,teamShares

Antwort

  • userSharesobject[]Pflicht

    Direkte Nutzer-Freigaben des Ordners.

    2 Unterfelder
    • userIdstringPflicht

      Id des Nutzers, für den dieser Ordner freigegeben ist.

    • accessLevelstringPflicht

      Dem Nutzer gewährte Zugriffsstufe.

      Erlaubte Werte: nonereadreadWrite
  • teamSharesobject[]Pflicht

    Team-Freigaben des Ordners.

    2 Unterfelder
    • teamIdstringPflicht

      Id des Teams, für das dieser Ordner freigegeben ist.

    • accessLevelstringPflicht

      Dem Team gewährte Zugriffsstufe.

      Erlaubte Werte: nonereadreadWrite
  • inheritedSharesobject[]Pflicht

    Von übergeordneten Ordnern geerbte Freigaben (schreibgeschützt).

    3 Unterfelder
    • userIdstringPflicht

      Id des Nutzers, der den Zugriff erbt.

    • accessLevelstringPflicht

      Geerbte Zugriffsstufe.

      Erlaubte Werte: nonereadreadWrite
    • inheritedFromFolderIdstringPflicht

      Id des übergeordneten Ordners, von dem der Zugriff geerbt wird.

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Setzt die Freigaben eines Aufnahmeordners (vollständiges Ersetzen)​

PUT/v1.0/directories/{directoryId}/folders/{folderId}/shares

Ersetzt die direkten Nutzer-Freigaben und Team-Freigaben des Ordners durch die übergebenen Mengen (geerbte Freigaben sind schreibgeschützt und können nicht gesetzt werden). Nur der Owner des Ordners darf Freigaben ändern. Gibt die resultierenden Freigaben zurück.

Feldübersicht aus der Spezifikation

Body-Felder:

  • userShares (array, Pflicht): anzuwendende direkte Nutzer-Freigaben, jeweils { userId (string), accessLevel (none/read/readWrite) }. Die resultierende Menge ersetzt die aktuelle.
  • teamShares (array, Pflicht): anzuwendende Team-Freigaben, jeweils { teamId (string), accessLevel (none/read/readWrite) }. Die resultierende Menge ersetzt die aktuelle.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • folderIdstringPflicht

    Id des Ordners.

Query-Parameter

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: inheritedShares, teamShares, userShares.

    Beispiel: inheritedShares,teamShares

Request-Body application/json

  • userSharesobject[]Pflicht

    Anzuwendende direkte Nutzer-Freigaben. Die resultierende Menge ersetzt die aktuelle.

    2 Unterfelder
    • userIdstringPflicht

      Id des Nutzers, für den dieser Ordner freigegeben ist.

    • accessLevelstringPflicht

      Dem Nutzer gewährte Zugriffsstufe.

      Erlaubte Werte: nonereadreadWrite
  • teamSharesobject[]Pflicht

    Anzuwendende Team-Freigaben. Die resultierende Menge ersetzt die aktuelle.

    2 Unterfelder
    • teamIdstringPflicht

      Id des Teams, für das dieser Ordner freigegeben ist.

    • accessLevelstringPflicht

      Dem Team gewährte Zugriffsstufe.

      Erlaubte Werte: nonereadreadWrite

Antwort

  • userSharesobject[]Pflicht

    Direkte Nutzer-Freigaben des Ordners.

    2 Unterfelder
    • userIdstringPflicht

      Id des Nutzers, für den dieser Ordner freigegeben ist.

    • accessLevelstringPflicht

      Dem Nutzer gewährte Zugriffsstufe.

      Erlaubte Werte: nonereadreadWrite
  • teamSharesobject[]Pflicht

    Team-Freigaben des Ordners.

    2 Unterfelder
    • teamIdstringPflicht

      Id des Teams, für das dieser Ordner freigegeben ist.

    • accessLevelstringPflicht

      Dem Team gewährte Zugriffsstufe.

      Erlaubte Werte: nonereadreadWrite
  • inheritedSharesobject[]Pflicht

    Von übergeordneten Ordnern geerbte Freigaben (schreibgeschützt).

    3 Unterfelder
    • userIdstringPflicht

      Id des Nutzers, der den Zugriff erbt.

    • accessLevelstringPflicht

      Geerbte Zugriffsstufe.

      Erlaubte Werte: nonereadreadWrite
    • inheritedFromFolderIdstringPflicht

      Id des übergeordneten Ordners, von dem der Zugriff geerbt wird.

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Listet die Aufnahmen in einem Ordner auf (paginiert)​

GET/v1.0/directories/{directoryId}/folders/{folderId}/recordings

Übergib ?includeSubfolders=true, um auch die Aufnahmen aller zugänglichen Unterordner einzubeziehen (rekursiv, dedupliziert). Absteigend nach Erstellungsdatum sortiert. Paginierung über ?page + ?pageSize (max. 100, im Speicher angewendet). Jeder Eintrag verweist über recordingId auf die Aufnahme; vollständige Details erhältst du über GET .../recordings/{recordingId}.

Feldübersicht aus der Spezifikation

Felder der Antwort:

  • page / pageSize / total / hasMore: Paginierungsrahmen (aktuelle Seite, Seitengröße, Gesamtanzahl, ob weitere Seiten folgen).
  • items (array): die Aufnahmen auf dieser Seite. Jeder Eintrag enthält:
    • recordingId (string): Id der Aufnahme.
    • durationInSeconds (number | null): Dauer in Sekunden; null, wenn unbekannt.
    • isManualUpload (boolean): true, wenn manuell hochgeladen (kein Meeting-Bot).
    • appointmentId (string | null): Id des eigenen Termins des Aufrufers, der mit der Aufnahme verknüpft ist; null, wenn keiner vorhanden ist.
    • createdOn (string): Erstellungszeitstempel (ISO 8601, UTC).

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • folderIdstringPflicht

    Id des Ordners.

Query-Parameter

  • includeSubfoldersbooleanoptional

    Bei true werden auch die Aufnahmen aller verschachtelten Unterordner einbezogen. Wenn weggelassen oder false, werden nur die Aufnahmen zurückgegeben, die direkt in diesem Ordner liegen.

  • pagenumberoptional

    Seitennummer, beginnend bei 1. Standard: 1.

  • pageSizenumberoptional

    Einträge pro Seite. Standard: 25, maximal 100.

  • fieldsstringoptional

    Kommagetrennte Liste der Felder, die zurückgegeben werden sollen. Lässt du den Parameter weg, bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Das ist deine Entscheidung: Nenne deine Felder explizit, wenn du davor geschützt sein willst.

    Nur Felder der ersten Ebene können angegeben werden. Eine verschachtelte Liste wie attendees, tags oder sectionItems wird ganz oder gar nicht zurückgegeben; attendees.name wird nicht unterstützt.

    Bei einer paginierten Antwort gilt die Auswahl für die Einträge in items; page, pageSize, total und hasMore werden immer zurückgegeben. Ein unbekannter Name wird mit 400 abgelehnt statt ignoriert.

    Hier auswählbar: appointmentId, createdOn, durationInSeconds, isManualUpload, recordingId.

    Beispiel: appointmentId,createdOn

Antwort: je Eintrag in items

  • recordingIdstringPflicht

    Id der Aufnahme.

  • durationInSecondsnumberPflichtkann null sein

    Dauer in Sekunden; null, wenn unbekannt.

  • isManualUploadbooleanPflicht

    True, wenn manuell hochgeladen (ohne Meeting-Bot).

  • appointmentIdstringPflichtkann null sein

    Id des eigenen Termins des Aufrufers, der mit der Aufnahme verknüpft ist; null, wenn keiner vorhanden ist.

  • createdOnstringPflicht

    Erstellungszeitstempel (ISO 8601, UTC).

Jede Seite trägt außerdem page, pageSize, total, hasMore.

Statuscodes

  • 200Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Fügt eine Aufnahme zu einem Ordner hinzu​

PUT/v1.0/directories/{directoryId}/folders/{folderId}/recordings/{recordingId}

Idempotent. Erfordert Lese- und Schreibzugriff auf den Ordner. 404, wenn die Aufnahme im Unternehmenskonto nicht existiert.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • folderIdstringPflicht

    Id des Ordners.

  • recordingIdstringPflicht

    Id der Aufnahme.

Statuscodes

  • 204Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.

Entfernt eine Aufnahme aus einem Ordner​

DELETE/v1.0/directories/{directoryId}/folders/{folderId}/recordings/{recordingId}

Erfordert Lese- und Schreibzugriff auf den Ordner.

Pfadparameter

  • directoryIdstringPflicht

    Id des Unternehmenskontos (des Sally-Firmenkontos), zu dem die Ressource gehört. Die Unternehmenskonten, die ein Token ansprechen kann, listet GET /v1.0/me/directories/memberships auf.

  • folderIdstringPflicht

    Id des Ordners.

  • recordingIdstringPflicht

    Id der Aufnahme.

Statuscodes

  • 204Erfolg
  • 400

    Ungültige Anfrage (Validierungsfehler).

  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 403

    Verboten (unzureichende Berechtigungen).

  • 404

    Ressource nicht gefunden oder nicht zugänglich.

  • 429

    Rate-Limit überschritten (pro Token/IP). Transkriptions-Uploads können außerdem den code FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS zurückgeben.

  • 500

    Interner Serverfehler.