Webex · Schema
MeetingSeriesObject
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for meeting. For a meeting series, the `id` is used to identify the entire series. For scheduled meetings from a series, the `id` is used to identify that scheduled meeting. For a me |
| meetingNumber | string | Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended. |
| title | string | Meeting title. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. |
| agenda | string | Meeting agenda. The agenda can be a maximum of 1300 characters long. This attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/updat |
| password | string | Meeting password. Applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. Can be modified for a meeting series or a scheduled m |
| phoneAndVideoSystemPassword | string | 8-digit numeric password used to join a meeting from audio and video devices. This attribute applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instan |
| meetingType | string | Meeting type. * `meetingSeries` - Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a `recurrence` rule. When a non-recurring meeting is sche |
| state | string | Meeting state. * `active` - Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series. * `scheduled` - Only applies to scheduled meeting. Ind |
| hostDidJoin | boolean | Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state, whether or not the meeting host joined the meeting. |
| attendeeDidJoin | boolean | Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state. Whether or not anyone has joined the meeting. If tru |
| timezone | string | [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) of `start` and `end`, conforming with the [IANA time zone database](https://www.iana.org/time-zones). |
| start | string | Start time for meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If the meeting is a meeting series, `start` is the date and time the first meeting of the series starts. |
| end | string | End time for a meeting in ISO 8601 compliant format. If the meeting is a meeting series, `end` is the date and time the first meeting of the series ends. If the meeting is a meeting series and the cur |
| recurrence | string | Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. |
| hostUserId | string | Unique identifier for the meeting host. |
| hostDisplayName | string | Display name for the meeting host. |
| hostEmail | string | Email address for the meeting host. |
| hostKey | string | Key for joining the meeting as host. |
| siteUrl | string | Site URL for the meeting. |
| webLink | string | Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join. |
| registerLink | string | Link to register a meeting which has enabled registration. |
| sipAddress | string | SIP address for callback from a video system. |
| dialInIpAddress | string | IP address for callback from a video system. |
| roomId | string | Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings. |
| enabledAutoRecordMeeting | boolean | Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. |
| allowAnyUserToBeCoHost | boolean | Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by a `siteUrl` parameter when creating the meeting |
| enabledJoinBeforeHost | boolean | Whether or not to allow any attendee to join the meeting before the host joins the meeting. The `enabledJoinBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the |
| enableConnectAudioBeforeHost | boolean | Whether or not to allow any attendee to connect to audio before the host joins the meeting. Only applicable if the `enabledJoinBeforeHost` attribute is set to `true`. The `enableConnectAudioBeforeHost |
| joinBeforeHostMinutes | number | Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the `enabledJoinBeforeHost` attribute is set to true. The `joinBeforeHostMinutes |
| excludePassword | boolean | Whether or not to exclude the meeting password from the email invitation. |
| publicMeeting | boolean | Whether or not to allow the meeting to be listed on the public calendar. |
| reminderTime | number | The number of minutes before the meeting begins, that an email reminder is sent to the host. |
| unlockedMeetingJoinSecurity | string | Specifies how the people who aren't on the invite can join the unlocked meeting. * `allowJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoin`, people can join the unlocked me |
| sessionTypeId | number | Unique identifier for a meeting session type for the user. This attribute is required when scheduling a webinar meeting. All available meeting session types enabled for the user can be retrieved using |
| scheduledType | string | Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) |
| enabledWebcastView | boolean | Whether or not webcast view is enabled. |
| panelistPassword | string | Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Si |
| phoneAndVideoSystemPanelistPassword | string | 8-digit numeric panelist password to join a webinar meeting from audio and video devices. |
| enableAutomaticLock | boolean | Whether or not to automatically lock the meeting after it starts. |
| automaticLockMinutes | number | The number of minutes after the meeting begins, for automatically locking it. |
| allowFirstUserToBeCoHost | boolean | Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by the `siteUrl` parameter when creating the meeting. |
| allowAuthenticatedDevices | boolean | Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for a meeting series or a scheduled meet |
| telephony | object | Information for callbacks from a meeting to phone or for joining a teleconference using a phone. |
| meetingOptions | object | Meeting Options. |
| attendeePrivileges | object | Attendee Privileges. This attribute is not supported for a webinar. |
| registration | object | Meeting registration. When this option is enabled, meeting invitees must register personal information in order to join the meeting. Meeting invitees will receive an email with a registration link for |
| integrationTags | array | External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. |
| simultaneousInterpretation | object | Simultaneous interpretation information for a meeting. |
| enabledBreakoutSessions | boolean | Whether or not breakout sessions are enabled. |
| links | array | [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) Breakout Sessions information for meeting. |
| trackingCodes | array | Tracking codes information. |
| enabledAudioWatermark | boolean | Whether or not the audio watermark is enabled. |
| enabledVisualWatermark | boolean | Whether or not the visual watermark is enabled. |
| visualWatermarkOpacity | number | Opacity level for visual watermark. |
| audioConnectionOptions | object | Audio connection options. |
| requireAttendeeLogin | boolean | Require attendees to sign in before joining the webinar. |
| restrictToInvitees | boolean | Restrict webinar to invited attendees only. |
| enabledLiveStream | boolean | Whether or not live streaming is enabled. If it's enabled, the `liveStream` must be specified. The RTMP streaming specified by `liveStream.rtmpUrl` can be started and viewed during the meeting without |
| liveStream | object | Live streaming settings. It applies when `enabledLiveStream` is `true`. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/MeetingSeriesObject",
"title": "MeetingSeriesObject",
"type": "object",
"required": [
"id",
"title",
"password",
"meetingType",
"state",
"timezone",
"start",
"end",
"hostUserId",
"hostDisplayName",
"hostEmail",
"hostKey",
"siteUrl",
"webLink",
"telephony",
"enabledBreakoutSessions"
],
"properties": {
"id": {
"type": "string",
"example": "dfb45ece33264639a7bc3dd9535d53f7_20200516T230000Z",
"description": "Unique identifier for meeting. For a meeting series, the `id` is used to identify the entire series. For scheduled meetings from a series, the `id` is used to identify that scheduled meeting. For a meeting instance that is in progress or has concluded, the `id` is used to identify that instance."
},
"meetingNumber": {
"type": "string",
"example": "123456789",
"description": "Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended."
},
"title": {
"type": "string",
"example": "John's Meeting",
"description": "Meeting title. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"agenda": {
"type": "string",
"example": "John's Agenda",
"description": "Meeting agenda. The agenda can be a maximum of 1300 characters long. This attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"password": {
"type": "string",
"example": "BgJep@43",
"description": "Meeting password. Applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"phoneAndVideoSystemPassword": {
"type": "string",
"example": "12345678",
"description": "8-digit numeric password used to join a meeting from audio and video devices. This attribute applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended."
},
"meetingType": {
"type": "string",
"enum": [
"meetingSeries",
"scheduledMeeting",
"meeting"
],
"description": "Meeting type.\n * `meetingSeries` - Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a `recurrence` rule. When a non-recurring meeting is scheduled with no `recurrence`, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling.\n * `scheduledMeeting` - Instance from a primary meeting series.\n * `meeting` - Meeting instance that is in progress or has completed.\n"
},
"state": {
"type": "string",
"enum": [
"active",
"scheduled",
"ready",
"lobby",
"inProgress",
"ended",
"missed",
"expired"
],
"description": "Meeting state.\n * `active` - Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.\n * `scheduled` - Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.\n * `ready` - Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.\n * `lobby` - Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.\n * `inProgress` - Applies to meeting series and meeting instances. For a meeting series, indicates that an instance of this series is happening now. For a meeting instance, indicates that the meeting has been joined and unlocked.\n * `ended` - Applies to scheduled meetings and meeting instances. For scheduled meetings, indicates that the meeting was started and is now over. For meeting instances, indicates that the meeting instance has concluded.\n * `missed` - This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.\n * `expired` - This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.\n"
},
"hostDidJoin": {
"type": "boolean",
"description": "Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state, whether or not the meeting host joined the meeting. If true, the meeting host has joined the meeitng even if they dropped off; otherwise, the meeting host hasn't ever join the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if `attendeeDidJoin` is true and `hostDidJoin` is false."
},
"attendeeDidJoin": {
"type": "boolean",
"description": "Only applies to meeting series in the `inProgress` state, scheduled meetings in the `ready` state, and meeting instances in the `inProgress` state. Whether or not anyone has joined the meeting. If true, the meeting host or any attendee has joined the meeting; otherwise, no one has joined the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if `attendeeDidJoin` is true and `hostDidJoin` is false."
},
"timezone": {
"type": "string",
"example": "UTC",
"description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) of `start` and `end`, conforming with the [IANA time zone database](https://www.iana.org/time-zones)."
},
"start": {
"type": "string",
"example": "2019-03-18T11:26:30Z",
"description": "Start time for meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. If the meeting is a meeting series, `start` is the date and time the first meeting of the series starts. If the meeting is a meeting series and the `current` filter is true, `start` is the date and time the upcoming or ongoing meeting of the series starts. If the meeting is a scheduled meeting from a meeting series, `start` is the date and time when that scheduled meeting starts. If the meeting is a meeting instance that has happened or is happening, `start` is the date and time that the instance actually starts. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"end": {
"type": "string",
"example": "2019-03-18T12:26:30Z",
"description": "End time for a meeting in ISO 8601 compliant format. If the meeting is a meeting series, `end` is the date and time the first meeting of the series ends. If the meeting is a meeting series and the current filter is true, `end` is the date and time the upcoming or ongoing meeting of the series ends. If the meeting is a scheduled meeting from a meeting series, `end` is the date and time when that scheduled meeting ends. If the meeting is a meeting instance that has happened, `end` is the date and time that instance actually ends. If a meeting instance is in progress, `end` is not available. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"recurrence": {
"type": "string",
"example": "FREQ=DAILY;INTERVAL=1;COUNT=10",
"description": "Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Can be modified for a meeting series using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. Multiple days or dates for monthly or yearly `recurrence` rule are not supported, only the first day or date specified is taken. For example, \"FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10,11,12\" is not supported and it will be partially supported as \"FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10\". For a non-recurring meeting which has no `recurrence`, its `meetingType` is also `meetingSeries` which is a meeting series with only one occurrence in Webex meeting modeling."
},
"hostUserId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA",
"description": "Unique identifier for the meeting host."
},
"hostDisplayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting host."
},
"hostEmail": {
"type": "string",
"example": "[email protected]",
"description": "Email address for the meeting host."
},
"hostKey": {
"type": "string",
"example": "123456",
"description": "Key for joining the meeting as host."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the meeting."
},
"webLink": {
"type": "string",
"example": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1",
"description": "Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join."
},
"registerLink": {
"type": "string",
"example": "https://site4-example.webex.com/weblink/register/ra1c92369995314c0db8d53b2a44d78f6",
"description": "Link to register a meeting which has enabled registration."
},
"sipAddress": {
"type": "string",
"example": "[email protected]",
"description": "SIP address for callback from a video system."
},
"dialInIpAddress": {
"type": "string",
"example": "192.168.100.100",
"description": "IP address for callback from a video system."
},
"roomId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2",
"description": "Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings."
},
"enabledAutoRecordMeeting": {
"type": "boolean",
"description": "Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"allowAnyUserToBeCoHost": {
"type": "boolean",
"description": "Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by a `siteUrl` parameter when creating the meeting. If not specified, it's a user's preferred site. The `allowAnyUserToBeCoHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"enabledJoinBeforeHost": {
"type": "boolean",
"description": "Whether or not to allow any attendee to join the meeting before the host joins the meeting. The `enabledJoinBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"enableConnectAudioBeforeHost": {
"type": "boolean",
"description": "Whether or not to allow any attendee to connect to audio before the host joins the meeting. Only applicable if the `enabledJoinBeforeHost` attribute is set to `true`. The `enableConnectAudioBeforeHost` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"joinBeforeHostMinutes": {
"type": "number",
"example": 15,
"description": "Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the `enabledJoinBeforeHost` attribute is set to true. The `joinBeforeHostMinutes` attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API. Valid options for a meeting are `0`, `5`, `10`, and `15`, and valid options for a webinar are `0`, `15`, `30`, `45`, and `60`. The default is `0` if not specified."
},
"excludePassword": {
"type": "boolean",
"description": "Whether or not to exclude the meeting password from the email invitation."
},
"publicMeeting": {
"type": "boolean",
"description": "Whether or not to allow the meeting to be listed on the public calendar."
},
"reminderTime": {
"type": "number",
"example": 10,
"description": "The number of minutes before the meeting begins, that an email reminder is sent to the host."
},
"unlockedMeetingJoinSecurity": {
"type": "string",
"enum": [
"allowJoin",
"allowJoinWithLobby",
"blockFromJoin"
],
"description": "Specifies how the people who aren't on the invite can join the unlocked meeting.\n * `allowJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoin`, people can join the unlocked meeting directly.\n * `allowJoinWithLobby` - If the value of `unlockedMeetingJoinSecurity` attribute is `allowJoinWithLobby`, people will wait in the lobby until the host admits them.\n * `blockFromJoin` - If the value of `unlockedMeetingJoinSecurity` attribute is `blockFromJoin`, people can't join the unlocked meeting.\n"
},
"sessionTypeId": {
"type": "number",
"example": 3,
"description": "Unique identifier for a meeting session type for the user. This attribute is required when scheduling a webinar meeting. All available meeting session types enabled for the user can be retrieved using the [List Meeting Session Types](/docs/api/v1/meetings/list-meeting-session-types) API."
},
"scheduledType": {
"type": "string",
"enum": [
"meeting",
"webinar",
"personalRoomMeeting"
],
"description": "Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings).\n * `meeting` - If the value of `scheduledType` attribute is `meeting`, it is a regular meeting.\n * `webinar` - If the value of `scheduledType` attribute is `webinar`, it is a webinar meeting.\n * `personalRoomMeeting` - If the value of `scheduledType` attribute is `personalRoomMeeting`, it is a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings).\n"
},
"enabledWebcastView": {
"type": "boolean",
"description": "Whether or not webcast view is enabled."
},
"panelistPassword": {
"type": "string",
"example": "GwLqa@78",
"description": "Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. If not specified, a random password conforming to the site's password rules will be generated automatically."
},
"phoneAndVideoSystemPanelistPassword": {
"type": "string",
"example": "12345678",
"description": "8-digit numeric panelist password to join a webinar meeting from audio and video devices."
},
"enableAutomaticLock": {
"type": "boolean",
"description": "Whether or not to automatically lock the meeting after it starts."
},
"automaticLockMinutes": {
"type": "number",
"example": 10,
"description": "The number of minutes after the meeting begins, for automatically locking it."
},
"allowFirstUserToBeCoHost": {
"type": "boolean",
"description": "Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by the `siteUrl` parameter when creating the meeting. If not specified, it's a user's preferred site. The `allowFirstUserToBeCoHost` attribute can be modified for a meeting series or a scheduled meeting uisng the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"allowAuthenticatedDevices": {
"type": "boolean",
"description": "Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for a meeting series or a scheduled meeting using the [Update a Meeting](/docs/api/v1/meetings/update-a-meeting) API."
},
"telephony": {
"type": "object",
"required": [
"accessCode",
"callInNumbers"
],
"properties": {
"accessCode": {
"type": "string",
"example": "1234567890",
"description": "Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the `accessCode`."
},
"callInNumbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"callInNumber",
"tollType"
],
"properties": {
"label": {
"type": "string",
"example": "Call-in toll-free number (US/Canada)",
"description": "Label for the call-in number."
},
"callInNumber": {
"type": "string",
"example": "123456789",
"description": "Call-in number to join the teleconference from a phone."
},
"tollType": {
"type": "string",
"enum": [
"toll",
"tollFree"
],
"description": "Type of toll for the call-in number."
}
}
},
"description": "Array of call-in numbers for joining a teleconference from a phone."
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinksObjectForTelephony"
},
"description": "[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) information of global call-in numbers for joining a teleconference from a phone."
}
},
"description": "Information for callbacks from a meeting to phone or for joining a teleconference using a phone."
},
"meetingOptions": {
"type": "object",
"properties": {
"enabledChat": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to chat in the meeting. Also depends on the session type."
},
"enabledVideo": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to have video in the meeting. Also depends on the session type."
},
"enabledPolling": {
"type": "boolean",
"description": "Whether or not to allow any attendee to poll in the meeting. Can only be set `true` for a webinar. The value of this attribute depends on the session type for a meeting. Please contact your site admin if this attribute is not available. Not supported if the site has been migrated to the Webex Suite meeting platform."
},
"enabledNote": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to take notes in the meeting. The value of this attribute also depends on the session type. Not supported if the site has been migrated to the Webex Suite meeting platform."
},
"noteType": {
"type": "string",
"enum": [
"allowAll",
"allowOne"
],
"description": "Whether note taking is enabled. If the value of `enabledNote` is false, users cannot set this attribute and get the default value `allowAll`. Not supported if the site has been migrated to the Webex Suite meeting platform.\n * `allowAll` - If the value of `noteType` attribute is `allowAll`, all participants can take notes.\n * `allowOne` - If the value of `noteType` attribute is `allowOne`, only a single note taker is allowed.\n"
},
"enabledFileTransfer": {
"type": "boolean",
"description": "Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type."
},
"enabledUCFRichMedia": {
"type": "boolean",
"description": "Whether or not to allow any attendee to share [Universal Communications Format](https://www.cisco.com/c/en/us/td/docs/collaboration/training_center/wbs30/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions/WebEx_BK_TE1FB6C1_00_training-center-frequently-asked-questions_chapter_0110.pdf) media files in the meeting. The value of this attribute also depends on the sessionType. Not supported if the site has been migrated to the Webex Suite meeting platform."
}
},
"description": "Meeting Options."
},
"attendeePrivileges": {
"type": "object",
"properties": {
"enabledShareContent": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to share content in the meeting."
},
"enabledSaveDocument": {
"type": "boolean",
"description": "Whether or not to allow any attendee to save shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledPrintDocument": {
"type": "boolean",
"description": "Whether or not to allow any attendee to print shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledAnnotate": {
"type": "boolean",
"description": "Whether or not to allow any attendee to annotate shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledViewParticipantList": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to view participants."
},
"enabledViewThumbnails": {
"type": "boolean",
"description": "Whether or not to allow any attendee to see a small preview image of any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledRemoteControl": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to control applications, web browsers, or desktops remotely. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledViewAnyDocument": {
"type": "boolean",
"description": "Whether or not to allow any attendee to view any shared documents or slides when they are shared as files in the content viewer instead of in a window or application. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledViewAnyPage": {
"type": "boolean",
"description": "Whether or not to allow any attendee to scroll through any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledContactOperatorPrivately": {
"type": "boolean",
"description": "Whether or not to allow any attendee to contact the operator privately. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledChatHost": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to chat with the host in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledChatPresenter": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to chat with the presenter in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
},
"enabledChatOtherParticipants": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow any attendee to chat with other participants in private. This option is no longer supported for meetings on a site which has been migrated to the Webex Suite Meeting Platform (WSMP)."
}
},
"description": "Attendee Privileges. This attribute is not supported for a webinar."
},
"registration": {
"type": "object",
"properties": {
"autoAcceptRequest": {
"type": "boolean",
"description": "Whether or not meeting registration requests are accepted automatically."
},
"requireFirstName": {
"type": "boolean",
"example": true,
"description": "Whether or not a registrant's first name is required for meeting registration."
},
"requireLastName": {
"type": "boolean",
"example": true,
"description": "Whether or not a registrant's last name is required for meeting registration."
},
"requireEmail": {
"type": "boolean",
"example": true,
"description": "Whether or not a registrant's email is required for meeting registration."
},
"requireJobTitle": {
"type": "boolean",
"description": "Whether or not a registrant's job title is shown or required for meeting registration."
},
"requireCompanyName": {
"type": "boolean",
"description": "Whether or not a registrant's company name is shown or required for meeting registration."
},
"requireAddress1": {
"type": "boolean",
"description": "Whether or not a registrant's first address field is shown or required for meeting registration."
},
"requireAddress2": {
"type": "boolean",
"description": "Whether or not a registrant's second address field is shown or required for meeting registration."
},
"requireCity": {
"type": "boolean",
"description": "Whether or not a registrant's city is shown or required for meeting registration."
},
"requireState": {
"type": "boolean",
"description": "Whether or not a registrant's state is shown or required for meeting registration."
},
"requireZipCode": {
"type": "boolean",
"description": "Whether or not a registrant's postal code is shown or required for meeting registration."
},
"requireCountryRegion": {
"type": "boolean",
"description": "Whether or not a registrant's country or region is shown or required for meeting registration."
},
"requireWorkPhone": {
"type": "boolean",
"description": "Whether or not a registrant's work phone number is shown or required for meeting registration."
},
"requireFax": {
"type": "boolean",
"description": "Whether or not a registrant's fax number is shown or required for meeting registration."
},
"maxRegisterNum": {
"type": "number",
"example": 1000,
"description": "Maximum number of meeting registrations. This only applies to meetings. The maximum number of participants for meetings and webinars, with the limit based on the user capacity and controlled by a toggle at the site level. The default maximum number of participants for webinars is 10000, but the actual maximum number of participants is limited by the user capacity."
},
"customizedQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomizedQuestionForGetMeeting"
},
"description": "Customized questions for meeting registration."
},
"rules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StandardRegistrationApproveRule"
},
"description": "The approval rules for standard questions."
}
},
"description": "Meeting registration. When this option is enabled, meeting invitees must register personal information in order to join the meeting. Meeting invitees will receive an email with a registration link for the registration. When the registration form has been submitted and approved, an email with a real meeting link will be received. By clicking that link the meeting invitee can join the meeting. Please note that meeting registration does not apply to a meeting when it's a recurring meeting with a `recurrence` field or no `password` or when the feature toggle `DecoupleJBHWithRegistration` is disabled the `Join Before Host` option is enabled for the meeting, See [Register for a Meeting in Cisco Webex Meetings](https://help.webex.com/en-us/nmgmeff/Register-for-a-Meeting-in-Cisco-Webex-Meetings) for details."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc."
},
"simultaneousInterpretation": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not simultaneous interpretation is enabled."
},
"interpreters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterpreterObjectForSimultaneousInterpretationOfGetOrListMeeting"
},
"description": "Interpreters for meeting."
}
},
"description": "Simultaneous interpretation information for a meeting."
},
"enabledBreakoutSessions": {
"type": "boolean",
"description": "Whether or not breakout sessions are enabled."
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinksObjectForBreakoutSessions"
},
"description": "[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) Breakout Sessions information for meeting."
},
"trackingCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingCodeItemForGetMeetingObject"
},
"description": "Tracking codes information."
},
"enabledAudioWatermark": {
"type": "boolean",
"description": "Whether or not the audio watermark is enabled."
},
"enabledVisualWatermark": {
"type": "boolean",
"description": "Whether or not the visual watermark is enabled."
},
"visualWatermarkOpacity": {
"type": "number",
"example": 10,
"
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/json-schema/webex-meetingseriesobject-schema.json