wxc_sdk.meetings package

Webex Meetings APIs

class wxc_sdk.meetings.AttendeePrivileges(*, enabledShareContent: bool | None = None, enabledSaveDocument: bool | None = None, enabledPrintDocument: bool | None = None, enabledAnnotate: bool | None = None, enabledViewParticipantList: bool | None = None, enabledViewThumbnails: bool | None = None, enabledRemoteControl: bool | None = None, enabledViewAnyDocument: bool | None = None, enabledViewAnyPage: bool | None = None, enabledContactOperatorPrivately: bool | None = None, enabledChatHost: bool | None = None, enabledChatPresenter: bool | None = None, enabledChatOtherParticipants: bool | None = None)[source]

Bases: ApiModel

enabled_share_content: bool | None: Whether or not to allow any attendee to share content in the meeting.

enabled_save_document: bool | None: 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.

enabled_print_document: bool | None: 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.

enabled_annotate: bool | None: 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.

enabled_view_participant_list: bool | None: Whether or not to allow any attendee to view participants.

enabled_view_thumbnails: bool | None: 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.

enabled_remote_control: bool | None: Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.

enabled_view_any_document: bool | None: 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.

enabled_view_any_page: bool | None: 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.

enabled_contact_operator_privately: bool | None: Whether or not to allow any attendee to contact the operator privately.

enabled_chat_host: bool | None: Whether or not to allow any attendee to chat with the host in private.

enabled_chat_presenter: bool | None: Whether or not to allow any attendee to chat with the presenter in private.

enabled_chat_other_participants: bool | None: Whether or not to allow any attendee to chat with other participants in private.

class wxc_sdk.meetings.AudioConnectionOptions(*, audioConnectionType: AudioConnectionType | None = None, enabledTollFreeCallIn: bool | None = None, enabledGlobalCallIn: bool | None = None, enabledAudienceCallBack: bool | None = None, entryAndExitTone: EntryAndExitTone | None = None, allowHostToUnmuteParticipants: bool | None = None, allowAttendeeToUnmuteSelf: bool | None = None, muteAttendeeUponEntry: bool | None = None)[source]

Bases: ApiModel

audio_connection_type: AudioConnectionType | None: Choose how meeting attendees join the audio portion of the meeting.

enabled_toll_free_call_in: bool | None: Whether or not to show toll-free call-in numbers.

enabled_global_call_in: bool | None: Whether or not to show global call-in numbers to attendees.

enabled_audience_call_back: bool | None: Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.

entry_and_exit_tone: EntryAndExitTone | None: Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.

allow_host_to_unmute_participants: bool | None: Whether or not to allow the host to unmute participants.

allow_attendee_to_unmute_self: bool | None: Whether or not to allow attendees to unmute themselves.

mute_attendee_upon_entry: bool | None: Whether or not to auto-mute attendees when attendees enter meetings.

class wxc_sdk.meetings.AudioConnectionType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

webex_audio = 'webexAudio': Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.

vo_ip = 'VoIP': Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.

other = 'other': Other teleconference services.

none = 'none': The way of attendees join the audio portion of the meeting is the default value.

class wxc_sdk.meetings.BreakoutSession(*, name: str | None = None, invitees: list[str] | None = None)[source]

Bases: ApiModel

name: str | None: Name for breakout session.

invitees: list[str] | None: Invitees for breakout session. Please note that one invitee cannot be assigned to more than one breakout session.

class wxc_sdk.meetings.CallInNumbers(*, label: str | None = None, callInNumber: str | None = None, tollType: str | None = None)[source]

Bases: ApiModel

label: str | None: Label for the call-in number. Possible values: Call-in toll-free number (US/Canada)

call_in_number: str | None: Call-in number to join the teleconference from a phone. Possible values: 123456789

toll_type: str | None: Type of toll for the call-in number. Possible values: toll, tollFree

