Parameter in der URL

Übersicht

Mit Query-Parametern richten Sie einen Meetingraum direkt über dessen URL ein. Sie steuern damit einen eingebetteten Raum, ohne eine Zeile Code zu schreiben. Besonders nützlich sind sie, wenn Sie den Raum als iFrame in Ihre eigene Anwendung einbinden.

Sie hängen die Parameter an eine Meeting-URL an:

https://<DOMAIN-NAME>/meeting/<MEETING-ID>?participantName=Test%20User&meetingPassword=1234

URL-codieren Sie jeden Wert. Ein Name mit einem Leerzeichen, eine E-Mail-Adresse oder jeder Wert mit & oder = zerstört sonst den Rest der URL.

Für boolesche Parameter schreiben Sie die Strings true oder false.

Verwendung mit einem KI-Assistenten

Wenn Sie mit einem KI-Coding-Assistenten arbeiten, können Sie den folgenden Text in Ihren Assistenten kopieren und mit einem Satz ergänzen, der beschreibt, was Sie programmieren möchten.

Der Prompt verweist auf unsere Entwicklerdokumentation, die wir für Coding-Assistenten in einer separaten, token-optimierten KI-Version ausliefern.

Lies zuerst diese Seite, bevor Du Code schreibst:
https://www.veeting.com/de/developer-documentation/query-parameters

Sie dokumentiert die URL-Query-Parameter eines Meetingraums
von Veeting Rooms. Halte Dich an diese fünf Regeln:

1. URL-codiere jeden Wert. Namen und E-Mail-Adressen enthalten
   meist Zeichen, die das verlangen.
2. Boolesche Werte sind die Strings true und false, nicht 1
   oder yes.
3. Parameternamen sind Identifier. Übersetze sie nie, egal in
   welcher Sprache die umgebende Seite verfasst ist.
4. Die Plattform entfernt Token und personenbezogene Daten aus der
   URL. Lies diese Werte darum später nicht aus window.location,
   sondern halte sie in Deiner Anwendung.
5. Verwende nur Parameter, die auf dieser Seite stehen. Erfinde
   keine und nimm keine, die Du in unserem JavaScript-Bundle
   gefunden hast.

Was ich bauen möchte:

Zwei Dinge vorab

Die Plattform entfernt einige Parameter aus der URL. Was einen Token oder personenbezogene Daten mitführt, verschwindet wieder, einige weitere Parameter ebenfalls. Das geschieht entweder sofort oder erst, bevor der Browser navigiert. Das tun wir mit Absicht, damit solche Werte nicht im Browserverlauf, in einem Lesezeichen oder in einem Referer-Header überdauern. Die beiden Listen stehen am Ende dieser Seite. Sie sind relevant, sobald Sie einen Parameter später wieder aus der Adresszeile lesen möchten.

Diese Seite führt nicht jeden Parameter auf, den die Plattform akzeptiert. Die übrigen arbeiten intern, bedienen unsere Support-Tools oder führen Access-Tokens mit, die wir nicht öffentlich beschreiben. Brauchen Sie einen Parameter, der hier fehlt, dann fragen Sie uns. Verlassen Sie sich nicht auf einen, den Sie im Bundle gefunden haben: Für einen undokumentierten Parameter sichern wir Ihnen keine Kompatibilität zu.

Angaben zum Teilnehmer

Mit diesen Parametern füllen Sie den Screen «Sitzung beitreten» vor. Ihre Teilnehmer müssen dann nichts mehr eintippen.

So bestimmt der Raum die Sprache. Es gilt die erste Regel, die zutrifft:

1. Bietet Ihre Instanz genau den Code aus culture an, gilt dieser. Ein reines de bietet eine Instanz standardmässig an, de bleibt also de.
2. Bietet die Instanz genau die Hauptsprache des Browsers an, gilt diese.
3. Ein reiner Code wird auf ein festes Locale abgebildet, sofern die Instanz es anbietet: en -> en-US, de -> de-CH, es -> es-LA.
4. Dieselbe feste Zuordnung, angewendet auf die Hauptsprache des Browsers.
5. Die alphabetisch erste Sprache, die die Instanz anbietet.

In den Fällen 1 und 3 überschreibt culture eine Sprache, die der Teilnehmer bei einem früheren Besuch im selben Browser gewählt hat. In den Fällen 2, 4 und 5 gewinnt diese frühere Wahl.

Zugriff und Authentifizierung

Die Tokens eines Meetings sind Felder des Meeting-Objekts. Rufen Sie das Meeting über die REST API ab und nehmen Sie data.moderatorToken, data.invisibleToken oder data.backstageToken aus der Antwort.

