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. Am meisten nützen sie Ihnen, 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. Sonst zerstören Sie den Rest der URL: ein Name mit einem Leerzeichen, eine E-Mail-Adresse oder jeder Wert, in dem & oder = vorkommt.

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 Veeting Rooms
Meetingraums. 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, in welcher
   Sprache die umgebende Seite auch verfasst ist.
4. Die Plattform entfernt Token und personenbezogene Daten aus der
   URL. Lies diese Werte darum später nicht aus window.location
   zurück, sondern halte sie in der 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. Alles, was einen Token oder personenbezogene Daten mitführt, verschwindet wieder: entweder sofort oder 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. Lesen Sie sie, wenn Sie einen Parameter später wieder aus der Adresszeile holen 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.

ParameterMögliche WerteStandardBeschreibung
cultureSprach- oder Locale-CodeSprache des BrowsersDie Sprache der Oberfläche. Entweder nur die Sprache, de, oder ein Locale, de-CH oder es-LA. Ein reiner Sprachcode findet die regionale Variante Ihrer Instanz, de also de-CH. Der Wert greift nur, wenn Ihre Instanz diese Sprache anbietet. Tut sie das nicht, nimmt der Raum die Browsersprache des Teilnehmers. Erst wenn die Instanz auch keine davon anbietet, nimmt sie ihre eigene Standardsprache. Zudem überschreibt culture eine Sprache, die der Teilnehmer bei einem früheren Besuch gewählt hat.
participantNameBeliebiger StringleerDer Name des Teilnehmers. Setzen Sie skipJoinMeetingScreen auf true, brauchen Sie ihn zwingend.
participantEmailBeliebige E-Mail-AdresseleerDie E-Mail-Adresse des Teilnehmers.
meetingPasswordBeliebiger StringleerDas Meeting-Passwort.
registerEmailBeliebige E-Mail-AdresseleerNur relevant, wenn die Registrierung für ein Testkonto aktiviert ist. Füllt das E-Mail-Feld des Registrierungsformulars vor.
registerFromBeliebiger StringleerNur relevant, wenn die Registrierung für ein Testkonto aktiviert ist. Ergänzt die Benachrichtigung an den Systemadministrator um ein Feld «from». So sehen Sie, woher eine Registrierung stammt.

Zugriff und Authentifizierung

ParameterMögliche WerteStandardBeschreibung
moderatorTokenGültiger Moderatoren-TokenleerGibt dem Teilnehmer Moderationsrechte im Meeting.
jwtTokenBeliebiger JWTleerDer Authentifizierungs-Token eines Users. Verwenden Sie ihn, wenn sich Ihre Leute in einem Drittsystem anmelden.
meetingAccessTokenGültiger Access-TokenleerDer Access-Token für ein bestimmtes Meeting. Sie brauchen ihn, sobald ein externer Autorisierungsdienst konfiguriert ist.
meetingAccessHashGültiger Zugangs-HashleerFührt das Meeting-Passwort mit, damit der Teilnehmer es nicht eintippen muss. Genau diesen Wert setzt Veeting in die Links, die es per E-Mail verschickt.

Hinweis: Diese Werte sind Zugangsdaten. Erzeugen Sie sie pro Teilnehmer und halten Sie sie aus geteilten Links heraus. Genau deshalb entfernt die Plattform die meisten davon wieder aus der URL, siehe «Parameter, die die Plattform entfernt» weiter unten.

Der Screen «Sitzung beitreten»

ParameterMögliche WerteStandardBeschreibung
skipJoinMeetingScreentrue, falsefalseÜberspringt den Screen «Sitzung beitreten» vollständig.
WICHTIG: Geben Sie participantName ebenfalls mit, sonst bleibt der Teilnehmer namenlos.
skipDeviceTestOnJointrue, falsefalseSetzt den Standardwert der Option «Gerätetest». Der Teilnehmer kann ihn weiterhin ändern.
hideDeviceTestSectiontrue, falsefalseBlendet den Abschnitt «Gerätetest» aus. Ausgeblendet heisst nur unsichtbar: An der Wirkung ändert sich nichts.
hideJoinModeSectiontrue, falsefalseBlendet den Abschnitt «Beitrittsmodus» aus. Setzen Sie zusätzlich joinType, damit der Modus feststeht.
hideConsentSectiontrue, falsefalseBlendet die Einwilligungs-Checkbox aus.
WICHTIG: Sie bleiben dafür verantwortlich, die Einwilligung anderweitig einzuholen.
hideLegalAndComplianceSectiontrue, falsefalseBlendet den Abschnitt zu Recht und Compliance aus, also die Links zu Impressum und Datenschutz.
disableNameInputtrue, falsefalseDeaktiviert das Eingabefeld für den Namen.
disableEmailInputtrue, falsefalseDeaktiviert das Eingabefeld für die E-Mail-Adresse.
disablePasswordInputtrue, falsefalseDeaktiviert das Eingabefeld für das Meeting-Passwort.

