Webex · Schema
CreateMeetingObject
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| adhoc | boolean | Whether or not to create an ad-hoc meeting for the room specified by `roomId`. When `true`, `roomId` is required. |
| roomId | string | Unique identifier for the Webex space which the meeting is to be associated with. It can be retrieved by [List Rooms](/docs/api/v1/rooms/list-rooms). `roomId` is required when `adhoc` is `true`. When |
| templateId | string | Unique identifier for meeting template. Please note that `start` and `end` are optional when `templateId` is specified. The list of meeting templates that is available for the authenticated user can b |
| title | string | Meeting title. The title can be a maximum of 128 characters long. The default value for an ad-hoc meeting is the user's name if not specified. |
| agenda | string | Meeting agenda. The agenda can be a maximum of 1300 characters long. |
| password | string | Meeting password. 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-Administra |
| start | string | Date and time for the start of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `start` cannot be before current date and time or after `end`. Duration between `star |
| end | string | Date and time for the end of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `end` cannot be before current date and time or before `start`. Duration between `start |
| timezone | string | [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in which the meeting was originally scheduled (conforming with the [IANA time zone database](https://www.iana.org/time-zo |
| recurrence | string | Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)), applying only to meeting series. It doesn't apply to a scheduled meeting or an ended or ongoing meeti |
| enabledAutoRecordMeeting | boolean | Whether or not meeting is recorded automatically. |
| 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 `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 default value for an ad-hoc meeting is `true` and the user's input value will be ignored. |
| enableConnectAudioBeforeHost | boolean | Whether or not to allow any attendee to connect audio in the meeting before the host joins the meeting. This attribute is only applicable if the `enabledJoinBeforeHost` attribute is set to true. The d |
| joinBeforeHostMinutes | number | Number of minutes an attendee can join the meeting before the meeting start time and the host joins. This attribute is only applicable if the `enabledJoinBeforeHost` attribute is set to true. Valid op |
| excludePassword | boolean | Whether or not to exclude the meeting password from the email invitation. This parameter is ignored for an ad-hoc meeting. |
| publicMeeting | boolean | Whether or not to allow the meeting to be listed on the public calendar. The default value for an ad-hoc meeting is `false` and the user's input value will be ignored. |
| reminderTime | number | The number of minutes before the meeting begins, that an email reminder is sent to the host. This parameter is ignored for an ad-hoc meeting. |
| unlockedMeetingJoinSecurity | string | Specifies how the people who aren't on the invite can join the unlocked meeting. The default value for an ad-hoc meeting is `allowJoinWithLobby` and the user's input value will be ignored. * `allowJoi |
| 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 | When set as an attribute in a POST request body, specifies whether it's a regular meeting, a webinar, or a meeting scheduled in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/ |
| enabledWebcastView | boolean | Whether or not webcast view is enabled. This parameter is ignored for an ad-hoc meeting. |
| 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 |
| enableAutomaticLock | boolean | Whether or not to automatically lock the meeting after it starts. The default value for an ad-hoc meeting is `false` and the user's input value will be ignored. |
| automaticLockMinutes | number | The number of minutes after the meeting begins, for automatically locking it. The default value for an ad-hoc meeting is null and the user's input value will be ignored. |
| 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 `siteUrl` parameter when creating the meeting; if n |
| allowAuthenticatedDevices | boolean | Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. The default value for an ad-hoc meeting is `true` and the user's input |
| invitees | array | Invitees for meeting. The maximum size of invitees is 1000. If `roomId` is specified and `invitees` is missing, all the members in the space are invited implicitly. If both `roomId` and `invitees` are |
| sendEmail | boolean | Whether or not to send emails to host and invitees. It is an optional field and default value is true. The default value for an ad-hoc meeting is `false` and the user's input value will be ignored. |
| hostEmail | string | Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a s |
| siteUrl | string | URL of the Webex site which the meeting is created on. If not specified, the meeting is created on user's preferred site. All available Webex sites and preferred site of the user can be retrieved by ` |
| 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. The integration application queries meetings by a key |
| simultaneousInterpretation | object | Simultaneous interpretation information for a meeting. |
| enabledBreakoutSessions | boolean | Whether or not breakout sessions are enabled. |
| breakoutSessions | array | Breakout sessions are smaller groups that are split off from the main meeting or webinar. They allow a subset of participants to collaborate and share ideas over audio and video. Use breakout sessions |
| trackingCodes | array | Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by [List Meeting Tracking Codes](/docs/api/v1/meetings/list-meeting-tracking-codes) A |
| enabledAudioWatermark | boolean | Whether or not the audio watermark is enabled. If it's `true`, `scheduledType` equals or defaults to `meeting`, and `audioConnectionOptions.audioConnectionType` equals `VoIP`, the audio for this meeti |
| enabledVisualWatermark | boolean | Whether or not the visual watermark is enabled. If it's `true`, the video for this meeting will have a watermark. In this case, Webex superimposes a watermark image pattern on top of the meeting video |
| visualWatermarkOpacity | number | Opacity level for the visual watermark. The value must be between 5 and 80, inclusive. A smaller value means less distraction for meeting participants, while a larger value shows a clearer watermark. |
| audioConnectionOptions | object | Audio connection options. |
| requireAttendeeLogin | boolean | Require attendees to sign in before joining the webinar. This option works when the value of `scheduledType` attribute is `webinar`. Please note that `requireAttendeeLogin` cannot be set if someone ha |
| restrictToInvitees | boolean | Restrict webinar to invited attendees only. This option works when the registration option is disabled and the value of `scheduledType` attribute is `webinar`. Please note that `restrictToInvitees` ca |
| 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/CreateMeetingObject",
"title": "CreateMeetingObject",
"type": "object",
"required": [
"title",
"start",
"end"
],
"properties": {
"adhoc": {
"type": "boolean",
"description": "Whether or not to create an ad-hoc meeting for the room specified by `roomId`. When `true`, `roomId` is required."
},
"roomId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPT00vNDMzZjk0ZjAtOTZhNi0xMWViLWJhOTctOTU3OTNjZDhiY2Q2",
"description": "Unique identifier for the Webex space which the meeting is to be associated with. It can be retrieved by [List Rooms](/docs/api/v1/rooms/list-rooms). `roomId` is required when `adhoc` is `true`. When `roomId` is specified, the parameter `hostEmail` will be ignored."
},
"templateId": {
"type": "string",
"example": "N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM",
"description": "Unique identifier for meeting template. Please note that `start` and `end` are optional when `templateId` is specified. The list of meeting templates that is available for the authenticated user can be retrieved from [List Meeting Templates](/docs/api/v1/meetings/list-meeting-templates). This parameter is ignored for an ad-hoc meeting."
},
"title": {
"type": "string",
"example": "John's Meeting",
"description": "Meeting title. The title can be a maximum of 128 characters long. The default value for an ad-hoc meeting is the user's name if not specified."
},
"agenda": {
"type": "string",
"example": "John's Agenda",
"description": "Meeting agenda. The agenda can be a maximum of 1300 characters long."
},
"password": {
"type": "string",
"example": "BgJep@43",
"description": "Meeting password. 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."
},
"start": {
"type": "string",
"example": "2020-05-15T20:30:00-08:00",
"description": "Date and time for the start of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `start` cannot be before current date and time or after `end`. Duration between `start` and `end` cannot be shorter than 10 minutes or longer than 23 hours 59 minutes. Please note that when a meeting is being scheduled, `start` of the meeting will be accurate to minutes, not seconds or milliseconds. Therefore, if `start` is within the same minute as the current time, `start` will be adjusted to the upcoming minute; otherwise, `start` will be adjusted with seconds and milliseconds stripped off. For instance, if the current time is `2022-03-01T10:32:16.657+08:00`, `start` of `2022-03-01T10:32:28.076+08:00` or `2022-03-01T10:32:41+08:00` will be adjusted to `2022-03-01T10:33:00+08:00`, and `start` of `2022-03-01T11:32:28.076+08:00` or `2022-03-01T11:32:41+08:00` will be adjusted to `2022-03-01T11:32:00+08:00`. The default value for an ad-hoc meeting is 5 minutes after the current time and the user's input value will be ignored. An ad-hoc meeting can be started immediately even if the `start` is 5 minutes after the current time."
},
"end": {
"type": "string",
"example": "2020-05-15T21:30:00-08:00",
"description": "Date and time for the end of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `end` cannot be before current date and time or before `start`. Duration between `start` and `end` cannot be shorter than 10 minutes or longer than 23 hours 59 minutes. Please note that when a meeting is being scheduled, `end` of the meeting will be accurate to minutes, not seconds or milliseconds. Therefore, `end` will be adjusted with seconds and milliseconds stripped off. For instance, `end` of `2022-03-01T11:52:28.076+08:00` or `2022-03-01T11:52:41+08:00` will be adjusted to `2022-03-01T11:52:00+08:00`. The default value for an ad-hoc meeting is 20 minutes after the current time and the user's input value will be ignored."
},
"timezone": {
"type": "string",
"example": "America/Los_Angeles",
"description": "[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in which the meeting was originally scheduled (conforming with the [IANA time zone database](https://www.iana.org/time-zones)). The default value for an ad-hoc meeting is `UTC` and the user's input value will be ignored."
},
"recurrence": {
"type": "string",
"example": "FREQ=DAILY;INTERVAL=1;COUNT=20",
"description": "Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)), applying only to meeting series. It doesn't apply to a scheduled meeting or an ended or ongoing meeting instance. This parameter is ignored for an ad-hoc meeting. 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\"."
},
"enabledAutoRecordMeeting": {
"type": "boolean",
"description": "Whether or not meeting is recorded automatically."
},
"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 `siteUrl` parameter when creating the meeting; if not specified, it's the user's preferred site. The default value for an ad-hoc meeting is `true` and the user's input value will be ignored."
},
"enabledJoinBeforeHost": {
"type": "boolean",
"description": "Whether or not to allow any attendee to join the meeting before the host joins the meeting. The default value for an ad-hoc meeting is `true` and the user's input value will be ignored."
},
"enableConnectAudioBeforeHost": {
"type": "boolean",
"description": "Whether or not to allow any attendee to connect audio in the meeting before the host joins the meeting. This attribute is only applicable if the `enabledJoinBeforeHost` attribute is set to true. The default value for an ad-hoc meeting is `true` and the user's input value will be ignored."
},
"joinBeforeHostMinutes": {
"type": "number",
"example": 15,
"description": "Number of minutes an attendee can join the meeting before the meeting start time and the host joins. This attribute is only applicable if the `enabledJoinBeforeHost` attribute is set to true. 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 value for an ad-hoc meeting is 0 and the user's input value will be ignored."
},
"excludePassword": {
"type": "boolean",
"description": "Whether or not to exclude the meeting password from the email invitation. This parameter is ignored for an ad-hoc meeting."
},
"publicMeeting": {
"type": "boolean",
"description": "Whether or not to allow the meeting to be listed on the public calendar. The default value for an ad-hoc meeting is `false` and the user's input value will be ignored."
},
"reminderTime": {
"type": "number",
"example": 10,
"description": "The number of minutes before the meeting begins, that an email reminder is sent to the host. This parameter is ignored for an ad-hoc meeting."
},
"unlockedMeetingJoinSecurity": {
"type": "string",
"enum": [
"allowJoin",
"allowJoinWithLobby",
"blockFromJoin"
],
"description": "Specifies how the people who aren't on the invite can join the unlocked meeting. The default value for an ad-hoc meeting is `allowJoinWithLobby` and the user's input value will be ignored.\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": "When set as an attribute in a POST request body, specifies whether it's 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). If not specified, it's a regular meeting by default. The default value for an ad-hoc meeting is `meeting` and the user's input value will be ignored.\n * `meeting` - Set the value of `scheduledType` attribute to `meeting` for creating a regular meeting.\n * `webinar` - Set the value of `scheduledType` attribute to `webinar` for creating a webinar meeting.\n * `personalRoomMeeting` - Set the value of `scheduledType` attribute to `personalRoomMeeting` for creating a meeting in the user's [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings). Please note that `templateId`, `roomId`, `integrationTags`, `enabledWebcastView`, `enabledAutoRecordMeeting` and `registration` are not supported when creating a personal room meeting.\n"
},
"enabledWebcastView": {
"type": "boolean",
"description": "Whether or not webcast view is enabled. This parameter is ignored for an ad-hoc meeting."
},
"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. This parameter is ignored for an ad-hoc meeting."
},
"enableAutomaticLock": {
"type": "boolean",
"description": "Whether or not to automatically lock the meeting after it starts. The default value for an ad-hoc meeting is `false` and the user's input value will be ignored."
},
"automaticLockMinutes": {
"type": "number",
"example": 10,
"description": "The number of minutes after the meeting begins, for automatically locking it. The default value for an ad-hoc meeting is null and the user's input value will be ignored."
},
"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 `siteUrl` parameter when creating the meeting; if not specified, it's user's preferred site. The default value for an ad-hoc meeting is `false` and the user's input value will be ignored."
},
"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. The default value for an ad-hoc meeting is `true` and the user's input value will be ignored."
},
"invitees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InviteeObjectForCreateMeeting"
},
"description": "Invitees for meeting. The maximum size of invitees is 1000. If `roomId` is specified and `invitees` is missing, all the members in the space are invited implicitly. If both `roomId` and `invitees` are specified, only those in the `invitees` list are invited. `coHost` for each invitee is `true` by default if `roomId` is specified when creating a meeting, and anyone in the invitee list that is not qualified to be a cohost will be invited as a non-cohost invitee. The user's input value will be ignored for an ad-hoc meeting and the the members of the room specified by `roomId` except \"me\" will be used by default."
},
"sendEmail": {
"type": "boolean",
"example": true,
"description": "Whether or not to send emails to host and invitees. It is an optional field and default value is true. The default value for an ad-hoc meeting is `false` and the user's input value will be ignored."
},
"hostEmail": {
"type": "string",
"example": "[email protected]",
"description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site which the meeting is created on. If not specified, the meeting is created on user's preferred site. All available Webex sites and preferred site of the user can be retrieved by `Get Site List` API."
},
"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 request is accepted automatically."
},
"requireFirstName": {
"type": "boolean",
"example": true,
"description": "Whether or not a registrant's first name is required for meeting registration. This option must always be `true`."
},
"requireLastName": {
"type": "boolean",
"example": true,
"description": "Whether or not a registrant's last name is required for meeting registration. This option must always be `true`."
},
"requireEmail": {
"type": "boolean",
"example": true,
"description": "Whether or not a registrant's email is required for meeting registration. This option must always be `true`."
},
"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/CustomizedQuestionForCreateMeeting"
},
"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. The integration application queries meetings by a key in its own domain. The maximum size of `integrationTags` is 3 and each item of `integrationTags` can be a maximum of 64 characters long. This parameter is ignored for an ad-hoc meeting."
},
"simultaneousInterpretation": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether or not simultaneous interpretation is enabled."
},
"interpreters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InterpreterObjectForSimultaneousInterpretationOfCreateOrUpdateMeeting"
},
"description": "Interpreters for meeting."
}
},
"description": "Simultaneous interpretation information for a meeting."
},
"enabledBreakoutSessions": {
"type": "boolean",
"description": "Whether or not breakout sessions are enabled."
},
"breakoutSessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreMeetingBreakoutSessionWithoutIdObject"
},
"description": "Breakout sessions are smaller groups that are split off from the main meeting or webinar. They allow a subset of participants to collaborate and share ideas over audio and video. Use breakout sessions for workshops, classrooms, or for when you need a moment to talk privately with a few participants outside of the main session. Please note that maximum number of breakout sessions in a meeting or webinar is 100. In webinars, if hosts preassign attendees to breakout sessions, the role of `attendee` will be changed to `panelist`. Breakout session is not supported for a meeting with simultaneous interpretation."
},
"trackingCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingCodeItemForCreateMeetingObject"
},
"description": "Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by [List Meeting Tracking Codes](/docs/api/v1/meetings/list-meeting-tracking-codes) API. If an optional tracking code is missing from the `trackingCodes` array and there's a default option for this tracking code, the default option is assigned automatically. If the `inputMode` of a tracking code is `select`, its value must be one of the site-level options or the user-level value. Tracking code is not supported for a personal room meeting or an ad-hoc space meeting."
},
"enabledAudioWatermark": {
"type": "boolean",
"description": "Whether or not the audio watermark is enabled. If it's `true`, `scheduledType` equals or defaults to `meeting`, and `audioConnectionOptions.audioConnectionType` equals `VoIP`, the audio for this meeting will have a watermark. In this case, a unique identifier is embedded into the audio that plays out of each Webex app and device. An administrator can use this watermark when analyzing an unauthorized recording to identify which Webex app or device was the source of the recording."
},
"enabledVisualWatermark": {
"type": "boolean",
"description": "Whether or not the visual watermark is enabled. If it's `true`, the video for this meeting will have a watermark. In this case, Webex superimposes a watermark image pattern on top of the meeting video and shared content to deter participants from leaking meeting information. Each participant viewing the meeting sees a watermark image pattern with their email address. If the participant is not signed in, the watermark image pattern includes their display name and email address."
},
"visualWatermarkOpacity": {
"type": "number",
"example": 10,
"description": "Opacity level for the visual watermark. The value must be between 5 and 80, inclusive. A smaller value means less distraction for meeting participants, while a larger value shows a clearer watermark. It's supported when `enabledVisualWatermark` is `true`."
},
"audioConnectionOptions": {
"type": "object",
"properties": {
"audioConnectionType": {
"type": "string",
"enum": [
"webexAudio",
"VoIP",
"other",
"none"
],
"description": "Choose how meeting attendees join the audio portion of the meeting.\n * `webexAudio` - Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.\n * `VoIP` - Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.\n * `other` - Other teleconference services.\n * `none` - The way of attendees join the audio portion of the meeting is the default value.\n"
},
"enabledTollFreeCallIn": {
"type": "boolean",
"example": true,
"description": "Whether or not to show toll-free call-in numbers."
},
"enabledGlobalCallIn": {
"type": "boolean",
"example": true,
"description": "Whether or not to show global call-in numbers to attendees."
},
"enabledAudienceCallBack": {
"type": "boolean",
"description": "Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set `true` for a webinar."
},
"entryAndExitTone": {
"type": "string",
"enum": [
"beep",
"announceName",
"noTone"
],
"description": "Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.\n * `beep` - All call-in users joining the meeting will hear the beep.\n * `announceName` - All call-in users joining the meeting will hear their names.\n * `noTone` - Turn off beeps and name announcements.\n"
},
"allowHostToUnmuteParticipants": {
"type": "boolean",
"description": "Whether or not to allow the host to unmute participants."
},
"allowAttendeeToUnmuteSelf": {
"type": "boolean",
"example": true,
"description": "Whether or not to allow attendees to unmute themselves."
},
"muteAttendeeUponEntry": {
"type": "boolean",
"description": "Whether or not to auto-mute attendees when attendees enter meetings."
}
},
"description": "Audio conn
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/json-schema/webex-createmeetingobject-schema.json