Webex · Schema

Room

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the room.
title string A user-friendly name for the room.
type string The room type. * `direct` - 1:1 room. * `group` - Group room.
isLocked boolean Whether the room is moderated (locked) or not.
teamId string The ID for the team with which this room is associated.
lastActivity string The date and time of the room's last activity.
creatorId string The ID of the person who created this room.
created string The date and time the room was created.
ownerId string The ID of the organization which owns this room. See [Webex Data](/docs/api/guides/compliance#webex-teams-data) in the [Compliance Guide](/docs/api/guides/compliance) for more information.
classificationId string Space classification ID represents the space's current classification. It can be attached during space creation time, and can be modified at the request of an authorized user.
isAnnouncementOnly boolean Indicates when a space is in Announcement Mode where only moderators can post messages
isReadOnly boolean A compliance officer can set a direct room as read-only, which will disallow any new information exchanges in this space, while maintaing historical data.
isPublic boolean The room is public and therefore discoverable within the org. Anyone can find and join that room.
madePublic string Date and time when the room was made public.
description string The description of the space.
View JSON Schema on GitHub

JSON Schema

webex-room-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Room",
  "title": "Room",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
      "description": "A unique identifier for the room."
    },
    "title": {
      "type": "string",
      "example": "Project Unicorn - Sprint 0",
      "description": "A user-friendly name for the room."
    },
    "type": {
      "type": "string",
      "enum": [
        "direct",
        "group"
      ],
      "description": "The room type.\n * `direct` - 1:1 room.\n * `group` - Group room.\n"
    },
    "isLocked": {
      "type": "boolean",
      "example": true,
      "description": "Whether the room is moderated (locked) or not."
    },
    "teamId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1JPT00vNjRlNDVhZTAtYzQ2Yi0xMWU1LTlkZjktMGQ0MWUzNDIxOTcz",
      "description": "The ID for the team with which this room is associated."
    },
    "lastActivity": {
      "type": "string",
      "example": "2016-04-21T19:12:48.920Z",
      "description": "The date and time of the room's last activity."
    },
    "creatorId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "description": "The ID of the person who created this room."
    },
    "created": {
      "type": "string",
      "example": "2016-04-21T19:01:55.966Z",
      "description": "The date and time the room was created."
    },
    "ownerId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
      "description": "The ID of the organization which owns this room. See [Webex Data](/docs/api/guides/compliance#webex-teams-data) in the [Compliance Guide](/docs/api/guides/compliance) for more information."
    },
    "classificationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NMQVNTSUZJQ0FUSU9OL2YyMDUyZTgyLTU0ZjgtMTFlYS1hMmUzLTJlNzI4Y2U4ODEyNQ",
      "description": "Space classification ID represents the space's current classification.  It can be attached during space creation time, and can be modified at the request of an authorized user."
    },
    "isAnnouncementOnly": {
      "type": "boolean",
      "description": "Indicates when a space is in Announcement Mode where only moderators can post messages"
    },
    "isReadOnly": {
      "type": "boolean",
      "description": "A compliance officer can set a direct room as read-only, which will disallow any new information exchanges in this space, while maintaing historical data."
    },
    "isPublic": {
      "type": "boolean",
      "example": true,
      "description": "The room is public and therefore discoverable within the org. Anyone can find and join that room."
    },
    "madePublic": {
      "type": "string",
      "example": "2022-10-10T17:24:19.388Z",
      "description": "Date and time when the room was made public."
    },
    "description": {
      "type": "string",
      "example": "Company Announcements",
      "description": "The description of the space."
    }
  }
}