Darstellung und Medien

ParameterMögliche WerteStandardBeschreibung
meetingRoomLayoutstandard, video-only, collaboration-onlystandardLegt fest, ob der Raum Video, die Kollaborations-Tools oder beides zeigt.
joinTypeaudio-only, audio-video, video-only, no-mediaaudio-videoWählt den Beitrittsmodus vor. Kombinieren Sie ihn mit hideJoinModeSection.
mediaDirectionreceiveonly, sendonlyleerSchränkt ein, in welche Richtung Medien fliessen. Lassen Sie ihn weg, sendet und empfängt der Raum, und genau das ist der Standard. Jeden anderen Wert ignoriert die Plattform.
cameraDirectionuser, environmentleerDie Standardkamera auf Mobiltelefonen. user ist die Selfie-Kamera, environment die rückseitige.
videoResolution1280x960, 1280x720, 960x720, 960x540, 640x480, 640x360, 320x240, 320x180Standard des KontosDie Auflösung des ausgehenden Videos.
disableIncomingVideotrue, falsefalseDer Teilnehmer tritt bei, ohne das Video der anderen zu empfangen. Das hilft bei schmalbandigen Verbindungen.
hideCollaborationHeadertrue, falsefalseBlendet die Kopfzeile über dem Kollaborationsbereich aus. Ein eingebetteter Raum gewinnt so nutzbare Höhe.
enableDarkModetrue, falsefalseStellt den Meetingraum im Dark Mode dar.

Geräte

ParameterMögliche WerteStandardBeschreibung
videoInputDeviceIdstringleerDie Geräte-ID der Kamera, die der Raum verwenden soll, sofern verfügbar.
audioInputDeviceIdstringleerDie Geräte-ID des Mikrofons, das der Raum verwenden soll, sofern verfügbar.
audioOutputDeviceIdstringleerDie Geräte-ID des Lautsprechers, den der Raum verwenden soll, sofern verfügbar.

Im Meeting

ParameterMögliche WerteStandardBeschreibung
enableFollowMetrue, falsefalseAktiviert die Funktion «Follow Me». Sie greift nur, wenn der Teilnehmer Organisator oder Moderator ist.
leaveUrlBeliebige URLleerÜberschreibt, wohin der Button «Sitzung verlassen» führt.

Einbettung, Test und Support

ParameterMögliche WerteStandardBeschreibung
localStoragePrefixBeliebiger StringleerStellt jedem Key, den Veeting in den localStorage schreibt, ein Präfix voran. Setzen Sie ihn, wenn Sie mehrere Veeting-Anwendungen auf demselben Origin einbetten. So kommen sich deren gespeicherte Zustände nicht in die Quere.
testWithoutRenderingMediatrue, falsefalseNur zu Testzwecken: Streams senden und empfangen, ohne Audio und Video darzustellen.
enableDebugLogstrue, falsefalseSchaltet das ausführliche Logging in der Browserkonsole ein. Setzen Sie ihn, wenn wir Ihnen bei einer Diagnose helfen.

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.

Sofort entfernt, immer. Diese überdauern nie in der Adresszeile:

meetingAccessToken
meetingAccessRequestToken
meetingChallengeCode

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

skipJoinMeetingScreen   jwtToken          moderatorToken
invisibleToken          interpreterToken  authenticationSkipToken
participantName         participantUuid   participantEmail

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

Häufige Fehler

  • Sie URL-codieren einen Wert nicht. Meist stolpern Sie über ein Leerzeichen in participantName.
  • Sie setzen skipJoinMeetingScreen=true ohne participantName, und der Teilnehmer bleibt namenlos.
  • Sie blenden den Einwilligungsabschnitt aus und halten die Einwilligung damit für erledigt.
  • Sie erwarten moderatorToken oder participantName noch in der URL, nachdem der Meetingraum geladen hat.
  • Sie senden 1 oder yes als booleschen Wert. Erkannt werden nur true und false.
  • Sie übersetzen einen Parameternamen. Es sind Identifier und immer englisch.
  • Sie verwenden einen undokumentierten Parameter aus dem Bundle, für den wir Ihnen keine Kompatibilität zusichern.

Sind Sie nicht sicher, wie Sie Ihr Projekt am Besten umsetzen sollen?

Sprechen Sie mit unserem Team über Ihre Pläne.