Fields

This action takes no fields.

Returned Values

The following values are returned by the action:

ValueTypeDescription
Total CountNumberThe total number of rooms available on your domain.
DataListA list of rooms. Each item contains the following fields:
Data → IDTextThe unique ID of the room.
Data → NameTextThe name of the room.
Data → API CreatedBooleanIndicates whether the room was created via the API.
Data → PrivacyTextThe privacy setting of the room (e.g., public or private).
Data → URLTextThe URL of the room.
Data → Created AtDateTimeThe timestamp of when the room was created.
Data → ConfigObjectConfiguration options for the room, such as autojoin, enable_chat, enable_knocking, and more.