Fields

The following fields are available in this action:

FieldTypeDescription
Room NameTextThe name of the room to retrieve configuration from.

Returned Values

The following values are returned by the action:

ValueTypeDescription
IDTextThe unique ID of the room.
NameTextThe name of the room.
API CreatedBooleanIndicates whether the room was created via the API.
PrivacyTextThe privacy setting of the room (e.g., public or private).
URLTextThe URL of the room.
Created AtDateTimeThe timestamp of when the room was created.
ConfigObjectConfiguration options for the room, such as enable_chat, enable_knocking, and more.
error.status_codeNumberThe HTTP status code returned by the API (e.g., 200 for success).
error.status_messageTextThe HTTP status message returned by the API (e.g., "OK").
error.bodyTextThe raw error body message as a string.
returned_an_errorBooleanA flag indicating whether the API returned an error. false means no error occurred.