Zum Hauptinhalt springen

Angemeldeter Nutzer

Diese Endpunkte verraten dir, wem das Token gehört und welche Unternehmenskonten (directoryId) es ansprechen darf. Die meisten Anbindungen rufen sie zuerst auf.

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

Gibt die Basisinformationen des authentifizierten Nutzers zurück​

GET/v1.0/me
Feldübersicht aus der Spezifikation

Felder der Antwort:

  • userId (string): eindeutige Nutzer-Id.
  • email (string): E-Mail-Adresse des Nutzers.
  • firstName (string): Vorname.
  • lastName (string): Nachname.
  • timeZone (string | null): IANA-Zeitzonenkennung des Nutzers (z. B. "Europe/Berlin"), geeignet für Intl.DateTimeFormat und Datumsberechnungen. Null, wenn der Nutzer keine Zeitzone festgelegt hat.

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: email, firstName, lastName, timeZone, userId.

    Beispiel: email,firstName

Antwort

  • userIdstringPflicht

    Eindeutige Nutzer-Id.

  • emailstringPflicht

    E-Mail-Adresse des Nutzers.

  • firstNamestringPflicht

    Vorname.

  • lastNamestringPflicht

    Nachname.

  • timeZonestringPflichtkann null sein

    IANA-Zeitzonenkennung des Nutzers (z. B. "Europe/Berlin"), geeignet für Intl.DateTimeFormat und Datumsberechnungen. Null, wenn der Nutzer keine Zeitzone festgelegt hat.

Statuscodes

  • 200Erfolg
  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 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 Mitgliedschaften des authentifizierten Nutzers über alle Unternehmenskonten hinweg auf​

GET/v1.0/me/directories/memberships

Ermittelt, „in welchen Unternehmenskonten ich bin und welche Rolle/Lizenz ich jeweils habe". Löse roleId/licenseId über GET /v1.0/roles / GET /v1.0/licenses auf.

Feldübersicht aus der Spezifikation

Jeder Eintrag enthält:

  • directoryId (string): Id des Unternehmenskontos.
  • directoryName (string): Anzeigename des Unternehmenskontos.
  • roleId (string): Rollen-Id des Aufrufers in diesem Unternehmenskonto; auflösen über GET /v1.0/roles.
  • licenseId (string): Lizenz-Id des Aufrufers in diesem Unternehmenskonto; auflösen über GET /v1.0/licenses.
  • isBlocked (boolean): ob der Aufrufer in diesem Unternehmenskonto gesperrt ist.

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: directoryId, directoryName, isBlocked, licenseId, roleId.

    Beispiel: directoryId,directoryName

Antwort

  • directoryIdstringPflicht

    Id des Unternehmenskontos.

  • directoryNamestringPflicht

    Anzeigename des Unternehmenskontos.

  • roleIdstringPflicht

    Rollen-Id des Aufrufers in diesem Unternehmenskonto. Auflösen über GET /v1.0/roles.

  • licenseIdstringPflicht

    Lizenz-Id des Aufrufers in diesem Unternehmenskonto. Auflösen über GET /v1.0/licenses.

  • isBlockedbooleanPflicht

    Ob der Aufrufer in diesem Unternehmenskonto gesperrt ist.

Statuscodes

  • 200Erfolg
  • 401

    Fehlender oder ungültiger Bearer-Token.

  • 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.