wxc_sdk.meetings.preferences package

Meetings preferences API

class wxc_sdk.meetings.preferences.Audio(*, defaultAudioType: DefaultAudioType | None = None, otherTeleconferenceDescription: str | None = None, enabledGlobalCallIn: bool | None = None, enabledTollFree: bool | None = None, enabledAutoConnection: bool | None = None, audioPin: str | None = None, officeNumber: OfficeNumber | None = None, mobileNumber: OfficeNumber | None = None)[source]

Bases: ApiModel

default_audio_type: DefaultAudioType | None: Default audio type. This attribute can be modified with the with the Update Audio Options API.

other_teleconference_description: str | None: Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified with the with the Update Audio Options API.

enabled_global_call_in: bool | None

If the site does not support global call-ins, you cannot set this option. This attribute can be modified with the with the Update Audio Options API.

Type:: Flag to enable/disable global call ins. Note

enabled_toll_free: bool | None

If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified with the with the Update Audio Options API.

Type:: Flag to enable/disable call-ins from toll-free numbers. Note

enabled_auto_connection: bool | None: Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to true, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. This attribute can be modified with the Update Audio Options API.

audio_pin: str | None: PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified with the with the Update Audio Options API.

office_number: OfficeNumber | None: Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the Update Audio Options API.

mobile_number: OfficeNumber | None: Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the Update Audio Options API.

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

Bases: ApiModel

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

call_in_number: str | None: Call-in number to join 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.preferences.CoHost(*, email: str | None = None, displayName: str | None = None)[source]

Bases: ApiModel

email: str | None: Email address for cohost. This attribute can be modified with the Update Personal Meeting Room Options API. Possible values: john.andersen@example.com

display_name: str | None: Display name for cohost. This attribute can be modified with the Update Personal Meeting Room Options API. Possible values: John Andersen

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

Bases: str, SafeEnum

An enumeration.

webex_audio = 'webexAudio': Webex audio. This supports telephony and VoIP.

voip_only = 'voipOnly': Support only VoIP.

other_teleconference_service = 'otherTeleconferenceService': Other teleconference service. Details are defined in the otherTeleconferenceDescription parameter.

none = 'none': No audio.

class wxc_sdk.meetings.preferences.MeetingPreferenceDetails(*, personalMeetingRoom: PersonalMeetingRoom | None = None, audio: Audio | None = None, video: Video | None = None, schedulingOptions: SchedulingOptions | None = None, sites: list[MeetingsSite] | None = None)[source]

Bases: ApiModel

personal_meeting_room: PersonalMeetingRoom | None: Personal Meeting Room options.

audio: Audio | None

These audio settings do not apply to Personal Room meetings

Type:: Audio Preferences. Note

video: Video | None

The Call My Video System feature is available only if it has been purchased for your site and your administrator has enabled it.

Type:: Information for video conferencing systems used to connect to Webex meetings. Note

scheduling_options: SchedulingOptions | None: Meeting scheduling options.

sites: list[MeetingsSite] | None: List of user’s Webex meeting sites including default site.

Bases: UpdatePersonalMeetingRoomOptionsBody

personal_meeting_room_link: str | None

This is a read-only attribute.

Type:: Personal Meeting Room link. It cannot be empty. Note

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.

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

class wxc_sdk.meetings.preferences.VideoOptions(*, videoDevices: list[VideoDevice] | None = None)[source]

Bases: ApiModel

video_devices: list[VideoDevice] | None: Array of video devices. This attribute can be modified with the Update Video Options API.

class wxc_sdk.meetings.preferences.MeetingPreferencesApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

This API manages a user’s meeting preferences, including Personal Meeting Room settings, video and audio settings, meeting scheduling options, and site settings. Refer to the Meetings API Scopes section of Meetings Overview for scopes required for each API.

details(user_email: str | None = None, site_url: str | None = None) → MeetingPreferenceDetails[source]

Retrieves meeting preferences for the authenticated user.

Parameters:

user_email (str) – Email address for the user. This parameter is only used if the user or application calling the API has the required 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 of the meeting preferences for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved from /meetingPreferences/sites.

personal_meeting_room_options(user_email: str | None = None, site_url: str | None = None) → PersonalMeetingRoomOptions[source]

Retrieves the Personal Meeting Room options for the authenticated user.

Parameters:

user_email (str) – Email address for the user. 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 of the Personal Meeting Room options for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved from /meetingPreferences/sites.

update_personal_meeting_room_options(topic: str, host_pin: str, enabled_auto_lock: bool, auto_lock_minutes: int, enabled_notify_host: bool, support_co_host: bool, co_hosts: CoHost, user_email: str | None = None, site_url: str | None = None, support_anyone_as_co_host: bool | None = None, allow_first_user_to_be_co_host: bool | None = None, allow_authenticated_devices: bool | None = None) → PersonalMeetingRoomOptions[source]

