Zum Hauptinhalt springen

Wie du nur die Felder abrufst, die du brauchst

Jede Antwort der Sally API lässt sich mit ?fields= auf die Felder reduzieren, die du wirklich brauchst. Das hält Antworten klein und schützt deine Anbindung vor Feldern, die später hinzukommen.

GET /v1.0/directories/{directoryId}/recordings?fields=recordingId,name,createdOn

Schnellnavigation

  1. Die Regeln
  2. Wo es sich lohnt

1. Die Regeln​

  • Ohne Angabe bekommst du alle Felder, auch solche, die in Zukunft hinzukommen. Wer seine Felder nennt, schützt sich davor.
  • Nur Namen der ersten Ebene. Eine verschachtelte Liste wie attendees, tags, segments oder sectionItems kommt ganz oder gar nicht. attendees.name wird nicht unterstützt.
  • Bei einer seitenweisen Antwort wirkt die Auswahl auf die Einträge in items. Die Hülle aus Paginierung und Suche kommt immer mit.
  • Ein unbekannter Name wird mit 400 abgelehnt, statt still ignoriert zu werden. Ein Tippfehler scheitert damit laut, statt leise eine halbe Antwort zu liefern.

2. Wo es sich lohnt​

Ergebnis

Ein Transkript besteht fast nur aus segments, eine Zusammenfassung mit Details fast nur aus sectionItems. Lässt du eines davon weg, wird die Antwort deutlich kleiner.

Welche Namen ein Endpunkt annimmt, steht in der Referenz beim Parameter fields.