Einen Warteraum hinzufügen¶

Note

Wenn die optionalen Attribute nicht gesetzt sind, setzt das System einen Standardwert ein.

Note

Der Body enthält die Attribute id, created und modified nicht. Die Werte dieser Attribute werden vom System nach dem Erstellen des Eintrags gesetzt.

Senden einer POST-Anfrage an den Endpunkt /waiting-room.

Beschreibung¶

Mit der Add-Waiting-Room-Anfrage fügen Sie einen Warteraum für eine Subdomain der Organisation hinzu.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: WaitingRoomVO

Anfrage¶

Um einen Warteraum hinzuzufügen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.

Alle Warteräume werden ohne Bezug zur Subdomain hinzugefügt, für die der Warteraum definiert ist.

Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen eines Warteraums erforderlich sind, muss im Body ein Objekt WaitingRoomVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`name`	Der Name des Warteraums.	`string`
`maxConcurrent`	Die maximale Anzahl an Besuchenden, die gleichzeitig auf die Kundeninfrastruktur zugreifen dürfen. Sobald der Wert überschritten wird, wird jede weitere besuchende Person in den Warteraum geleitet.	`integer`
`sessionTimeout`	Die Dauer in Sekunden, für die eine inaktive Sitzung auf die Kundeninfrastruktur zugreifen kann. Wird die Sitzung in dieser Zeit nicht erneut aufgerufen, wird der Zugriff für die Sitzung deaktiviert.	`integer`
`waitRefresh`	Die Dauer in Sekunden, nach der die Warteseite neu geladen wird. Wird die Sitzung nach dem dritten Neuladen nicht erneut aufgerufen, wird sie aus der Warteschlange entfernt.	`integer`
`vhostId`	Die ID der Subdomains, für die der Warteraum verfügbar ist.	`integer`
`content`	Der HTML-Code für das Warteraum-Template.	`string`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`paths`	Ein Pfad innerhalb der Apex-Domain oder Subdomain, für den der Warteraum gelten soll. Der Pfad muss als regulärer Ausdruck definiert werden. Der Standardwert im Feld PATH ist .. Wird der Standardwert . als Pfad verwendet, werden die Warteseiten und Einstellungen aller Warteräume mit einem Pfad der entsprechenden Apex-Domain oder Subdomain überschrieben.	`string`
`subDomainName`	Der Name der Subdomain, für die der Warteraum verfügbar ist.	`string`

Das System gibt als Antwort das Objekt WaitingRoomVO mit den Informationen zum neuen Eintrag zurück.

Inhalt des Warteraums¶

Für jeden Warteraum, der über die Warteraum-Funktion hinzugefügt wird, wird eine Warteseite gespeichert. Zu Beginn steht ein Standard-Template zur Auswahl. Sie können auch Ihre eigene Warteseite als *.htm- oder *.html-Datei hochladen. Platzhalter sorgen dafür, dass die Warteseite alle erforderlichen Informationen zum Warteraum korrekt anzeigt. Eine Tabelle mit den wichtigsten Platzhaltern finden Sie unten:

Variable name	Beschreibung
`!WAIT_REFRESH!`	Legt die Anzahl der Sekunden zwischen den Seitenaktualisierungen fest. Diese Variable muss als http-equiv=refresh-Meta-Tag im HTML-Head eingebunden werden, damit die Seite automatisch neu lädt und den Besuchenden Rückmeldung über ihre aktuelle Position in der Warteschlange gibt.
`!CURRENT_POSITION!`	Zeigt die Position der besuchenden Person in der Warteschlange an.
`!SUBDOMAIN!`	Zeigt den Hostnamen ohne Protokoll und Pfad an.
`!QUEUE_SIZE!`	Zeigt die Gesamtzahl der Besuchenden in der Warteschlange an.
`!QUEUE_PROGRESS!`	Zeigt die Anzahl der Besuchenden hinter der eigenen Person an. Kann genutzt werden, um visuelles Feedback zum Fortschritt in der Warteschlange zu geben, zum Beispiel über einen Fortschrittsbalken.

Beispiel-Template¶

<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="refresh" content="!WAIT_REFRESH!" />
<title>!SUBDOMAIN! Waiting Room</title>
<style>
body {
font-family: Arial, Helvetica, sans-serif;
font-optical-sizing: auto;
font-style: normal;
min-height: 100vh;
margin: 0;
}
.background {
background: linear-gradient(
133.66deg,
#7dff54 -13.21%,
#54ddc2 38.6%,
#003bcc 97.97%
);
display: flex;
justify-content: center;
align-items: center;
}
.card {
background-color: #ffffff;
width: clamp(400px, 60%, 800px);
}
.card-content {
padding: min(4vw, 40px);
}
.progress-bar {
-webkit-appearance: none;
-moz-appearance: none;
appearance: none;
border: none;
display: flex;
color: #003bcc;
width: 100%;
height: 8px;
}

Beispiel¶

Beispiel-Request-Body:

{
  "name": "string",
  "maxConcurrent": 0,
  "sessionTimeout": 0,
  "waitRefresh": 0,
  "vhostId": 0,
  "content": "string",
  "paths": "string",
  "subDomainName": "string"
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
201	Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.