Update a single meeting

Parameters:

topic (str) – Personal Meeting Room topic to be updated.
host_pin (str) – Updated PIN for joining the room as host. The host PIN must be digits of a predefined length, e.g. 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeated digits of the predefined length, such as 1111. The predefined length for host PIN can be viewed in user’s My Personal Room page and it can only be changed by site administrator.
enabled_auto_lock (bool) – Update for option to automatically lock the Personal Room a number of minutes after a meeting starts. When a room is locked, invitees cannot enter until the owner admits them. The period after which the meeting is locked is defined by autoLockMinutes.
auto_lock_minutes (int) – Updated number of minutes after which the Personal Room is locked if enabledAutoLock is enabled. Valid options are 0, 5, 10, 15 and 20.
enabled_notify_host (bool) – Update for flag to enable notifying the owner of a Personal Room when someone enters the Personal Room lobby while the owner is not in the room.
support_co_host (bool) – Update for flag allowing other invitees to host a meetingCoHost in the Personal Room without the owner.
co_hosts (CoHost) – Updated array defining cohosts for the room if both supportAnyoneAsCoHost and allowFirstUserToBeCoHost are false
user_email (str) – Email address for the user. 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 update Personal Meeting Room options for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved from /meetingPreferences/sites.
support_anyone_as_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 Personal Room. The target site is user’s preferred site.
allow_first_user_to_be_co_host (bool) – Whether or not to allow the first attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user’s preferred site.
allow_authenticated_devices (bool) – Whether or not to allow authenticated video devices in the user’s organization to start or join the meeting without a prompt.

audio_options(user_email: str | None = None, site_url: str | None = None) → Audio[source]

Retrieves audio options for the authenticated user.

Parameters:

user_email (str) – Email address for the user. 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 of the audio options for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved from /meetingPreferences/sites.

Updates audio options for the authenticated user.

Parameters:

user_email (str) – Email address for the user. 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 update audio options for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved from /meetingPreferences/sites.
default_audio_type (DefaultAudioType) – Default audio type. This attribute can be modified with the with the Update Audio Options API.
other_teleconference_description (str) – Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified with the with the Update Audio Options API.
enabled_global_call_in (bool) – Flag to enable/disable global call ins. Note: If the site does not support global call-ins, you cannot set this option. This attribute can be modified with the with the Update Audio Options API.
enabled_toll_free (bool) – Flag to enable/disable call-ins from toll-free numbers. Note: If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified with the with the Update Audio Options API.
enabled_auto_connection (bool) – Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to true, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. This attribute can be modified with the Update Audio Options API.
audio_pin (str) – PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified with the with the Update Audio Options API.
office_number (OfficeNumber) – Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the Update Audio Options API.
mobile_number (OfficeNumber) – Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified with the with the Update Audio Options API.

video_options(user_email: str | None = None, site_url: str | None = None) → list[VideoDevice][source]

Retrieves video options for the authenticated user.

Parameters:

user_email (str) – Email address for the user. 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 of the video options for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved using Get Site List.

update_video_options(video_devices: VideoDevice, user_email: str | None = None, site_url: str | None = None) → list[VideoDevice][source]

Updates video options for the authenticated user.

Parameters:

video_devices (VideoDevice) – Array of video devices. If the array is not empty, one device and no more than one devices must be set as default device.
user_email (str) – Email address for the user. 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 update video options for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved from /meetingPreferences/sites.

scheduling_options(user_email: str | None = None, site_url: str | None = None) → SchedulingOptions[source]

Retrieves scheduling options for the authenticated user.

Parameters:

user_email (str) – Email address for the user. 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 of the scheduling options for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved from /meetingPreferences/sites.

update_scheduling_options(user_email: str | None = None, site_url: str | None = None, enabled_join_before_host: bool | None = None, join_before_host_minutes: int | None = None, enabled_auto_share_recording: bool | None = None, enabled_webex_assistant_by_default: bool | None = None) → SchedulingOptions[source]

Updates scheduling options for the authenticated user.

Parameters:

user_email (str) – Email address for the user. 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 update scheduling options for that user.
site_url (str) – URL of the Webex site to query. For individual use, if siteUrl is not specified, the query will use the default site of the user. For admin use, if siteUrl is not specified, the query will use the default site for the admin’s authorization token used to make the call. In the case where the user belongs to a site different than the admin’s default site, the admin can set the site to query using the siteUrl parameter. All available Webex sites and default site of a user can be retrieved from /meetingPreferences/sites.
enabled_join_before_host (bool) – Flag to enable/disable Join Before Host. The period during which invitees can join before the start time is defined by autoLockMinutes. This attribute can be modified with the Update Scheduling Options API. Note: This feature is only effective if the site supports the Join Before Host feature. This attribute can be modified with the Update Scheduling Options API.
join_before_host_minutes (int) – Number of minutes before the start time that an invitee can join a meeting if enabledJoinBeforeHost is true. Valid options are 0, 5, 10 and 15. This attribute can be modified with the Update Scheduling Options API.
enabled_auto_share_recording (bool) – Flag to enable/disable the automatic sharing of the meeting recording with invitees when it is available. This attribute can be modified with the Update Scheduling Options API.
enabled_webex_assistant_by_default (bool) – Flag to automatically enable Webex Assistant whenever you start a meeting. This attribute can be modified with the Update Scheduling Options API.

site_list(user_email: str | None = None) → list[MeetingsSite][source]

Retrieves the list of Webex sites that the authenticated user is set up to use.

Parameters:: user_email (str) – Email address for the user. 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 and the API will return the list of Webex sites for that user.

update_default_site(default_site: bool, site_url: str, user_email: str | None = None) → MeetingsSite[source]

Updates the default site for the authenticated user.

Parameters:

default_site (bool) – Whether or not to change user’s default site. Note: defaultSite should be set to true for the user’s single default site
site_url (str) – Access URL for the site.
user_email (str) – Email address for the user. 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 update default site for that user.

base = 'meetingPreferences'

class wxc_sdk.meetings.preferences.OfficeNumber(*, countryCode: str | None = None, number: str | None = None, enabledCallInAuthentication: bool | None = None, enabledCallMe: bool | None = None)[source]

Bases: ApiModel

country_code: str | None: Country code for the phone number. This attribute can be modified with the with the Update Audio Options API.

number: str | None: Phone number. It cannot be longer than 30 characters. This attribute can be modified with the with the Update Audio Options API.

enabled_call_in_authentication: bool | None: Flag identifying the phone number as the one that will be used to dial into a teleconference. This attribute can be modified with the with the Update Audio Options API.

enabled_call_me: bool | None: Flag to enable/disable Call Me number display on the meeting client. This attribute can be modified with the with the Update Audio Options API. Note: This feature is only effective if the site supports the Call Me feature.

Bases: ApiModel

topic: str | None: Personal Meeting Room topic. The length of topic must be between 1 and 128 characters. This attribute can be modified with the Update Personal Meeting Room Options API.

host_pin: str | None: PIN for joining the room as host. The host PIN must be digits of a predefined length, e.g. 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeated digits of the predefined length, such as 1111. The predefined length for host PIN can be viewed in user’s My Personal Room page. This attribute can be modified with the Update Personal Meeting Room Options API.

personal_meeting_room_link: str | None

This is a read-only attribute.

Type:: Personal Meeting Room link. It cannot be empty. Note

enabled_auto_lock: bool | None: Option to automatically lock the Personal Room a number of minutes after a meeting starts. When a room is locked, invitees cannot enter until the owner admits them. The period after which the meeting is locked is defined by autoLockMinutes. This attribute can be modified with the Update Personal Meeting Room Options API.

auto_lock_minutes: int | None: Number of minutes after which the Personal Room is locked if enabledAutoLock is enabled. Valid options are 0, 5, 10, 15 and 20. This attribute can be modified with the Update Personal Meeting Room Options API.

enabled_notify_host: bool | None: Flag to enable notifying the owner of a Personal Room when someone enters the Personal Room lobby while the owner is not in the room. This attribute can be modified with the Update Personal Meeting Room Options API.

support_co_host: bool | None: Flag allowing other invitees to host a meeting in the Personal Room without the owner. This attribute can be modified with the Update Personal Meeting Room Options API.

support_anyone_as_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 Personal Room. The target site is user’s preferred site. This attribute can be modified with the Update Personal Meeting Room Options API.

allow_first_user_to_be_co_host: bool | None: Whether or not to allow the first attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user’s preferred site. This attribute can be modified with the Update Personal Meeting Room Options API.

allow_authenticated_devices: bool | None: Whether or not to allow authenticated video devices in the user’s organization to start or join the meeting without a prompt. This attribute can be modified with the Update Personal Meeting Room Options API.

co_hosts: list[CoHost] | None: Array defining cohosts for the room if both supportAnyoneAsCoHost and allowFirstUserToBeCoHost are false This attribute can be modified with the Update Personal Meeting Room Options API.

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.

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

class wxc_sdk.meetings.preferences.SchedulingOptions(*, enabledJoinBeforeHost: bool | None = None, joinBeforeHostMinutes: int | None = None, enabledAutoShareRecording: bool | None = None, enabledWebexAssistantByDefault: bool | None = None)[source]