Hinweis: Diese Werte sind Zugangsdaten. Geben Sie sie nur an Personen weiter, die sie haben sollen. Deshalb entfernt die Plattform moderatorToken, invisibleToken, backstageToken und jwtToken wieder aus der URL, siehe «Parameter, die die Plattform entfernt» weiter unten. meetingAccessHash und meetingPassword entfernt sie nicht: Sie bleiben in der Adresszeile und landen damit im Browserverlauf, in Lesezeichen und in jedem Referer-Header.

Der Screen «Sitzung beitreten»

Darstellung und Medien

TV-Screens und Regie

Zwei Arten von Teilnehmern treten einem Meeting bei, ohne sichtbar zu sein: ein TV-Screen, der das Meeting an einer Wand oder auf einer Bühne zeigt, und die Regie, die das Meeting aus dem Hintergrund steuert. Beide verwenden invisibleToken.

TV-Screens

Ein TV-Screen kombiniert enableTVMode mit invisibleToken:

https://<DOMAIN-NAME>/meeting/<MEETING-ID>?enableTVMode=true&invisibleToken=<INVISIBLE-TOKEN>

Standardmässig zeigt ein TV-Screen die Inhalte des Meetingraums erst, wenn auch die regulären Teilnehmer sie sehen. Sollen die Inhalte schon erscheinen, sobald Organisatoren und Moderatoren das Meeting vorbereiten können, also rund 60 Minuten vor Beginn, dann ergänzen Sie backstageToken:

https://<DOMAIN-NAME>/meeting/<MEETING-ID>?enableTVMode=true&invisibleToken=<INVISIBLE-TOKEN>&backstageToken=<BACKSTAGE-TOKEN>

Regie

Die Regie tritt als Moderator bei, bleibt aber unsichtbar und sendet weder Audio noch Video. Kombinieren Sie dafür invisibleToken mit moderatorToken:

https://<DOMAIN-NAME>/meeting/<MEETING-ID>?invisibleToken=<INVISIBLE-TOKEN>&moderatorToken=<MODERATOR-TOKEN>

Setzen Sie im Regie-Link kein enableTVMode. Der TV-Modus ignoriert moderatorToken, die Regie würde also als TV-Screen ohne Moderationsrechte beitreten.

Geräte

Im Meeting

Einbettung, Test und Support

Parameter, die die Plattform entfernt

Die Plattform entfernt zwei Gruppen von Parametern aus der URL. Beides ist kein Fehler, überrascht Sie aber, sobald Sie einen Wert später wieder aus window.location lesen möchten.

Immer sofort entfernt. Diese bleiben nicht in der Adresszeile, mit der einen unten beschriebenen Ausnahme:

meetingAccessToken
meetingAccessRequestToken
meetingChallengeCode

Entfernt, bevor der Browser navigiert. Die Plattform liest diese Werte zuerst und löscht sie dann. So gelangen sie nicht über den Browserverlauf, ein Lesezeichen oder einen Referer-Header an Dritte:

skipJoinMeetingScreen   jwtToken          moderatorToken
invisibleToken          backstageToken    interpreterToken
authenticationSkipToken participantName   participantUuid
participantEmail

Die Ausnahme ist ein unbeaufsichtigter Client. Läuft ein Client mit enableTVMode oder autoApplyUpdates auf true und lädt er im Meeting wegen eines Updates automatisch neu, schreibt er alle Parameter, mit denen er geöffnet wurde, zurück in die Adresszeile, Tokens eingeschlossen. Damit tritt er dem Raum wieder bei. Der Reload ersetzt den aktuellen Eintrag im Verlauf, statt einen neuen anzulegen. Unabhängig davon schaltet forcePreserveQueryParameters auf true das Entfernen vor der Navigation ab.

Brauchen Sie einen Wert nach dem Beitritt, dann halten Sie ihn in Ihrer eigenen Anwendung. Lesen Sie ihn nicht wieder aus der URL.

Häufige Fehler

• Einen Wert nicht URL-codieren. Meist ist es ein Leerzeichen in participantName.
• skipJoinMeetingScreen=true ohne participantName setzen und erwarten, dass der Screen übersprungen wird. Liegt kein Name vor, sieht der Teilnehmer ihn trotzdem.
• Den Abschnitt zur Einwilligung ausblenden und die Einwilligung damit für erledigt halten.
• moderatorToken oder participantName nach dem Laden des Meetingraums noch in der URL erwarten.
• backstageToken senden, aber enableTVMode=true oder invisibleToken weglassen. Für sich allein bewirkt der Token nichts.
• enableTVMode in den Regie-Link setzen. Der TV-Modus ignoriert moderatorToken.
• 1 oder yes als booleschen Wert senden. Erkannt werden nur true und false.
• Einen Parameternamen übersetzen. Parameternamen sind Identifier und immer englisch.
• Einen undokumentierten Parameter aus dem Bundle verwenden, für den wir keine Kompatibilität zusichern.