Webex · Schema

Membership

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the membership.
roomId	string	The room ID.
personId	string	The person ID.
personEmail	string	The email address of the person.
personDisplayName	string	The display name of the person.
personOrgId	string	The organization ID of the person.
isModerator	boolean	Whether or not the participant is a room moderator.
isRoomHidden	boolean	Whether or not the direct type room is hidden in the Webex clients.
roomType	string	The type of room the membership is associated with. * `direct` - 1:1 room. * `group` - Group room.
isMonitor	boolean	Whether or not the participant is a monitoring bot (deprecated).
created	string	The date and time when the membership was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Membership",
  "title": "Membership",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL01FTUJFUlNISVAvMGQwYzkxYjYtY2U2MC00NzI1LWI2ZDAtMzQ1NWQ1ZDExZWYzOmNkZTFkZDQwLTJmMGQtMTFlNS1iYTljLTdiNjU1NmQyMjA3Yg",
      "description": "A unique identifier for the membership."
    },
    "roomId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
      "description": "The room ID."
    },
    "personId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "description": "The person ID."
    },
    "personEmail": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email address of the person."
    },
    "personDisplayName": {
      "type": "string",
      "example": "John Andersen",
      "description": "The display name of the person."
    },
    "personOrgId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
      "description": "The organization ID of the person."
    },
    "isModerator": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the participant is a room moderator."
    },
    "isRoomHidden": {
      "type": "boolean",
      "description": "Whether or not the direct type room is hidden in the Webex clients."
    },
    "roomType": {
      "type": "string",
      "enum": [
        "direct",
        "group"
      ],
      "description": "The type of room the membership is associated with.\n * `direct` - 1:1 room.\n * `group` - Group room.\n"
    },
    "isMonitor": {
      "type": "boolean",
      "description": "Whether or not the participant is a monitoring bot (deprecated)."
    },
    "created": {
      "type": "string",
      "example": "2015-10-18T14:26:16.203Z",
      "description": "The date and time when the membership was created."
    }
  }
}