Webex · Schema

Participant

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string The ID that identifies the meeting and the participant.
orgId string The ID that identifies the organization. It only applies to participants of ongoing meetings.
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.
muted boolean Whether or not the participant's audio is muted.
meetingStartTime string The time the meeting started.
video string The status of the participant's video. * `on` - The video is turned on. * `off` - The video is turned off.
state string The status of the participant in the meeting. The value of `state` is `breakoutSession` which is only returned when the meeting is in progress and the breakout session is enabled. * `lobby` - The part
breakoutSessionId string The ID of the breakout session including the participant.
joinedTime string The time the participant joined the meeting. If the field is non-existent or shows `1970-01-01T00:00:00.000Z` the meeting may be still ongoing and the `joinedTime` will be filled in after the meeting
leftTime string The time the participant left the meeting. If the field is non-existent or shows `1970-01-01T00:00:00.000Z` the meeting may be still ongoing and the `leftTime` will be filled in after the meeting ende
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
breakoutSessionsAttended array The breakout sessions attended by the participant. Only applies to ended meeting instances.
sourceId string The source ID of the participant. The `sourceId` is from the [Create Invitation Sources](/docs/api/v1/meetings/create-invitation-sources) API.
View JSON Schema on GitHub

JSON Schema

webex-participant-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Participant",
  "title": "Participant",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "560d7b784f5143e3be2fc3064a5c4999_3c2e2338-e950-43bf-b588-573773ee43d1",
      "description": "The ID that identifies the meeting and the participant."
    },
    "orgId": {
      "type": "string",
      "example": "1eb65fdf-9643-417f-9974-ad72cae0e10f",
      "description": "The ID that identifies the organization. It only applies to participants of ongoing meetings."
    },
    "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."
    },
    "muted": {
      "type": "boolean",
      "description": "Whether or not the participant's audio is muted."
    },
    "meetingStartTime": {
      "type": "string",
      "example": "2020-10-02T17:31:00Z",
      "description": "The time the meeting started."
    },
    "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"
    },
    "state": {
      "type": "string",
      "enum": [
        "lobby",
        "end",
        "joined",
        "breakoutSession"
      ],
      "description": "The status of the participant in the meeting. The value of `state` is `breakoutSession` which is only returned when the meeting is in progress and the breakout session is enabled.\n * `lobby` - The participant is waiting in the meeting lobby.\n * `end` - The participant has left the meeting.\n * `joined` - The participant has joined the meeting and is in the main session.\n * `breakoutSession` - The participant has joined a breakout session.\n"
    },
    "breakoutSessionId": {
      "type": "string",
      "example": "2e373567-465b-8530-a18a-7025e1871d40",
      "description": "The ID of the breakout session including the participant."
    },
    "joinedTime": {
      "type": "string",
      "example": "2022-10-25T09:00:00Z",
      "description": "The time the participant joined the meeting. If the field is non-existent or shows `1970-01-01T00:00:00.000Z` the meeting may be still ongoing and the `joinedTime` will be filled in after the meeting ended. If you need real-time join events, please refer to the webhooks guide."
    },
    "leftTime": {
      "type": "string",
      "example": "2022-10-25T09:30:00Z",
      "description": "The time the participant left the meeting. If the field is non-existent or shows `1970-01-01T00:00:00.000Z` the meeting may be still ongoing and the `leftTime` will be filled in after the meeting ended. If you need real-time left events, please refer to the webhooks guide."
    },
    "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/Device"
      }
    },
    "breakoutSessionsAttended": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BreakoutSessionAttended"
      },
      "description": "The breakout sessions attended by the participant. Only applies to ended meeting instances."
    },
    "sourceId": {
      "type": "string",
      "example": "cisco",
      "description": "The source ID of the participant. The `sourceId` is from the [Create Invitation Sources](/docs/api/v1/meetings/create-invitation-sources) API."
    }
  }
}