# Parameter in der URL Source: https://www.veeting.com/de/developer-documentation/query-parameters ## Ü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: ```text https:///meeting/?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`. ## 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. | Parameter | Mögliche Werte | Standard | Beschreibung | | ---------------- | ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | culture | Sprach- oder Locale-Code | Sprache des Browsers | Die 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. | | participantName | Beliebiger String | leer | Der Name des Teilnehmers. Setzen Sie `skipJoinMeetingScreen` auf `true`, brauchen Sie ihn zwingend. | | participantEmail | Beliebige E-Mail-Adresse | leer | Die E-Mail-Adresse des Teilnehmers. | | meetingPassword | Beliebiger String | leer | Das Meeting-Passwort. | | registerEmail | Beliebige E-Mail-Adresse | leer | Nur relevant, wenn die Registrierung für ein Testkonto aktiviert ist. Füllt das E-Mail-Feld des Registrierungsformulars vor. | | registerFrom | Beliebiger String | leer | Nur 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 | Parameter | Mögliche Werte | Standard | Beschreibung | | ------------------ | -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | moderatorToken | Gültiger Moderatoren-Token | leer | Gibt dem Teilnehmer Moderationsrechte im Meeting. | | jwtToken | Beliebiger JWT | leer | Der Authentifizierungs-Token eines Users. Verwenden Sie ihn, wenn sich Ihre Leute in einem Drittsystem anmelden. | | meetingAccessToken | Gültiger Access-Token | leer | Der Access-Token für ein bestimmtes Meeting. Sie brauchen ihn, sobald ein externer Autorisierungsdienst konfiguriert ist. | | meetingAccessHash | Gültiger Zugangs-Hash | leer | Fü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» | Parameter | Mögliche Werte | Standard | Beschreibung | | ----------------------------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | skipJoinMeetingScreen | true, false | false | Überspringt den Screen «Sitzung beitreten» vollständig.
**WICHTIG:** Geben Sie `participantName` ebenfalls mit, sonst bleibt der Teilnehmer namenlos. | | skipDeviceTestOnJoin | true, false | false | Setzt den Standardwert der Option «Gerätetest». Der Teilnehmer kann ihn weiterhin ändern. | | hideDeviceTestSection | true, false | false | Blendet den Abschnitt «Gerätetest» aus. Ausgeblendet heisst nur unsichtbar: An der Wirkung ändert sich nichts. | | hideJoinModeSection | true, false | false | Blendet den Abschnitt «Beitrittsmodus» aus. Setzen Sie zusätzlich `joinType`, damit der Modus feststeht. | | hideConsentSection | true, false | false | Blendet die Einwilligungs-Checkbox aus.
**WICHTIG:** Sie bleiben dafür verantwortlich, die Einwilligung anderweitig einzuholen. | | hideLegalAndComplianceSection | true, false | false | Blendet den Abschnitt zu Recht und Compliance aus, also die Links zu Impressum und Datenschutz. | | disableNameInput | true, false | false | Deaktiviert das Eingabefeld für den **Namen**. | | disableEmailInput | true, false | false | Deaktiviert das Eingabefeld für die **E-Mail-Adresse**. | | disablePasswordInput | true, false | false | Deaktiviert das Eingabefeld für das Meeting-Passwort. | ## Darstellung und Medien | Parameter | Mögliche Werte | Standard | Beschreibung | | ----------------------- | ------------------------------------------------------------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | meetingRoomLayout | standard, video-only, collaboration-only | standard | Legt fest, ob der Raum Video, die Kollaborations-Tools oder beides zeigt. | | joinType | audio-only, audio-video, video-only, no-media | audio-video | Wählt den Beitrittsmodus vor. Kombinieren Sie ihn mit `hideJoinModeSection`. | | mediaDirection | receiveonly, sendonly | leer | Schrä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. | | cameraDirection | user, environment | leer | Die Standardkamera auf Mobiltelefonen. `user` ist die Selfie-Kamera, `environment` die rückseitige. | | videoResolution | 1280x960, 1280x720, 960x720, 960x540, 640x480, 640x360, 320x240, 320x180 | Standard des Kontos | Die Auflösung des ausgehenden Videos. | | disableIncomingVideo | true, false | false | Der Teilnehmer tritt bei, ohne das Video der anderen zu empfangen. Das hilft bei schmalbandigen Verbindungen. | | hideCollaborationHeader | true, false | false | Blendet die Kopfzeile über dem Kollaborationsbereich aus. Ein eingebetteter Raum gewinnt so nutzbare Höhe. | | enableDarkMode | true, false | false | Stellt den Meetingraum im Dark Mode dar. | ## Geräte | Parameter | Mögliche Werte | Standard | Beschreibung | | ------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | | videoInputDeviceId | string | leer | Die Geräte-ID der Kamera, die der Raum verwenden soll, sofern verfügbar. | | audioInputDeviceId | string | leer | Die Geräte-ID des Mikrofons, das der Raum verwenden soll, sofern verfügbar. | | audioOutputDeviceId | string | leer | Die Geräte-ID des Lautsprechers, den der Raum verwenden soll, sofern verfügbar. | ## Im Meeting | Parameter | Mögliche Werte | Standard | Beschreibung | | -------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------- | | enableFollowMe | true, false | false | Aktiviert die Funktion «Follow Me». Sie greift nur, wenn der Teilnehmer Organisator oder Moderator ist. | | leaveUrl | Beliebige URL | leer | Überschreibt, wohin der Button «Sitzung verlassen» führt. | ## Einbettung, Test und Support | Parameter | Mögliche Werte | Standard | Beschreibung | | ------------------------- | ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | localStoragePrefix | Beliebiger String | leer | Stellt 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. | | testWithoutRenderingMedia | true, false | false | Nur zu Testzwecken: Streams senden und empfangen, ohne Audio und Video darzustellen. | | enableDebugLogs | true, false | false | Schaltet 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: ```text 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: ```text 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. --- ## Die übrige Dokumentation - [Custom Tools – eigene Widgets im Meetingraum](https://www.veeting.com/de/developer-documentation/custom-tools) - [Externer Autorisierungsdienst](https://www.veeting.com/de/developer-documentation/external-meeting-authorization-service) - [iFrame und Web Komponenten](https://www.veeting.com/de/developer-documentation/iframe-and-web-components) - [JavaScript APIs](https://www.veeting.com/de/developer-documentation/javascript-apis) - [JavaScript und Typescript APIs](https://www.veeting.com/de/veeting-blocks/apis) - [Komponenten](https://www.veeting.com/de/veeting-blocks/components) - [Kontrolle über die Videodarstellung](https://www.veeting.com/de/developer-documentation/video-display-calculator) - [Veeting Blocks - Übersicht](https://www.veeting.com/de/veeting-blocks/introduction) - [Veeting Rooms REST APIs](https://www.veeting.com/de/developer-documentation/api-usage) - [Webhooks](https://www.veeting.com/de/developer-documentation/web-hooks) Alles in einer Datei: https://www.veeting.com/llms-full.txt