Bases: ApiModel

enabled_join_before_host: bool | None: Flag to enable/disable Join Before Host. The period during which invitees can join before the start time is defined by autoLockMinutes. This attribute can be modified with the Update Scheduling Options API. Note: This feature is only effective if the site supports the Join Before Host feature. This attribute can be modified with the Update Scheduling Options API.

join_before_host_minutes: int | None: Number of minutes before the start time that an invitee can join a meeting if enabledJoinBeforeHost is true. Valid options are 0, 5, 10 and 15. This attribute can be modified with the Update Scheduling Options API.

enabled_auto_share_recording: bool | None: Flag to enable/disable the automatic sharing of the meeting recording with invitees when it is available. This attribute can be modified with the Update Scheduling Options API.

enabled_webex_assistant_by_default: bool | None: Flag to automatically enable Webex Assistant whenever you start a meeting. This attribute can be modified with the Update Scheduling Options API.

class wxc_sdk.meetings.preferences.MeetingsSite(*, siteUrl: str | None = None, default: bool | None = None)[source]

Bases: ApiModel

site_url: str | None

This is a read-only attribute. The value can be assigned as user’s default site with the Update Default Site API. Possible values: site1-example.webex.com

Type:: Access URL for the site. Note

default: bool | None: Flag identifying the site as the default site. Users can list meetings and recordings, and create meetings on the default site. Possible values:

class wxc_sdk.meetings.preferences.Telephony(*, accessCode: str | None = None, callInNumbers: list[CallInNumber] | 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[CallInNumber] | None: Array of call-in numbers for joining teleconference from a phone.

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

class wxc_sdk.meetings.preferences.UpdatePersonalMeetingRoomOptionsBody(*, topic: str | None = None, hostPin: str | None = None, enabledAutoLock: bool | None = None, autoLockMinutes: int | None = None, enabledNotifyHost: bool | None = None, supportCoHost: bool | None = None, supportAnyoneAsCoHost: bool | None = None, allowFirstUserToBeCoHost: bool | None = None, allowAuthenticatedDevices: bool | None = None, coHosts: list[CoHost] | None = None)[source]

Bases: ApiModel

topic: str | None: Personal Meeting Room topic to be updated.

host_pin: str | None: Updated PIN for joining the room as host. The host PIN must be digits of a predefined length, e.g. 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeated digits of the predefined length, such as 1111. The predefined length for host PIN can be viewed in user’s My Personal Room page and it can only be changed by site administrator.

enabled_auto_lock: bool | None: Update for option to automatically lock the Personal Room a number of minutes after a meeting starts. When a room is locked, invitees cannot enter until the owner admits them. The period after which the meeting is locked is defined by autoLockMinutes.

auto_lock_minutes: int | None: Updated number of minutes after which the Personal Room is locked if enabledAutoLock is enabled. Valid options are 0, 5, 10, 15 and 20.

enabled_notify_host: bool | None: Update for flag to enable notifying the owner of a Personal Room when someone enters the Personal Room lobby while the owner is not in the room.

support_co_host: bool | None: Update for flag allowing other invitees to host a meetingCoHost in the Personal Room without the owner.

support_anyone_as_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 Personal Room. The target site is user’s preferred site.

allow_first_user_to_be_co_host: bool | None: Whether or not to allow the first attendee with a host account on the target site to become a cohost when joining the Personal Room. The target site is user’s preferred site.

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

co_hosts: list[CoHost] | None: Updated array defining cohosts for the room if both supportAnyoneAsCoHost and allowFirstUserToBeCoHost are false

class wxc_sdk.meetings.preferences.Video(*, videoDevices: list[VideoDevice] | None = None)[source]

Bases: ApiModel

video_devices: list[VideoDevice] | None: Array of video devices. This attribute can be modified with the Update Video Options API.

class wxc_sdk.meetings.preferences.VideoDevice(*, deviceName: str | None = None, deviceAddress: str | None = None, isDefault: bool | None = None)[source]

Bases: ApiModel

device_name: str | None: Video system name. It cannot be empty. This attribute can be modified with the Update Video Options API. Possible values: device1

device_address: str | None: Video address. It cannot be empty and must be in valid email format. This attribute can be modified with the Update Video Options API. Possible values: device1@example.com

is_default: bool | None: Flag identifying the device as the default video device. If user’s video device list is not empty, one and only one device must be set as default. This attribute can be modified with the Update Video Options API. Possible values:

class wxc_sdk.meetings.preferences.UpdateDefaultSiteBody(*, siteUrl: str | None = None)[source]

Bases: ApiModel

site_url: str | None: Access URL for the site.