wxc_sdk.me.hoteling package

class wxc_sdk.me.hoteling.MeHotelingApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

get_available_hosts(name: str = None, phone_number: str = None, **params: Any) → Generator[AvailableHotelingHost, None, None][source]

Get Available Hoteling Hosts

Retrieve a list of available hoteling hosts that a person can associate with as a guest. Returns hosts that have hoteling enabled on their devices and are available for guest associations. The list can be filtered by name or phone number and supports pagination.

Hoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

  • name (str) – Filter hosts by name (first name or last name). Partial match is supported.

  • phone_number (str) – Filter hosts by phone number. Partial match is supported.

Returns:

Generator yielding AvailableHotelingHost instances

get_guest_settings() → HotelingGuestSettings[source]

Get Hoteling Guest Settings

Retrieve hoteling guest settings for a person. Hoteling allows a person to temporarily use a device as a guest, associating their extension and configuration with that device for a limited time. This API returns the current hoteling guest configuration including any active host association details.

Hoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.

This API requires a user auth token with a scope of spark:telephony_config_read.

Return type:

HotelingGuestSettings

update_guest_settings(settings: HotelingGuestSettings) → None[source]

Update Hoteling Guest Settings

Update hoteling guest settings for a person. Allows enabling or disabling the ability to use hoteling as a guest, configuring whether an association will be removed automatically after a specified time period, and associating with a hoteling host.

Hoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

settings (HotelingGuestSettings) – Hoteling settings to update

Return type:

None

base = 'telephony/config/people/me'
class wxc_sdk.me.hoteling.AvailableHotelingHost(*, hostId: str | None = None, firstName: str | None = None, lastName: str | None = None, phoneNumber: str | None = None, extension: str | None = None, allowedAssociationDuration: int | None = None, **extra_data: Any)[source]

Bases: ApiModel

host_id: str | None

Unique identifier for the person or workspace.

first_name: str | None

First name of the hoteling host.

last_name: str | None

Last name of the hoteling host.

phone_number: str | None

Phone number of the hoteling host.

extension: str | None

Extension of the hoteling host.

allowed_association_duration: int | None

Maximum allowed association duration in hours for this host.

class wxc_sdk.me.hoteling.HotelingGuestSettings(*, enabled: bool | None = None, associationLimitEnabled: bool | None = None, associationLimitHours: int | None = None, hostAssociationLimitHours: int | None = None, hostEnforcedAssociationLimitEnabled: bool | None = None, hostFirstName: str | None = None, hostLastName: str | None = None, hostId: str | None = None, hostPhoneNumber: str | None = None, hostExtension: str | None = None, hostLocation: IdAndName | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

Enable/Disable hoteling guest functionality for the person. When enabled, the person can associate themselves with a hoteling host device.

association_limit_enabled: bool | None

When enabled, the person’s hoteling guest association will be automatically removed after the specified time period.

association_limit_hours: int | None

Time limit in hours for the hoteling guest association (1-999). Applicable when associationLimitEnabled is true.

host_association_limit_hours: int | None

Time limit in hours configured by the host for guest associations.

host_enforced_association_limit_enabled: bool | None

Indicates whether the host has enforced an association time limit.

host_first_name: str | None

First name of the hoteling host.

host_last_name: str | None

Last name of the hoteling host.

host_id: str | None

Unique identifier of the hoteling host person or workspace.

host_phone_number: str | None

Phone number of the hoteling host.

host_extension: str | None

Extension of the hoteling host.

host_location: IdAndName | None