Alle Warteräume auflisten¶

Note

Example:/waiting-rooms?domainId=0000001``/waiting-rooms?subDomainName=myrademo.com

Senden einer GET-Anfrage an den Endpunkt /waiting-rooms.

Beschreibung¶

Mit der List-Waiting-Rooms-Anfrage rufen Sie eine Liste aller Warteräume der Organisation ab.

Voraussetzungen¶

Werte der Anfrage: Domain-ID {domainId}

Objekte: keine

Anfrage¶

Um eine Liste aller Warteräume abzurufen, fügen Sie dem Pfad der Anfrage einen Parameter domainID=<ID of the Domain> oder einen Parameter subDomainName=<Subdomain name> hinzu.

Als Ergebnis erhalten Sie ein oder mehrere Objekte WaitingRoomVO mit den angefragten Informationen.

Das Objekt liefert die folgenden Informationen:

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`
`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`
`vhostId`	Die ID der Subdomains, für die der Warteraum verfügbar ist.	`integer`
`content`	Der HTML-Code für das Warteraum-Template.	`string`
`id`	Die ID des Eintrags.	`integer`
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`
`created`	Das Erstellungsdatum im ISO-8601-Format.	`string($date-time)`

Beispiel¶

Beispiel-Antwort:

[
  {
    "name": "string",
    "maxConcurrent": 0,
    "sessionTimeout": 0,
    "waitRefresh": 0,
    "paths": "string",
    "subDomainName": "string",
    "vhostId": 0,
    "content": "string",
    "id": 0,
    "modified": "2026-01-01T00:00:00+00:00",
    "created": "2026-01-01T00:00:00+00:00"
  }
]

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
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.