class wxc_sdk.meetings.AnswerCondition(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

contains = 'contains': The content of the answer contains the value.

not_contains = 'notContains': The content of the answer does not contain the value

begins_with = 'beginsWith': The content of the answer begins with the value.

ends_with = 'endsWith': The content of the answer ends with the value.

equals = 'equals': The content of the answer is the same as the value.

not_equals = 'notEquals': The content of the answer is not the same as the value.

Bases: ApiModel

question: str | None: Title of the customized question.

required: bool | None: Whether or not the customized question is required to be answered by participants.

type: Type | None: Type of the question being asked.

max_length: int | None: The maximum length of a string that can be entered by the user, ranging from 0 to 999. Only required by singleLineTextBox and multiLineTextBox.

options: list[object] | None: The content of options. Required if the question type is one of checkbox, dropdownList, or radioButtons. The content of the option.

rules: list[ApprovalRule] | None: The automatic approval rules for customized questions.

class wxc_sdk.meetings.EntryAndExitTone(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

beep = 'beep': All call-in users joining the meeting will hear the beep.

announce_name = 'announceName': All call-in users joining the meeting will hear their names.

no_tone = 'noTone': Turn off beeps and name announcements.

Bases: ApiModel

id: str | None: Unique identifier for the survey.

survey_name: str | None: Name for the survey.

meeting_id: str | None: Unique identifier for the meeting.

description: str | None: Description for the survey.

allow_anonymous_submit: bool | None: Whether the survey allows attendees to submit anonymously.

questions: list[Question] | None: Questions for the survey.

class wxc_sdk.meetings.InputMode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

text = 'text': Text input.

select = 'select': Drop down list which requires options.

editable_select = 'editableSelect': Both text input and select from list.

host_profile_select = 'hostProfileSelect': An input method which is only available for the host profile and sign-up pages.

Bases: ApiModel

id: str | None: Unique identifier for meeting interpreter.

language_code1: str | None: Forms a set of simultaneous interpretation channels together with languageCode2. Standard language format from ISO 639-1 code. Read ISO 639-1 for details.

language_code2: str | None: Forms a set of simultaneous interpretation channels together with languageCode1. Standard language format from ISO 639-1 code. Read ISO 639-1 for details.

email: str | None: Email address of meeting interpreter.

display_name: str | None: Display name of meeting interpreter.

class wxc_sdk.meetings.InviteeForCreateMeeting(*, email: str | None = None, displayName: str | None = None, coHost: bool | None = None, panelist: bool | None = None)[source]

Bases: ApiModel

email: str | None: Email address of meeting invitee.

display_name: str | None: 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.

co_host: bool | None: 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.

panelist: bool | None: Whether or not an invitee is allowed to be a panelist. Only applies to webinars.

class wxc_sdk.meetings.JoinMeetingResponse(*, joinLink: str | None = None, expiration: str | None = None)[source]

Bases: ApiModel

join_link: str | None: The link can directly join or host the meeting.

expiration: str | None: Expiration time of joinLink.

Bases: ApiModel

id: str | None: Unique identifier for the tracking code.

name: str | None: Name for the tracking code.

site_url: str | None: Site URL for the tracking code.

options: list[TrackingCodeOption] | None: Tracking code option list. The options here differ from those in the site-level tracking codes and the user-level tracking codes. It is the result of a selective combination of the two. If there’s user-level value for a tracking code, the user-level value becomes the default option for the tracking code, and the site-level default value becomes non-default.

input_mode: InputMode | None: The input mode in which the tracking code value can be assigned.

service: MeetingService | None: Service for schedule or sign up pages

type: TrackingCodeType | None: Type for meeting scheduler or meeting start pages.

Bases: ApiModel

enabled_chat: bool | None: Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.

enabled_video: bool | None: Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.

enabled_polling: bool | None: 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.

enabled_note: bool | None: Whether or not to allow any attendee to take notes in the meeting. The value of this attribute also depends on the session type.

note_type: NoteType | None: Whether note taking is enabled. If the value of enabledNote is false, users can not set this attribute and get default value allowAll.

enabled_closed_captions: bool | None: Whether or not to allow any attendee to have closed captions in the meeting. The value of this attribute also depends on the session type.

enabled_file_transfer: bool | None: Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.

enabled_ucf_rich_media: bool | None: 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.

Bases: ApiModel

id: str | None: 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: str | None: Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.

title: str | None: Meeting title. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

agenda: str | None: 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.

password: str | None: 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.

phone_and_video_system_password: str | None: 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: MeetingType | None: Meeting type.

state: MeetingState | None: Meeting state.

timezone: str | None: Time zone of start and end, conforming with the IANA time zone database.

start: str | None: Start time for meeting in ISO 8601 compliant format. If the meetingType of a meeting is meetingSeries, start is the scheduled start time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, start is the date and time the upcoming or ongoing meeting of the series starts. If the meetingType of a meeting is scheduledMeeting, start is the scheduled start time of this occurrence. If the meetingType of a meeting is meeting, start is the actual start time of the meeting instance. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

end: str | None: End time for a meeting in ISO 8601 compliant format. If the meetingType of a meeting is meetingSeries, end is the scheduled end time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, end is the date and time the upcoming or ongoing meeting of the series ends. If the meetingType of a meeting is scheduledMeeting, end is the scheduled end time of this occurrence. If the meetingType of a meeting is meeting, end is the actual end time of the meeting instance. If a meeting instance is in progress, end is not available. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

recurrence: str | None: 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”.

host_user_id: str | None: Unique identifier for the meeting host.

host_display_name: str | None: Display name for the meeting host.

host_email: str | None: Email address for the meeting host.

host_key: str | None: Key for joining the meeting as host.

site_url: str | None: Site URL for the meeting.

web_link: str | None: Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.

sip_address: str | None: SIP address for callback from a video system.

dial_in_ip_address: str | None: IP address for callback from a video system.

room_id: str | None: Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings.

enabled_auto_record_meeting: bool | None: Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

allow_any_user_to_be_co_host: bool | None: 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.

enabled_join_before_host: bool | None: 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.

enable_connect_audio_before_host: bool | None: 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.

join_before_host_minutes: int | None: 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 are 0, 5, 10 and 15. Default is 0 if not specified.

exclude_password: bool | None: Whether or not to exclude the meeting password from the email invitation.

public_meeting: bool | None: Whether or not to allow the meeting to be listed on the public calendar.

reminder_time: int | None: The number of minutes before the meeting begins, that an email reminder is sent to the host.

unlocked_meeting_join_security: UnlockedMeetingJoinSecurity | None: Specifies how the people who aren’t on the invite can join the unlocked meeting.

session_type_id: int | None: 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.

scheduled_type: ScheduledType | None: Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user’s personal room.

enabled_webcast_view: bool | None: Whether or not webcast view is enabled.

panelist_password: str | None: 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.

phone_and_video_system_panelist_password: str | None: 8-digit numeric panelist password to join a webinar meeting from audio and video devices.

enable_automatic_lock: bool | None: Whether or not to automatically lock the meeting after it starts.

automatic_lock_minutes: int | None: The number of minutes after the meeting begins, for automatically locking it.

allow_first_user_to_be_co_host: bool | None: 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.

allow_authenticated_devices: bool | None: 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.

telephony: MeetingTelephony | None: Information for callbacks from a meeting to phone or for joining a teleconference using a phone.

meeting_options: MeetingOptions | None: Meeting options.

attendee_privileges: AttendeePrivileges | None: Attendee Privileges.

registration: Registration | None: 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.

integration_tags: list[str] | None: External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc.

simultaneous_interpretation: SimultaneousInterpretation | None: Simultaneous interpretation information for the meeting.

tracking_codes: list[TrackingCodeItem] | None: Tracking codes information.

audio_connection_options: AudioConnectionOptions | None: Audio connection options.

adhoc: bool | None: If true, the meeting is ad-hoc.

class wxc_sdk.meetings.MeetingType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

meeting_series = 'meetingSeries': Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a recurrence rule. When a non-recurring meeting is scheduled with no recurrence, its meetingType is also meetingSeries which is a meeting series with only one occurrence in Webex meeting modeling.

scheduled_meeting = 'scheduledMeeting': Instance from a primary meeting series.

meeting = 'meeting': Meeting instance that is in progress or has completed.

class wxc_sdk.meetings.NoteType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

allow_all = 'allowAll': If the value of noteType attribute is allowAll, all participants can take notes.

allow_one = 'allowOne': If the value of noteType attribute is allowOne, only a single note taker is allowed.

class wxc_sdk.meetings.QuestionOption(*, id: int | None = None, value: str | None = None)[source]

Bases: ApiModel

id: int | None: The unique id of options. Possible values: 1

value: str | None: The content of the option. Possible values: green

class wxc_sdk.meetings.TrackingCodeOption(*, value: str | None = None, defaultValue: bool | None = None)[source]

Bases: ApiModel

value: str | None: The value of a tracking code option. value cannot be empty and the maximum size is 120 characters.

default_value: bool | None: Whether or not the option is the default option of a tracking code.

Bases: ApiModel

title: str | None: Meeting title. The title can be a maximum of 128 characters long.

agenda: str | None: Meeting agenda. The agenda can be a maximum of 1300 characters long.

password: str | None: Meeting password. Must conform to the site’s password complexity settings. Read password management for details.

start: str | None: 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 24 hours. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, 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.

end: str | None: 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 24 hours. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, 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.

timezone: str | None: Time zone in which the meeting was originally scheduled (conforming with the IANA time zone database).

recurrence: str | None: 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. 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”.

enabled_auto_record_meeting: bool | None: Whether or not meeting is recorded automatically.

allow_any_user_to_be_co_host: bool | None: 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 user’s preferred site.

enabled_join_before_host: bool | None: Whether or not to allow any attendee to join the meeting before the host joins the meeting.

enable_connect_audio_before_host: bool | None: 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.

join_before_host_minutes: int | None: The 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 are 0, 5, 10 and 15. Default is 0 if not specified.

exclude_password: bool | None: Whether or not to exclude the meeting password from the email invitation.

public_meeting: bool | None: Whether or not to allow the meeting to be listed on the public calendar.

reminder_time: int | None: The number of minutes before the meeting begins, that an email reminder is sent to the host.

unlocked_meeting_join_security: UnlockedMeetingJoinSecurity | None: Specifies how the people who aren’t on the invite can join the unlocked meeting.

session_type_id: int | None: Unique identifier for a meeting session type for the user. This attribute is required while scheduling webinar meeting. All available meeting session types enabled for the user can be retrieved by List Meeting Session Types API.

enabled_webcast_view: bool | None: Whether or not webcast view is enabled.

panelist_password: str | None: 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.

enable_automatic_lock: bool | None: Whether or not to automatically lock the meeting after it starts.

automatic_lock_minutes: int | None: The number of minutes after the meeting begins, for automatically locking it.

allow_first_user_to_be_co_host: bool | None: 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.

allow_authenticated_devices: bool | None: Whether or not to allow authenticated video devices in the meeting’s organization to start or join the meeting without a prompt.

send_email: bool | None: Whether or not to send emails to host and invitees. It is an optional field and default value is true.

host_email: str | None: 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.

site_url: str | None: URL of the Webex site which the meeting is updated 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: MeetingOptions | None: Meeting Options.

attendee_privileges: AttendeePrivileges | None: Attendee Privileges.

integration_tags: list[str] | None: 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. Please note that an empty or null integrationTags will delete all existing integration tags for the meeting implicitly. Developer can update integration tags for a meetingSeries but he cannot update it for a scheduledMeeting or a meeting instance.

enabled_breakout_sessions: bool | None: Whether or not breakout sessions are enabled. If the value of enabledBreakoutSessions is false, users can not set breakout sessions. If the value of enabledBreakoutSessions is true, users can update breakout sessions using the Update Breakout Sessions API. Updating breakout sessions are not supported by this API.

tracking_codes: list[TrackingCodeItem] | None: 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.

audio_connection_options: AudioConnectionOptions | None: Audio connection options.

Bases: Meeting

enabled_breakout_sessions: bool | None: Whether or not breakout sessions are enabled.

links: list[LinkRelation] | None: HATEOAS Breakout Sessions information for meeting.

class wxc_sdk.meetings.ApprovalQuestion(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

last_name = 'lastName': If the value is lastName, this approval rule applies to the standard question of “Last Name”.

email = 'email': If the value is email, this approval rule applies to the standard question of “Email”.

job_title = 'jobTitle': If the value is jobTitle, this approval rule applies to the standard question of “Job Title”.

company_name = 'companyName': If the value is companyName, this approval rule applies to the standard question of “Company Name”.

address1 = 'address1': If the value is address1, this approval rule applies to the standard question of “Address 1”.

address2 = 'address2': If the value is address2, this approval rule applies to the standard question of “Address 2”.

city = 'city': If the value is city, this approval rule applies to the standard question of “City”.

state = 'state': If the value is state, this approval rule applies to the standard question of “State”.

zip_code = 'zipCode': If the value is zipCode, this approval rule applies to the standard question of “Zip/Post Code”.

country_region = 'countryRegion': If the value is countryRegion, this approval rule applies to the standard question of “Country Region”.

work_phone = 'workPhone': If the value is workPhone, this approval rule applies to the standard question of “Work Phone”.

fax = 'fax': If the value is fax, this approval rule applies to the standard question of “Fax”.

class wxc_sdk.meetings.QuestionAnswer(*, optionId: int | None = None, answer: str | None = None)[source]

Bases: ApiModel

option_id: int | None: Unique identifier for the question option. This attribute will be ingnored, if the value of type attribute is text or rating.

answer: str | None: The user’s answers for the question.

Bases: ApiModel

id: int | None: Unique identifier for the question.

question: str | None: Details for the question.

type: QuestionType | None: Type for the question.

from_score: int | None: The lowest score of the rating question. This attribute will be ingnored, if the value of type attribute is not rating.

from_label: str | None: The lowest score label of the rating question. This attribute will be ingnored, if the value of type attribute is not rating.

to_score: int | None: The highest score of the rating question. This attribute will be ingnored, if the value of type attribute is not rating.

to_label: str | None: The highest score label of the rating question. This attribute will be ingnored, if the value of type attribute is not rating.

options: list[QuestionOption] | None: Options for the question. This attribute will be ingnored, if the value of type attribute is text or rating.

class wxc_sdk.meetings.QuestionWithAnswers(*, id: int | None = None, question: str | None = None, type: QuestionType | None = None, answers: list[QuestionAnswer] | None = None)[source]

Bases: ApiModel

id: int | None: Unique identifier for the question.

question: str | None: Details for the question.

type: QuestionType | None: Type for the question.

answers: list[QuestionAnswer] | None: The user’s answers for the question.

Bases: ApiModel

auto_accept_request: bool | None: Whether or not meeting registration requests are accepted automatically.

require_first_name: bool | None: Whether or not a registrant’s first name is required for meeting registration.

require_last_name: bool | None: Whether or not a registrant’s last name is required for meeting registration.

require_email: bool | None: Whether or not a registrant’s email is required for meeting registration.

require_job_title: bool | None: Whether or not a registrant’s job title is required for meeting registration.

require_company_name: bool | None: Whether or not a registrant’s company name is required for meeting registration.

require_address1: bool | None: Whether or not a registrant’s first address field is required for meeting registration.

require_address2: bool | None: Whether or not a registrant’s second address field is required for meeting registration.

require_city: bool | None: Whether or not a registrant’s city is required for meeting registration.

require_state: bool | None: Whether or not a registrant’s state is required for meeting registration.

require_zip_code: bool | None: Whether or not a registrant’s postal code is required for meeting registration.

require_country_region: bool | None: Whether or not a registrant’s country or region is required for meeting registration.

require_work_phone: bool | None: Whether or not a registrant’s work phone number is required for meeting registration.

require_fax: bool | None: Whether or not a registrant’s fax number is required for meeting registration.

max_register_num: int | None: The maximum number of meeting registrations. Only applies to meetings. Webinars use a default value of 10000. If the maximum capacity of attendees for a webinar is less than 10000, e.g. 3000, then at most 3000 registrants can join this webinar.

customized_questions: list[CustomizedQuestionForCreateMeeting] | None: Customized questions for meeting registration.

rules: list[StandardRegistrationApproveRule] | None: The approval rules for standard questions.

class wxc_sdk.meetings.AutoRegistrationResult(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

approve = 'approve': If the user’s registration value meets the criteria, the registration form will be automatically approved.

reject = 'reject': If the user’s registration value meets the criteria, the registration form will be automatically rejected.

class wxc_sdk.meetings.ApprovalRule(*, condition: AnswerCondition | None = None, value: str | None = None, result: AutoRegistrationResult | None = None, matchCase: bool | None = None)[source]

Bases: ApiModel

condition: AnswerCondition | None: Judgment expression for approval rules.

value: str | None: The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.

result: AutoRegistrationResult | None: The automatic approval result for the approval rule.

match_case: bool | None: Whether to check the case of values.

Bases: ApiModel

id: str | None: 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_series_id: str | None: Unique identifier for meeting series. It only apples to scheduled meeting and meeting instance. If it’s a scheduled meeting from a series or a meeting instance that is happening or has happened, the meetingSeriesId is the id of the primary series.

scheduled_meeting_id: str | None: Unique identifier for scheduled meeting which current meeting is associated with. It only apples to meeting instance which is happening or has happened. It’s the id of the scheduled meeting this instance is associated with.

meeting_number: str | None: Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.

title: str | None: Meeting title. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

agenda: str | None: 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.

password: str | None: 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.

phone_and_video_system_password: str | None: 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: MeetingType | None: Meeting type.

state: MeetingState | None: Meeting state.

is_modified: bool | None: This state only applies to scheduled meeting. Flag identifying whether or not the scheduled meeting has been modified.

timezone: str | None: Time zone of start and end, conforming with the IANA time zone database.

start: str | None: Start time for meeting in ISO 8601 compliant format. If the meetingType of a meeting is meetingSeries, start is the scheduled start time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, start is the date and time the upcoming or ongoing meeting of the series starts. If the meetingType of a meeting is scheduledMeeting, start is the scheduled start time of this occurrence. If the meetingType of a meeting is meeting, start is the actual start time of the meeting instance. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

end: str | None: End time for a meeting in ISO 8601 compliant format. If the meetingType of a meeting is meetingSeries, end is the scheduled end time of the first occurrence of this series. If the meeting is a meeting series and the current filter is true, end is the date and time the upcoming or ongoing meeting of the series ends. If the meetingType of a meeting is scheduledMeeting, end is the scheduled end time of this occurrence. If the meetingType of a meeting is meeting, end is the actual end time of the meeting instance. If a meeting instance is in progress, end is not available. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

host_user_id: str | None: Unique identifier for the meeting host.

host_display_name: str | None: Display name for the meeting host.

host_email: str | None: Email address for the meeting host.

host_key: str | None: Key for joining the meeting as host.

site_url: str | None: Site URL for the meeting.

web_link: str | None: Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.

sip_address: str | None: SIP address for callback from a video system.

dial_in_ip_address: str | None: IP address for callback from a video system.

room_id: str | None: Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings.

enabled_auto_record_meeting: bool | None: Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.

allow_any_user_to_be_co_host: bool | None: 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.

enabled_join_before_host: bool | None: 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.

enable_connect_audio_before_host: bool | None: 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.

join_before_host_minutes: int | None: The 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. The joinBeforeHostMinutes attribute can be modified for meeting series or scheduled meeting by Update a Meeting API. Valid options are 0, 5, 10 and 15. Default is 0 if not specified.

exclude_password: bool | None: Whether or not to exclude the meeting password from the email invitation.

public_meeting: bool | None: Whether or not to allow the meeting to be listed on the public calendar.

reminder_time: int | None: The number of minutes before the meeting begins, that an email reminder is sent to the host.

unlocked_meeting_join_security: UnlockedMeetingJoinSecurity | None: Specifies how the people who aren’t on the invite can join the unlocked meeting.

session_type_id: int | None: 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.

scheduled_type: ScheduledType | None: Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user’s personal room.

enabled_webcast_view: bool | None: Whether or not webcast view is enabled.

panelist_password: str | None: Password for panelists of 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.

phone_and_video_system_panelist_password: str | None: 8-digit numeric panelist password to join webinar meeting from audio and video devices.

enable_automatic_lock: bool | None: Whether or not to automatically lock the meeting after it starts.

automatic_lock_minutes: int | None: The number of minutes after the meeting begins, for automatically locking it.

allow_first_user_to_be_co_host: bool | None: 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.

allow_authenticated_devices: bool | None: 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.

telephony: MeetingTelephony | None: Information for callbacks from a meeting to phone or for joining a teleconference using a phone.

meeting_options: MeetingOptions | None: Meeting Options.

attendee_privileges: AttendeePrivileges | None: Attendee Privileges.

registration: Registration | None: Meeting registration. When this option is enabled, meeting invitees must register personal information 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. + autoAcceptRequest: false (boolean,optional) - Whether or not meeting registration requests are accepted automatically.

integration_tags: list[str] | None: External keys created by an integration application in its domain, for example, Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc.

enabled_breakout_sessions: bool | None: Whether or not breakout sessions are enabled.

links: list[LinkRelation] | None: HATEOAS Breakout Sessions information for meeting.

tracking_codes: list[TrackingCodeItem] | None: Tracking codes information.

audio_connection_options: AudioConnectionOptions | None: Audio connection options.

class wxc_sdk.meetings.ScheduledType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

meeting = 'meeting': Set the value of scheduledType attribute to meeting for creating a regular meeting.

webinar = 'webinar': Set the value of scheduledType attribute to webinar for creating a webinar meeting.

personal_room_meeting = 'personalRoomMeeting': 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.

class wxc_sdk.meetings.MeetingService(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

all = 'All': Tracking codes apply to all services.

meeting_center = 'MeetingCenter': Users can set tracking codes when scheduling a meeting.

event_center = 'EventCenter': Users can set tracking codes when scheduling an event.

training_center = 'TrainingCenter': Users can set tracking codes when scheduling a training session.

support_center = 'SupportCenter': Users can set tracking codes when scheduling a support meeting.

class wxc_sdk.meetings.SimultaneousInterpretation(*, enabled: bool | None = None, interpreters: list[InterpreterForSimultaneousInterpretation] | None = None)[source]

Bases: ApiModel

enabled: bool | None: Whether or not simultaneous interpretation is enabled.

interpreters: list[InterpreterForSimultaneousInterpretation] | None: Interpreters for meeting.

Bases: ApprovalRule

question: ApprovalQuestion | None: Name for standard question.

order: int | None: The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together.

class wxc_sdk.meetings.MeetingState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

active = 'active': Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.

scheduled = 'scheduled': Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.

ready = 'ready': Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.

lobby = 'lobby': Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.

in_progress = 'inProgress': Applies to meeting series and meeting instances. For a meeting series, indicates that an instance of this series is happening now. For a meeting instance, indicates that the meeting has been joined and unlocked.

ended = 'ended': Applies to scheduled meetings and meeting instances. For scheduled meetings, indicates that the meeting was started and is now over. For meeting instances, indicates that the meeting instance has concluded.

missed = 'missed': This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.

expired = 'expired': This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.

Bases: ApiModel

id: str | None: Unique identifier for the survey result.

survey_name: str | None: Name for the survey.

meeting_id: str | None: Unique identifier for the meeting.

email: str | None: Email address of the user who submits the survey.

display_name: str | None: Name of the user who submits the survey.

create_time: str | None: The time when the user submits the survey.

questions: list[QuestionWithAnswers] | None: User’s answers for the questions

class wxc_sdk.meetings.MeetingTelephony(*, accessCode: str | None = None, callInNumbers: list[CallInNumbers] | None = None, links: list[LinkRelation] | None = None)[source]

Bases: ApiModel

access_code: str | None: 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.

call_in_numbers: list[CallInNumbers] | None: Array of call-in numbers for joining a teleconference from a phone.

links: list[LinkRelation] | None: HATEOAS information of global call-in numbers for joining a teleconference from a phone.

class wxc_sdk.meetings.TrackingCodeItem(*, name: str | None = None, value: str | None = None)[source]

Bases: ApiModel

name: str | None: Name of the tracking code. The name cannot be empty and the maximum size is 120 characters.

value: str | None: Value for the tracking code. value cannot be empty and the maximum size is 120 characters.

class wxc_sdk.meetings.Type(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

single_line_text_box = 'singleLineTextBox': Single line text box.

multi_line_text_box = 'multiLineTextBox': Multiple line text box.

checkbox = 'checkbox': Check box which requires options.

dropdown_list = 'dropdownList': Drop down list box which requires options.

radio_buttons = 'radioButtons': Single radio button which requires options.

class wxc_sdk.meetings.QuestionType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

text = 'text': Text input.

rating = 'rating': Rating.

checkbox = 'checkbox': Check box which requires options.

single_dropdown = 'singleDropdown': Drop down list box which requires options.

single_radio = 'singleRadio': Single radio button which requires options.

class wxc_sdk.meetings.TrackingCodeType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

optional = 'optional': Available to be chosen but not compulsory.

required = 'required': Officially compulsory.

admin_set = 'adminSet': The value is set by admin.

not_used = 'notUsed': The value cannot be used.

not_applicable = 'notApplicable': This value only applies to the service of All. When the type of All for a tracking code is notApplicable, there are different types for different services. For example, required for MeetingCenter, optional for EventCenter and notUsed for others.

class wxc_sdk.meetings.UnlockedMeetingJoinSecurity(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

allow_join = 'allowJoin': If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.

allow_join_with_lobby = 'allowJoinWithLobby': If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.

block_from_join = 'blockFromJoin': If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can’t join the unlocked meeting.

class wxc_sdk.meetings.MeetingsApi(session: RestSession)[source]

Bases: ApiChild

Meetings API

chats: MeetingChatsApi: meeting chats API

closed_captions: MeetingClosedCaptionsApi: closed captions API

invitees: MeetingInviteesApi: meeting invitees API

participants: MeetingParticipantsApi: meeting participants API

preferences: MeetingPreferencesApi: preferences API

qanda: MeetingQandAApi: Q and A API

qualities: MeetingQualitiesApi: qualities API

recordings: RecordingsApi

transcripts: MeetingTranscriptsApi: transcripts

Creates a new meeting. Regular users can schedule up to 100 meetings in 24 hours and admin users up to 3000.

Parameters:

title (str) – Meeting title. The title can be a maximum of 128 characters long.
agenda (str) – Meeting agenda. The agenda can be a maximum of 1300 characters long.
password (str) – Meeting password. Must conform to the site’s password complexity settings. Read password management for details.
start (str) – 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 24 hours. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, 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.
end (str) – 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 24 hours. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, 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.
timezone (str) – Time zone in which the meeting was originally scheduled (conforming with the IANA time zone database).
recurrence (str) – 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. 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”.
enabled_auto_record_meeting (bool) – Whether or not meeting is recorded automatically.
allow_any_user_to_be_co_host (bool) – 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 user’s preferred site.
enabled_join_before_host (bool) – Whether or not to allow any attendee to join the meeting before the host joins the meeting.
enable_connect_audio_before_host (bool) – 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.
join_before_host_minutes (int) – The 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 are 0, 5, 10 and 15. Default is 0 if not specified.
exclude_password (bool) – Whether or not to exclude the meeting password from the email invitation.
public_meeting (bool) – Whether or not to allow the meeting to be listed on the public calendar.
reminder_time (int) – The number of minutes before the meeting begins, that an email reminder is sent to the host.
unlocked_meeting_join_security (UnlockedMeetingJoinSecurity) – Specifies how the people who aren’t on the invite can join the unlocked meeting.
session_type_id (int) – Unique identifier for a meeting session type for the user. This attribute is required while scheduling webinar meeting. All available meeting session types enabled for the user can be retrieved by List Meeting Session Types API.
enabled_webcast_view (bool) – Whether or not webcast view is enabled.
panelist_password (str) – 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.
enable_automatic_lock (bool) – Whether or not to automatically lock the meeting after it starts.
automatic_lock_minutes (int) – The number of minutes after the meeting begins, for automatically locking it.
allow_first_user_to_be_co_host (bool) – 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.
allow_authenticated_devices (bool) – Whether or not to allow authenticated video devices in the meeting’s organization to start or join the meeting without a prompt.
send_email (bool) – Whether or not to send emails to host and invitees. It is an optional field and default value is true.
host_email (str) – 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.
site_url (str) – URL of the Webex site which the meeting is updated 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 (MeetingOptions) – Meeting Options.
attendee_privileges (AttendeePrivileges) – Attendee Privileges.
integration_tags (List[str]) – 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. Please note that an empty or null integrationTags will delete all existing integration tags for the meeting implicitly. Developer can update integration tags for a meetingSeries but he cannot update it for a scheduledMeeting or a meeting instance.
enabled_breakout_sessions (bool) – Whether or not breakout sessions are enabled. If the value of enabledBreakoutSessions is false, users can not set breakout sessions. If the value of enabledBreakoutSessions is true, users can update breakout sessions using the Update Breakout Sessions API. Updating breakout sessions are not supported by this API.
tracking_codes (TrackingCodeItem) – 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.
audio_connection_options (AudioConnectionOptions) – Audio connection options.
adhoc (bool) – Whether or not to create an ad-hoc meeting for the room specified by roomId. When true, roomId is required.
room_id (str) – 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.
template_id (str) – 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.
scheduled_type (ScheduledType) – 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.
invitees (InviteeForCreateMeeting) – 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.
registration (Registration) – Meeting registration. When this option is enabled, meeting invitees must register personal information 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. This parameter is ignored for an ad-hoc meeting.
simultaneous_interpretation (SimultaneousInterpretation) – Simultaneous interpretation information for a meeting.
breakout_sessions (BreakoutSession) – 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.

documentation: https://developer.webex.com/docs/api/v1/meetings/create-a-meeting

get(meeting_id: str, current: bool | None = None, host_email: str | None = None) → Meeting[source]

Retrieves details for a meeting with a specified meeting ID.

Parameters:

meeting_id (str) – Unique identifier for the meeting being requested.
current (bool) – Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it’s true, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it’s false or not specified, return details for the entire meeting series. This parameter only applies to meeting series.
host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting that is hosted by that user.

documentation: https://developer.webex.com/docs/api/v1/meetings/get-a-meeting

Retrieves details for meetings with a specified meeting number, web link, meeting type, etc. Please note that there are various products in the Webex Suite such as Meetings and Events. Currently, only meetings of the Meetings product are supported by this API, meetings of others in the suite are not supported. Ad-hoc meetings created by Create a Meeting with adhoc of true and a roomId will not be listed, but the ended and ongoing ad-hoc meeting instances will be listed.

Parameters:

meeting_number (str) – Meeting number for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive. If it’s an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.
web_link (str) – URL encoded link to information page for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive.
room_id (str) – Associated Webex space ID for the meeting objects being requested. meetingNumber, webLink and roomId are mutually exclusive.
meeting_type (str) – Meeting type for the meeting objects being requested. This parameter will be ignored if meetingNumber, webLink or roomId is specified. Possible values: meetingSeries, scheduledMeeting, meeting
state (str) – Meeting state for the meeting objects being requested. If not specified, return meetings of all states. This parameter will be ignored if meetingNumber, webLink or roomId is specified. Details of an ended meeting will only be available 15 minutes after the meeting has ended. inProgress meetings are not fully supported. The API will try to return details of an inProgress meeting 15 minutes after the meeting starts. However, it may take longer depending on the traffic. See the Webex Meetings guide for more information about the states of meetings. Possible values: active, scheduled, ready, lobby, inProgress, ended, missed, expired
scheduled_type (str) – Scheduled type for the meeting objects being requested. Possible values: meeting, webinar, personalRoomMeeting
current (bool) – Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where meetingNumber is specified and the meeting is not an exceptional meeting from a meeting series. If it’s true, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it’s false, return the entire meeting series.
from (str) – Start date and time (inclusive) in any ISO 8601 compliant format for the meeting objects being requested. from cannot be after to. This parameter will be ignored if meetingNumber, webLink or roomId is specified.
to (str) – End date and time (exclusive) in any ISO 8601 compliant format for the meeting objects being requested. to cannot be before from. This parameter will be ignored if meetingNumber, webLink or roomId is specified.
host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for meetings that are hosted by that user.
site_url (str) – URL of the Webex site which the API lists meetings from. If not specified, the API lists meetings from user’s all sites. All available Webex sites of the user can be retrieved by Get Site List API.
integration_tag (str) – External key created by an integration application. This parameter is used by the integration application to query meetings by a key in its own domain such as a Zendesk ticket ID, a Jira ID, a Salesforce Opportunity ID, etc.

documentation: https://developer.webex.com/docs/api/v1/meetings/list-meetings

base = 'meetings'

Lists scheduled meeting and meeting instances of a meeting series identified by meetingSeriesId. Scheduled meetings of an ad-hoc meeting created by Create a Meeting with adhoc of true and a roomId will not be listed, but the ended and ongoing meeting instances of it will be listed. Each scheduled meeting or meeting instance of a meeting series has its own start, end, etc. Thus, for example, when a daily meeting has been scheduled from 2019-04-01 to 2019-04-10, there are 10 scheduled meeting instances in this series, one instance for each day, and each one has its own attributes. When a scheduled meeting has been started and ended or is happening, there are even more ended or in-progress meeting instances. Use this operation to list scheduled meeting and meeting instances of a meeting series within a specific date range. Long result sets are split into pages. trackingCodes is not supported for ended meeting instances.

Parameters:

meeting_series_id (str) – Unique identifier for the meeting series. Please note that currently meeting ID of a scheduled personal room meeting is not supported for this API.
from (str) – Start date and time (inclusive) for the range for which meetings are to be returned in any ISO 8601 compliant format. from cannot be after to.
to (str) – End date and time (exclusive) for the range for which meetings are to be returned in any ISO 8601 compliant format. to cannot be before from.
meeting_type (str) – Meeting type for the meeting objects being requested. If not specified, return meetings of all types. Possible values: scheduledMeeting, meeting
state (str) – Meeting state for the meetings being requested. If not specified, return meetings of all states. Details of an ended meeting will only be available 15 minutes after the meeting has ended. inProgress meetings are not fully supported. The API will try to return details of an inProgress meeting 15 minutes after the meeting starts. However, it may take longer depending on the traffic. See the Webex Meetings guide for more information about the states of meetings. Possible values: scheduled, ready, lobby, inProgress, ended, missed
is_modified (bool) – Flag identifying whether or not only to retrieve scheduled meeting instances which have been modified. This parameter only applies to scheduled meetings. If it’s true, only return modified scheduled meetings; if it’s false, only return unmodified scheduled meetings; if not specified, all scheduled meetings will be returned.
host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return meetings that are hosted by that user.

documentation: https://developer.webex.com/docs/api/v1/meetings/list-meetings-of-a-meeting-series

Updates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances. Ad-hoc meetings created by Create a Meeting with adhoc of true and a roomId cannot be updated.

Parameters:

meeting_id (str) – Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled personal room meeting is not supported for this API.
title (str) – Meeting title. The title can be a maximum of 128 characters long.
agenda (str) – Meeting agenda. The agenda can be a maximum of 1300 characters long.
password (str) – Meeting password. Must conform to the site’s password complexity settings. Read password management for details.
start (str) – 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 24 hours. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, 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.
end (str) – 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 24 hours. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, 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.
timezone (str) – Time zone in which the meeting was originally scheduled (conforming with the IANA time zone database).
recurrence (str) – 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. 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”.
enabled_auto_record_meeting (bool) – Whether or not meeting is recorded automatically.
allow_any_user_to_be_co_host (bool) – 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 user’s preferred site.
enabled_join_before_host (bool) – Whether or not to allow any attendee to join the meeting before the host joins the meeting.
enable_connect_audio_before_host (bool) – 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.
join_before_host_minutes (int) – The 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 are 0, 5, 10 and 15. Default is 0 if not specified.
exclude_password (bool) – Whether or not to exclude the meeting password from the email invitation.
public_meeting (bool) – Whether or not to allow the meeting to be listed on the public calendar.
reminder_time (int) – The number of minutes before the meeting begins, that an email reminder is sent to the host.
unlocked_meeting_join_security (UnlockedMeetingJoinSecurity) – Specifies how the people who aren’t on the invite can join the unlocked meeting.
session_type_id (int) – Unique identifier for a meeting session type for the user. This attribute is required while scheduling webinar meeting. All available meeting session types enabled for the user can be retrieved by List Meeting Session Types API.
enabled_webcast_view (bool) – Whether or not webcast view is enabled.
panelist_password (str) – 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.
enable_automatic_lock (bool) – Whether or not to automatically lock the meeting after it starts.
automatic_lock_minutes (int) – The number of minutes after the meeting begins, for automatically locking it.
allow_first_user_to_be_co_host (bool) – 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.
allow_authenticated_devices (bool) – Whether or not to allow authenticated video devices in the meeting’s organization to start or join the meeting without a prompt.
send_email (bool) – Whether or not to send emails to host and invitees. It is an optional field and default value is true.
host_email (str) – 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.
site_url (str) – URL of the Webex site which the meeting is updated 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 (MeetingOptions) – Meeting Options.
attendee_privileges (AttendeePrivileges) – Attendee Privileges.
integration_tags (List[str]) – 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. Please note that an empty or null integrationTags will delete all existing integration tags for the meeting implicitly. Developer can update integration tags for a meetingSeries but he cannot update it for a scheduledMeeting or a meeting instance.
enabled_breakout_sessions (bool) – Whether or not breakout sessions are enabled. If the value of enabledBreakoutSessions is false, users can not set breakout sessions. If the value of enabledBreakoutSessions is true, users can update breakout sessions using the Update Breakout Sessions API. Updating breakout sessions are not supported by this API.
tracking_codes (TrackingCodeItem) – 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.
audio_connection_options (AudioConnectionOptions) – Audio connection options.

documentation: https://developer.webex.com/docs/api/v1/meetings/patch-a-meeting

Updates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances. Ad-hoc meetings created by Create a Meeting with adhoc of true and a roomId cannot be updated.

Parameters:

meeting_id (str) – Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled personal room meeting is not supported for this API.
title (str) – Meeting title. The title can be a maximum of 128 characters long.
agenda (str) – Meeting agenda. The agenda can be a maximum of 1300 characters long.
password (str) – Meeting password. Must conform to the site’s password complexity settings. Read password management for details.
start (str) – 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 24 hours. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, 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.
end (str) – 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 24 hours. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, 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.
timezone (str) – Time zone in which the meeting was originally scheduled (conforming with the IANA time zone database).
recurrence (str) – 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. 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”.
enabled_auto_record_meeting (bool) – Whether or not meeting is recorded automatically.
allow_any_user_to_be_co_host (bool) – 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 user’s preferred site.
enabled_join_before_host (bool) – Whether or not to allow any attendee to join the meeting before the host joins the meeting.
enable_connect_audio_before_host (bool) – 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.
join_before_host_minutes (int) – The 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 are 0, 5, 10 and 15. Default is 0 if not specified.
exclude_password (bool) – Whether or not to exclude the meeting password from the email invitation.
public_meeting (bool) – Whether or not to allow the meeting to be listed on the public calendar.
reminder_time (int) – The number of minutes before the meeting begins, that an email reminder is sent to the host.
unlocked_meeting_join_security (UnlockedMeetingJoinSecurity) – Specifies how the people who aren’t on the invite can join the unlocked meeting.
session_type_id (int) – Unique identifier for a meeting session type for the user. This attribute is required while scheduling webinar meeting. All available meeting session types enabled for the user can be retrieved by List Meeting Session Types API.
enabled_webcast_view (bool) – Whether or not webcast view is enabled.
panelist_password (str) – 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.
enable_automatic_lock (bool) – Whether or not to automatically lock the meeting after it starts.
automatic_lock_minutes (int) – The number of minutes after the meeting begins, for automatically locking it.
allow_first_user_to_be_co_host (bool) – 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.
allow_authenticated_devices (bool) – Whether or not to allow authenticated video devices in the meeting’s organization to start or join the meeting without a prompt.
send_email (bool) – Whether or not to send emails to host and invitees. It is an optional field and default value is true.
host_email (str) – 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.
site_url (str) – URL of the Webex site which the meeting is updated 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 (MeetingOptions) – Meeting Options.
attendee_privileges (AttendeePrivileges) – Attendee Privileges.
integration_tags (List[str]) – 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. Please note that an empty or null integrationTags will delete all existing integration tags for the meeting implicitly. Developer can update integration tags for a meetingSeries but he cannot update it for a scheduledMeeting or a meeting instance.
enabled_breakout_sessions (bool) – Whether or not breakout sessions are enabled. If the value of enabledBreakoutSessions is false, users can not set breakout sessions. If the value of enabledBreakoutSessions is true, users can update breakout sessions using the Update Breakout Sessions API. Updating breakout sessions are not supported by this API.
tracking_codes (TrackingCodeItem) – 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.
audio_connection_options (AudioConnectionOptions) – Audio connection options.

documentation: https://developer.webex.com/docs/api/v1/meetings/update-a-meeting

delete(meeting_id: str, host_email: str | None = None, send_email: bool | None = None)[source]

Deletes a meeting with a specified meeting ID. The deleted meeting cannot be recovered. This operation applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances. Ad-hoc meetings created by Create a Meeting with adhoc of true and a roomId cannot be deleted.

Parameters:

meeting_id (str) – Unique identifier for the meeting to be deleted. This parameter applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances.
host_email (str) – Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will delete a meeting that is hosted by that user.
send_email (bool) – Whether or not to send emails to host and invitees. It is an optional field and default value is true.

documentation: https://developer.webex.com/docs/api/v1/meetings/delete-a-meeting

Retrieves a meeting join link for a meeting with a specified meetingId, meetingNumber, or webLink that allows users to join the meeting directly without logging in and entering a password.

Parameters:

meeting_id (str) – Unique identifier for the meeting. This parameter applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled personal room meeting is also supported for this API.
meeting_number (str) – Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.
web_link (str) – Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.
join_directly (bool) – Whether or not to redirect to joinLink. It is an optional field and default value is true.
email (str) – Email address of meeting participant. If the user is a guest issuer, email is required.
display_name (str) – Display name of meeting participant. The maximum length of displayName is 128 characters. If the user is a guest issuer, displayName is required.
password (str) – It’s required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost or invitee of the meeting.
expiration_minutes (int) – Expiration duration of joinLink in minutes. Must be between 1 and 60.

documentation: https://developer.webex.com/docs/api/v1/meetings/join-a-meeting

update_simultaneous_interpretation(meeting_id: str, enabled: bool, interpreters: InterpreterForSimultaneousInterpretation | None = None) → SimultaneousInterpretation[source]

Updates simultaneous interpretation options of a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances.

Parameters:

meeting_id (str) – Unique identifier for the meeting. Does not support meeting IDs for a scheduled personal room meeting.
enabled (bool) – Whether or not simultaneous interpretation is enabled.
interpreters (InterpreterForSimultaneousInterpretation) – Interpreters for meeting.

documentation: https://developer.webex.com/docs/api/v1/meetings/update-meeting-simultaneous-interpretation

survey(meeting_id: str) → GetMeetingSurveyResponse[source]

Retrieves details for a meeting survey identified by meetingId.

Parameters:: meeting_id (str) – Unique identifier for the meeting. Please note that only the meeting ID of a scheduled webinar is supported for this API.

documentation: https://developer.webex.com/docs/api/v1/meetings/get-a-meeting-survey

list_survey_results(meeting_id: str, meeting_start_time_from: str | None = None, meeting_start_time_to: str | None = None, **params) → Generator[SurveyResult, None, None][source]

Retrieves results for a meeting survey identified by meetingId.

Parameters:

meeting_id (str) – Unique identifier for the meeting. Please note that only the meeting ID of a scheduled webinar is supported for this API.
meeting_start_time_from (str) – Start date and time (inclusive) in any ISO 8601 compliant format for the meeting objects being requested. meetingStartTimeFrom cannot be after meetingStartTimeTo. This parameter will be ignored if meetingId is the unique identifier for the specific meeting instance. When meetingId is not the unique identifier for the specific meeting instance, the meetingStartTimeFrom, if not specified, equals meetingStartTimeTo minus 1 month; if meetingStartTimeTo is also not specified, the default value for meetingStartTimeFrom is 1 month before the current date and time.
meeting_start_time_to (str) – End date and time (exclusive) in any ISO 8601 compliant format for the meeting objects being requested. meetingStartTimeTo cannot be prior to meetingStartTimeFrom. This parameter will be ignored if meetingId is the unique identifier for the specific meeting instance. When meetingId is not the unique identifier for the specific meeting instance, if meetingStartTimeFrom is also not specified, the default value for meetingStartTimeTo is the current date and time;For example,if meetingStartTimeFrom is a month ago, the default value for meetingStartTimeTo is 1 month after meetingStartTimeFrom.Otherwise it is the current date and time.

documentation: https://developer.webex.com/docs/api/v1/meetings/list-meeting-survey-results

list_tracking_codes(service: str, site_url: str | None = None, host_email: str | None = None) → Generator[TrackingCode, None, None][source]

Lists tracking codes on a site by a meeting host. The result indicates which tracking codes and what options can be used to create or update a meeting on the specified site.

Parameters:

service (str) – Service for schedule or sign-up pages.
site_url (str) – URL of the Webex site which the API retrieves the tracking code from. If not specified, the API retrieves the tracking code from the user’s preferred site. All available Webex sites and preferred sites of a user can be retrieved by Get Site List API.
host_email (str) – Email address for the meeting host. This parameter is only used if a user or application calling the API has the admin-level scopes. The admin may specify the email of a user on a site they manage and the API will return meeting participants of the meetings that are hosted by that user.

documentation: https://developer.webex.com/docs/api/v1/meetings/list-meeting-tracking-codes

Bases: PatchMeetingBody

adhoc: bool | None: Whether or not to create an ad-hoc meeting for the room specified by roomId. When true, roomId is required.

room_id: str | None: 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.

template_id: str | None: 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.

scheduled_type: ScheduledType | None: 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.

invitees: list[InviteeForCreateMeeting] | None: 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.

registration: Registration | None: Meeting registration. When this option is enabled, meeting invitees must register personal information 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. This parameter is ignored for an ad-hoc meeting.

simultaneous_interpretation: SimultaneousInterpretation | None: Simultaneous interpretation information for a meeting.

breakout_sessions: list[BreakoutSession] | None: 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.

Bases: ApiModel

meeting_id: str | None: Unique identifier for the meeting. This parameter applies to meeting series and scheduled meetings. It doesn’t apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled personal room meeting is also supported for this API.

meeting_number: str | None: Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.

web_link: str | None: Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.

join_directly: bool | None: Whether or not to redirect to joinLink. It is an optional field and default value is true.

email: str | None: Email address of meeting participant. If the user is a guest issuer, email is required.

display_name: str | None: Display name of meeting participant. The maximum length of displayName is 128 characters. If the user is a guest issuer, displayName is required.

password: str | None: It’s required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost or invitee of the meeting.

expiration_minutes: int | None: Expiration duration of joinLink in minutes. Must be between 1 and 60.

wxc_sdk.meetings package

Subpackages