Create a Meeting
Creates a new meeting. Regular users can schedule up to 100 meetings in 24 hours and admin users up to 3000 overall or 800 for a single user. Please note that the failed requests are also counted toward the limits.
The
spark:allscope is required whenroomIdis specified.If the parameter
adhocistrueandroomIdis specified, an ad-hoc meeting is created for the target room. An ad-hoc meeting is a non-recurring instant meeting for the target room which is supposed to be started immediately after being created for a quick collaboration. There's only one ad-hoc meeting for a room at the same time. So, if there's already an ongoing ad-hoc meeting for the room, the API returns this ongoing meeting instead of creating a new one. If it's a direct room, both members of the room can create an ad-hoc meeting for the room. If it's a group room, only room members that are in the same organization as the room can create an ad-hoc meeting for the room. Please note that an ad-hoc meeting is for the purpose of an instant collaboration with people in a room, user should not persist theidandmeetingNumberof the ad-hoc meeting when it's been created since this meeting may become an inactive ad-hoc meeting for the room if it's not been started after being created for a while or it has been started and ended. Each time a user needs an ad-hoc meeting for a room, they should create one instead of reusing the previous persisted one. Moreover, for the same reason, no email will be sent when an ad-hoc meeting is created. Ad-hoc meetings cannot be updated by Update a Meeting or deleted by Delete a Meeting. Ad-hoc meetings cannot be listed by List Meetings and the scheduled meetings of an ad-hoc meeting cannot be listed by List Meetings of a Meeting Series, but the ended and ongoing instances of ad-hoc meetings can be listed by List Meetings and List Meetings of a Meeting Series.If the parameter
adhocistrue,roomIdis required and the others are optional or ignored.The default value of
titlefor an ad-hoc meeting is the user's name if not specified. The following parameters for an ad-hoc meeting have default values and the user's input values will be ignored:scheduledTypeis alwaysmeeting;startandendare 5 minutes after the current time and 20 minutes after the current time respectively;timezoneisUTC;allowAnyUserToBeCoHost,allowAuthenticatedDevices,enabledJoinBeforeHost,enableConnectAudioBeforeHostare alwaystrue;allowFirstUserToBeCoHost,enableAutomaticLock,publicMeeting,sendEmailare alwaysfalse;inviteesis the room members except "me";joinBeforeHostMinutesis 5;automaticLockMinutesis null;unlockedMeetingJoinSecurityisallowJoinWithLobby. An ad-hoc meeting can be started immediately even if thestartis 5 minutes after the current time.The following parameters are not supported and will be ignored for an ad-hoc meeting:
templateId,recurrence,excludePassword,reminderTime,registration,integrationTags,enabledWebcastView, andpanelistPassword.If the value of the parameter
recurrenceis null, a non-recurring meeting is created.If the parameter
recurrencehas a value, a recurring meeting is created based on the rule defined by the value ofrecurrence. For a non-recurring meeting which has norecurrencevalue set, itsmeetingTypeis alsomeetingSerieswhich is a meeting series with only one occurrence in Webex meeting modeling. If you specify arecurrencelikeFREQ=DAILY;INTERVAL=1which never ends, the furthest date of the series is unlimited. You can also specify arecurrencewith a very distant ending date in the future, e.g.FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.If the parameter
templateIdhas a value, the meeting is created based on the meeting template specified bytemplateId. The list of meeting templates that is available for the authenticated user can be retrieved from List Meeting Templates.If the parameter
siteUrlhas a value, the meeting is created on the specified site. Otherwise, the meeting is created on the user's preferred site. All available Webex sites and preferred site of the user can be retrieved byGet Site ListAPI.If the parameter
scheduledTypeequals "personalRoomMeeting", the meeting is created in the user's personal room.If the parameter
roomIdhas a value, the meeting is created for the Webex space specified byroomId. IfroomIdis specified but the user calling the API is not a member of the Webex space specified byroomId, the API will fail even if the user has the admin-level scopes or he is calling the API on behalf of another user which is specified byhostEmailand is a member of the Webex space.If the parameter
enabledAudioWatermarkistrue,scheduledTypeequals or defaults tomeeting, andaudioConnectionOptions.audioConnectionTypeequalsVoIP, 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.If the parameter
enabledVisualWatermarkistrue, 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.The default value of
visualWatermarkOpacityis 10 if not specified. 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 whenenabledVisualWatermarkistrue.The
registrationcan be specified when creating a meeting, but it can't be updated by Update a Meeting or Patch a Meeting. Create a registration form for a meeting that doesn't have one or update the registration form for a meeting that already has one by using Update Meeting Registration Form. Delete the registration form for a meeting by using Delete Meeting Registration Form.
Body Parameters
Whether or not to create an ad-hoc meeting for the room specified by roomId. When true, roomId is required.
Unique identifier for the Webex space which the meeting is to be associated with. It can be retrieved by List Rooms. roomId is required when adhoc is true. When roomId is specified, the parameter hostEmail will be ignored.
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. This parameter is ignored for an ad-hoc meeting.
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.
Meeting agenda. The agenda can be a maximum of 1300 characters long.
Meeting password. Must conform to the site's password complexity settings. Read password management for details. If not specified, a random password conforming to the site's password rules will be generated automatically.
Date and time for the start of meeting in any 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.
Date and time for the end of meeting in any 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.
Time zone in which the meeting was originally scheduled (conforming with the IANA time zone database). The default value for an ad-hoc meeting is UTC and the user's input value will be ignored.
Meeting series recurrence rule (conforming with RFC 2445), 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".
Whether or not meeting is recorded automatically.
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.
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.
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.
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.
Whether or not to exclude the meeting password from the email invitation. This parameter is ignored for an ad-hoc meeting.
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.
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.
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.
If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.
If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.
If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.
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 API.
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. 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.
Set the value of scheduledType attribute to meeting for creating a regular meeting.
Set the value of scheduledType attribute to webinar for creating a webinar meeting.
Set the value of scheduledType attribute to personalRoomMeeting for creating a meeting in the user's personal room. Please note that templateId, roomId, integrationTags, enabledWebcastView, enabledAutoRecordMeeting and registration are not supported when creating a personal room meeting.
Whether or not webcast view is enabled. This parameter is ignored for an ad-hoc meeting.
Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read password management 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.
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.
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.
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.
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 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.
Email address of meeting invitee.
Display name of meeting invitee. The maximum length of displayName is 128 characters. If not specified but the email has been registered, user's registered name for the email will be taken as displayName. If not specified and the email hasn't been registered, the email will be taken as displayName.
Whether or not invitee is allowed to be a cohost for the meeting. 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.
Whether or not an invitee is allowed to be a panelist. Only applies to webinars.
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.
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.
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.
Meeting Options.
Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.
Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.
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.
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.
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.
If the value of noteType attribute is allowAll, all participants can take notes.
If the value of noteType attribute is allowOne, only a single note taker is allowed.
Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.
Whether or not to allow any attendee to share Universal Communications Format 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.
Attendee Privileges. This attribute is not supported for a webinar.
Whether or not to allow any attendee to share content in the meeting.
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.
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.
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.
Whether or not to allow any attendee to view participants.
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.
Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.
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.
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.
Whether or not to allow any attendee to contact the operator privately.
Whether or not to allow any attendee to chat with the host in private.
Whether or not to allow any attendee to chat with the presenter in private.
Whether or not to allow any attendee to chat with other participants in private.
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 for details.
Whether or not meeting registration request is accepted automatically.
Whether or not a registrant's first name is required for meeting registration. This option must always be true.
Whether or not a registrant's last name is required for meeting registration. This option must always be true.
Whether or not a registrant's email is required for meeting registration. This option must always be true.
Whether or not a registrant's job title is shown or required for meeting registration.
Whether or not a registrant's company name is shown or required for meeting registration.
Whether or not a registrant's first address field is shown or required for meeting registration.
Whether or not a registrant's second address field is shown or required for meeting registration.
Whether or not a registrant's city is shown or required for meeting registration.
Whether or not a registrant's state is shown or required for meeting registration.
Whether or not a registrant's postal code is shown or required for meeting registration.
Whether or not a registrant's country or region is shown or required for meeting registration.
Whether or not a registrant's work phone number is shown or required for meeting registration.
Whether or not a registrant's fax number is shown or required for meeting registration.
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.
If true, generate random ID authentication for each registrant. Webinars only.
Customized questions for meeting registration.
Title of the customized question.
Whether or not the customized question is required to be answered by participants.
Type of the question being asked.
Single line text box.
Multiple line text box.
Check box which requires options.
Drop down list box which requires options.
Single radio button which requires options.
The maximum length of a string that can be entered by the user, ranging from 0 to 999. Only required by singleLineTextBox and multiLineTextBox.
The content of options. Required if the question type is one of checkbox, dropdownList, or radioButtons.
The content of the option.
The automatic approval rules for customized questions.
Judgment expression for approval rules.
The content of the answer contains the value.
The content of the answer does not contain the value
The content of the answer begins with the value.
The content of the answer ends with the value.
The content of the answer is the same as the value.
The content of the answer is not the same as the value.
The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.
The automatic approval result for the approval rule.
If the user's registration value meets the criteria, the registration form will be automatically approved.
If the user's registration value meets the criteria, the registration form will be automatically rejected.
Whether to check the case of values.
The approval rules for standard questions.
Name for standard question.
If the value is lastName, this approval rule applies to the standard question of "Last Name".
If the value is email, this approval rule applies to the standard question of "Email".
If the value is jobTitle, this approval rule applies to the standard question of "Job Title".
If the value is companyName, this approval rule applies to the standard question of "Company Name".
If the value is address1, this approval rule applies to the standard question of "Address 1".
If the value is address2, this approval rule applies to the standard question of "Address 2".
If the value is city, this approval rule applies to the standard question of "City".
If the value is state, this approval rule applies to the standard question of "State".
If the value is zipCode, this approval rule applies to the standard question of "Zip/Post Code".
If the value is countryRegion, this approval rule applies to the standard question of "Country Region".
If the value is workPhone, this approval rule applies to the standard question of "Work Phone".
If the value is fax, this approval rule applies to the standard question of "Fax".
Judgment expression for approval rules.
The content of the answer contains the value.
The content of the answer does not contain the value
The content of the answer begins with the value.
The content of the answer ends with the value.
The content of the answer is the same as the value.
The content of the answer is not the same as the value.
The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.
The automatic approval result for the approval rule.
If the user's registration value meets the criteria, the registration form will be automatically approved.
If the user's registration value meets the criteria, the registration form will be automatically rejected.
Whether to check the case of values.
The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together.
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.
Simultaneous interpretation information for a meeting.
Whether or not simultaneous interpretation is enabled.
Interpreters for meeting.
Email address of meeting interpreter.
Display name of meeting interpreter.
Whether or not breakout sessions are enabled.
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.
Name for breakout session.
Invitees for breakout session. Please note that one invitee cannot be assigned to more than one breakout session.
Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by 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.
Name of the tracking code. The name cannot be empty and the maximum size is 120 characters.
Value for the tracking code. value cannot be empty and the maximum size is 120 characters.
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.
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.
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.
Audio connection options.
Choose how meeting attendees join the audio portion of the meeting.
Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.
Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.
Other teleconference services.
The way of attendees join the audio portion of the meeting is the default value.
Whether or not to show toll-free call-in numbers.
Whether or not to show global call-in numbers to attendees.
Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.
Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.
All call-in users joining the meeting will hear the beep.
All call-in users joining the meeting will hear their names.
Turn off beeps and name announcements.
Whether or not to allow the host to unmute participants.
Whether or not to allow attendees to unmute themselves.
Whether or not to auto-mute attendees when attendees enter meetings.
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 has already registered for the webinar.
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 cannot be set to true if requireAttendeeLogin is false.
Response Properties
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.
Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.
Meeting title. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
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 API.
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 API.
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.
Meeting type.
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.
Instance from a primary meeting series.
Meeting instance that is in progress or has completed.
Meeting state.
Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.
Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.
Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.
Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.
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.
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.
This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.
This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.
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.
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.
If true, the meeting is ad-hoc.
Time zone of start and end, conforming with the IANA time zone database.
Start time for meeting in ISO 8601 compliant format. If the meetingType of this meeting is meetingSeries, and current is not specified or is false, start is the scheduled start time of the first occurrence of this series. If the meetingType of this meeting is meetingSeries, and current is not specified or is false, start is the scheduled start time of the first occurrence of this series. If the meetingType of this meeting is meetingSeries, and current is true, start is the scheduled start time of the ongoing or upcoming occurrence in this series. If the meetingType of this meeting is scheduledMeeting, start is the scheduled start time of this occurrence. If the meetingType of this meeting is meeting, start is the actual start time of this meeting instance. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
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 meetingType of this meeting is meetingSeries, and current is not specified or is false, end is the scheduled end time of the first occurrence of this series. If the meetingType of this meeting is meetingSeries, and current is true, end is the scheduled end time of the ongoing or upcoming occurrence in this series. If the meetingType of this meeting is scheduledMeeting, end is the scheduled end time of this occurrence. If the meetingType of this meeting is meeting, end is the actual end time of this meeting instance. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Meeting series recurrence rule (conforming with RFC 2445). 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 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".
Unique identifier for the meeting host.
Display name for the meeting host.
Email address for the meeting host.
Key for joining the meeting as host.
Site URL for the meeting.
Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.
SIP address for callback from a video system.
IP address for callback from a video system.
Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings.
Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
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 API.
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 API.
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 API.
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 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.
Whether or not to exclude the meeting password from the email invitation.
Whether or not to allow the meeting to be listed on the public calendar.
The number of minutes before the meeting begins, that an email reminder is sent to the host.
Specifies how the people who aren't on the invite can join the unlocked meeting.
If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.
If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.
If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.
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 API.
Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's personal room.
If the value of scheduledType attribute is meeting, it is a regular meeting.
If the value of scheduledType attribute is webinar, it is a webinar meeting.
If the value of scheduledType attribute is personalRoomMeeting, it is a meeting scheduled in the user's personal room.
Whether or not webcast view is enabled.
Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read password management for details. If not specified, a random password conforming to the site's password rules will be generated automatically.
8-digit numeric panelist password to join a webinar meeting from audio and video devices.
Whether or not to automatically lock the meeting after it starts.
The number of minutes after the meeting begins, for automatically locking it.
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 API.
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 API.
Whether or not this meeting instance has chat.
Whether or not this meeting instance has been recorded. true if the meeting instance has been recorded even if the recording has been deleted.
Whether or not this meeting instance has a transcription.
Whether or not this meeting instance has closed captions.
Whether or not this meeting instance has polls.
Whether or not this meeting instance has Q&A.
Whether or not this meeting instance has a registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances.
Whether or not someone has registered a this meeting instance via the registration form. Only applies to ended meeting or webinar instances. Doesn't apply to meeting series, scheduled meetings, or in-progress meeting or webinar instances.
Whether this meeting instance has a survey and someone has responded to the survey. Only applies to ended webinar instances. Doesn't apply to meeting series, scheduled meetings, in-progress meeting or webinar instances, or ended meeting instances.
Information for callbacks from a meeting to phone or for joining a teleconference using a phone.
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.
Array of call-in numbers for joining a teleconference from a phone.
Label for the call-in number.
Call-in number to join the teleconference from a phone.
Type of toll for the call-in number.
HATEOAS information of global call-in numbers for joining a teleconference from a phone.
Meeting options.
Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.
Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.
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.
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.
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.
If the value of noteType attribute is allowAll, all participants can take notes.
If the value of noteType attribute is allowOne, only a single note taker is allowed.
Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.
Whether or not to allow any attendee to share Universal Communications Format 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.
Attendee Privileges. This attribute is not supported for a webinar.
Whether or not to allow any attendee to share content in the meeting.
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.
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.
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.
Whether or not to allow any attendee to view participants.
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.
Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.
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.
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.
Whether or not to allow any attendee to contact the operator privately.
Whether or not to allow any attendee to chat with the host in private.
Whether or not to allow any attendee to chat with the presenter in private.
Whether or not to allow any attendee to chat with other participants in private.
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 the Join Before Host option is enabled for the meeting. See Register for a Meeting in Cisco Webex Meetings for details.
Whether or not meeting registration requests are accepted automatically.
Whether or not a registrant's first name is required for meeting registration.
Whether or not a registrant's last name is required for meeting registration.
Whether or not a registrant's email is required for meeting registration.
Whether or not a registrant's job title is required for meeting registration.
Whether or not a registrant's company name is required for meeting registration.
Whether or not a registrant's first address field is required for meeting registration.
Whether or not a registrant's second address field is required for meeting registration.
Whether or not a registrant's city is required for meeting registration.
Whether or not a registrant's state is required for meeting registration.
Whether or not a registrant's postal code is required for meeting registration.
Whether or not a registrant's country or region is required for meeting registration.
Whether or not a registrant's work phone number is required for meeting registration.
Whether or not a registrant's fax number is required for meeting registration.
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.
If true, generate random ID authentication for each registrant. Webinars only.
External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc.
Simultaneous interpretation information for the meeting.
Whether or not simultaneous interpretation is enabled.
Interpreters for meeting.
Unique identifier for meeting interpreter.
Email address of meeting interpreter.
Display name of meeting interpreter.
Tracking codes information.
Name for the tracking code.
Value for the tracking code.
Whether or not the audio watermark is enabled.
Whether or not the visual watermark is enabled.
Opacity level for visual watermark.
Audio connection options.
Choose how meeting attendees join the audio portion of the meeting.
Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.
Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.
Other teleconference services.
The way of attendees join the audio portion of the meeting is the default value.
Whether or not to show toll-free call-in numbers.
Whether or not to show global call-in numbers to attendees.
Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.
Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.
All call-in users joining the meeting will hear the beep.
All call-in users joining the meeting will hear their names.
Turn off beeps and name announcements.
Whether or not to allow the host to unmute participants.
Whether or not to allow attendees to unmute themselves.
Whether or not to auto-mute attendees when attendees enter meetings.
Require attendees to sign in before joining the webinar.
Restrict webinar to invited attendees only.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Body
- Whether or not to create an ad-hoc meeting for the room specified by `roomId`. When `true`, `roomId` is required.
- 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.
- 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.
- 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.
- Meeting agenda. The agenda can be a maximum of 1300 characters long.
- 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.
- 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.
- 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.
- [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.
- 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".
- Whether or not meeting is recorded automatically.
- 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.
- 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.
- 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.
- 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.
- Whether or not to exclude the meeting password from the email invitation. This parameter is ignored for an ad-hoc meeting.
- 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.
- 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.
- 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.
- 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.
- 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.
- Whether or not webcast view is enabled. This parameter is ignored for an ad-hoc meeting.
- 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.
- 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.
- 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.
- 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.
- 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 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.
- 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.
- 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.
- 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.
- Meeting Options.
- Attendee Privileges. This attribute is not supported for a webinar.
- 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.
- 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.
- Simultaneous interpretation information for a meeting.
- Whether or not breakout sessions are enabled.
- 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.
- 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.
- 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.
- 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.
- 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`.
- Audio connection options.
- 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 has already registered for the webinar.
- 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` cannot be set to `true` if `requireAttendeeLogin` is `false`.
{
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"password": "BgJep@43",
"start": "2019-11-01 20:00:00",
"end": "2019-11-01 21:00:00",
"timezone": "Asia/Shanghai",
"recurrence": "FREQ=DAILY;INTERVAL=1;COUNT=10",
"enabledAutoRecordMeeting": false,
"allowAnyUserToBeCoHost": false,
"enabledJoinBeforeHost": false,
"enableConnectAudioBeforeHost": false,
"joinBeforeHostMinutes": 0,
"excludePassword": false,
"publicMeeting": false,
"reminderTime": 10,
"unlockedMeetingJoinSecurity": "allowJoin",
"enableAutomaticLock": false,
"automaticLockMinutes": 0,
"allowFirstUserToBeCoHost": false,
"allowAuthenticatedDevices": false,
"invitees": [
{
"email": "john.andersen@example.com",
"displayName": "John Andersen",
"coHost": false,
"panelist": false
},
{
"email": "brenda.song@example.com",
"displayName": "Brenda Song",
"coHost": false,
"panelist": false
}
],
"sendEmail": true,
"hostEmail": "john.andersen@example.com",
"siteUrl": "site4-example.webex.com",
"registration": {
"requireFirstName": true,
"requireLastName": true,
"requireEmail": true,
"requireCompanyName": true,
"requireCountryRegion": false,
"requireWorkPhone": true,
"enabledRegistrationId": false,
"customizedQuestions": [
{
"question": "What color do you like?",
"required": true,
"type": "checkbox",
"options": [
{
"value": "green"
},
{
"value": "black"
},
{
"value": "yellow"
},
{
"value": "red"
}
],
"rules": [
{
"condition": "notEquals",
"value": "red",
"result": "reject",
"matchCase": true,
"order": 2
}
]
},
{
"question": "Project Team",
"type": "singleLineTextBox",
"maxLength": 120
},
{
"question": "How are you",
"type": "multiLineTextBox"
},
{
"question": "Dropdownlist Q",
"type": "dropdownList",
"options": [
{
"value": "A1"
},
{
"value": "A2"
}
]
},
{
"question": "weather",
"required": false,
"type": "radioButtons",
"maxLength": 120,
"options": [
{
"value": "sunny"
},
{
"value": "rain"
}
]
}
],
"rules": [
{
"question": "lastName",
"condition": "endsWith",
"value": "tom",
"result": "reject",
"matchCase": false,
"order": 1
}
]
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"simultaneousInterpretation": {
"enabled": true,
"interpreters": [
{
"languageCode1": "en",
"languageCode2": "de",
"email": "marcus.hoffmann@example.com",
"displayName": "Hoffmann"
},
{
"languageCode1": "en",
"languageCode2": "fr",
"email": "antoine.martin@example.com",
"displayName": "Martin"
}
]
},
"enabledBreakoutSessions": true,
"breakoutSessions": [
{
"name": "Breakout Session 1",
"invitees": [
"rachel.green@example.com",
"monica.geller@example.com"
]
},
{
"name": "Breakout Session N",
"invitees": [
"ross.geller@example.com",
"chandler.bing@example.com"
]
}
],
"trackingCodes": [
{
"name": "Department",
"value": "Engineering"
},
{
"name": "Division",
"value": "Full-time"
}
],
"enabledAudioWatermark": true,
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 10,
"scheduledType": "meeting",
"audioConnectionOptions": {
"audioConnectionType": "VoIP"
}
}
{
"id": "870f51ff287b41be84648412901e0402",
"meetingNumber": "123456789",
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"password": "BgJep@43",
"phoneAndVideoSystemPassword": "12345678",
"meetingType": "meetingSeries",
"state": "active",
"timezone": "Asia/Shanghai",
"start": "2019-11-01T20:00:00+08:00",
"end": "2019-11-01T21:00:00+08:00",
"recurrence": "FREQ=DAILY;COUNT=10;INTERVAL=1",
"hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"hostKey": "123456",
"siteUrl": "site4-example.webex.com",
"webLink": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e",
"registerLink": "https://cisco.webex.com/weblink/register/r55981368ee48e2a6f00b93231508c404",
"sipAddress": "123456789@site4-example.webex.com",
"dialInIpAddress": "192.168.100.100",
"enabledAutoRecordMeeting": false,
"allowAnyUserToBeCoHost": false,
"enabledJoinBeforeHost": false,
"enableConnectAudioBeforeHost": false,
"joinBeforeHostMinutes": 0,
"excludePassword": false,
"publicMeeting": false,
"reminderTime": 10,
"unlockedMeetingJoinSecurity": "allowJoin",
"sessionTypeId": 3,
"enableAutomaticLock": false,
"automaticLockMinutes": 0,
"allowFirstUserToBeCoHost": false,
"allowAuthenticatedDevices": false,
"telephony": {
"accessCode": "1234567890",
"callInNumbers": [
{
"label": "US Toll",
"callInNumber": "123456789",
"tollType": "toll"
}
],
"links": [
{
"rel": "globalCallinNumbers",
"href": "/api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers",
"method": "GET"
}
]
},
"meetingOptions": {
"enabledChat": true,
"enabledVideo": true,
"enabledPolling": false,
"enabledNote": true,
"noteType": "allowAll",
"enabledFileTransfer": false,
"enabledUCFRichMedia": false
},
"attendeePrivileges": {
"enabledShareContent": true,
"enabledSaveDocument": false,
"enabledPrintDocument": false,
"enabledAnnotate": false,
"enabledViewParticipantList": true,
"enabledViewThumbnails": false,
"enabledRemoteControl": true,
"enabledViewAnyDocument": false,
"enabledViewAnyPage": false,
"enabledContactOperatorPrivately": false,
"enabledChatHost": true,
"enabledChatPresenter": true,
"enabledChatOtherParticipants": true
},
"registration": {
"autoAcceptRequest": false,
"requireFirstName": true,
"requireLastName": true,
"requireEmail": true,
"requireCompanyName": true,
"requireCountryRegion": false,
"requireWorkPhone": true,
"enabledRegistrationId": false,
"customizedQuestions": [
{
"id": "3386787",
"question": "What color do you like?",
"required": true,
"type": "checkbox",
"options": [
{
"id": "1",
"value": "green"
},
{
"id": "2",
"value": "black"
},
{
"id": "3",
"value": "yellow"
},
{
"id": "4",
"value": "red"
}
],
"rules": [
{
"condition": "notEquals",
"value": "red",
"result": "reject",
"matchCase": true,
"order": 2
}
]
},
{
"id": "3386792",
"question": "Project Team",
"required": false,
"type": "singleLineTextBox",
"maxLength": 120
},
{
"id": "3386797",
"question": "How are you",
"required": false,
"type": "multiLineTextBox",
"maxLength": 999
},
{
"id": "3386802",
"question": "Dropdownlist Q",
"required": false,
"type": "dropdownList",
"options": [
{
"id": "1",
"value": "A1"
},
{
"id": "2",
"value": "A2"
}
]
},
{
"question": "weather",
"required": false,
"type": "radioButtons",
"maxLength": 120,
"options": [
{
"id": "1",
"value": "sunny"
},
{
"id": "2",
"value": "rain"
}
]
}
],
"rules": [
{
"question": "lastName",
"condition": "endsWith",
"value": "tom",
"result": "reject",
"matchCase": false,
"order": 1
}
]
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"scheduledType": "meeting",
"simultaneousInterpretation": {
"enabled": true,
"interpreters": [
{
"id": "OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM",
"languageCode1": "en",
"languageCode2": "de",
"email": "marcus.hoffmann@example.com",
"displayName": "Hoffmann"
},
{
"id": "3GQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MAJiZDBjNWVlNDC4YjgxMTZlMjU4Zjg2NWIzZmM",
"languageCode1": "en",
"languageCode2": "fr",
"email": "antoine.martin@example.com",
"displayName": "Martin"
}
]
},
"enabledBreakoutSessions": true,
"links": [
{
"rel": "breakoutSessions",
"href":"/v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions",
"method": "GET"
}
],
"trackingCodes": [
{
"name": "Department",
"value": "Engineering"
},
{
"name": "Division",
"value": "Full-time"
}
],
"enabledAudioWatermark": true,
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 10,
"audioConnectionOptions": {
"audioConnectionType": "VoIP",
"enabledTollFreeCallIn": false,
"enabledGlobalCallIn": false,
"enabledAudienceCallBack": false,
"entryAndExitTone": "beep",
"allowHostToUnmuteParticipants": false,
"allowAttendeeToUnmuteSelf": true,
"muteAttendeeUponEntry": false
}
}