Webex · Schema

InProgressParticipant

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	The participant ID that identifies the meeting and the participant.
orgId	string	The ID that identifies the organization.
host	boolean	Whether or not the participant is the host of the meeting.
coHost	boolean	Whether or not the participant has host privilege in the meeting.
spaceModerator	boolean	Whether or not the participant is the team space moderator. This field returns only if the meeting is associated with a Webex space.
email	string	The email address of the participant.
displayName	string	The name of the participant.
invitee	boolean	Whether or not the participant is invited to the meeting.
video	string	The status of the participant's video. * `on` - The video is turned on. * `off` - The video is turned off.
muted	boolean	Whether or not the participant's audio is muted.
state	string	The status of the participant in the meeting. * `lobby` - The participant is waiting in the meeting lobby. * `joined` - The participant has joined the meeting.
siteUrl	string	The site URL.
meetingId	string	A unique identifier for the meeting which the participant belongs to.
hostEmail	string	The email address of the host.
devices	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InProgressParticipant",
  "title": "InProgressParticipant",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "560d7b784f5143e3be2fc3064a5c4999_3c2e2338-e950-43bf-b588-573773ee43d1",
      "description": "The participant ID that identifies the meeting and the participant."
    },
    "orgId": {
      "type": "string",
      "example": "1eb65fdf-9643-417f-9974-ad72cae0e10f",
      "description": "The ID that identifies the organization."
    },
    "host": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the participant is the host of the meeting."
    },
    "coHost": {
      "type": "boolean",
      "description": "Whether or not the participant has host privilege in the meeting."
    },
    "spaceModerator": {
      "type": "boolean",
      "description": "Whether or not the participant is the team space moderator. This field returns only if the meeting is associated with a Webex space."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email address of the participant."
    },
    "displayName": {
      "type": "string",
      "example": "Joe Doe",
      "description": "The name of the participant."
    },
    "invitee": {
      "type": "boolean",
      "description": "Whether or not the participant is invited to the meeting."
    },
    "video": {
      "type": "string",
      "enum": [
        "on",
        "off"
      ],
      "description": "The status of the participant's video.\n * `on` - The video is turned on.\n * `off` - The video is turned off.\n"
    },
    "muted": {
      "type": "boolean",
      "description": "Whether or not the participant's audio is muted."
    },
    "state": {
      "type": "string",
      "enum": [
        "lobby",
        "joined"
      ],
      "description": "The status of the participant in the meeting.\n * `lobby` - The participant is waiting in the meeting lobby.\n * `joined` - The participant has joined the meeting.\n"
    },
    "siteUrl": {
      "type": "string",
      "example": "example.webex.com",
      "description": "The site URL."
    },
    "meetingId": {
      "type": "string",
      "example": "3a688f62840346e8b87dde2b50703511_I_197977258267247872",
      "description": "A unique identifier for the meeting which the participant belongs to."
    },
    "hostEmail": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email address of the host."
    },
    "devices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InProgressDevice"
      }
    }
  }
}