wxc_sdk.person_settings package

The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. A voicemail PIN is used to retrieve your voicemail messages.

This API requires a full or user administrator auth token with the spark-admin:people_write scope.

This endpoint is also available in the voicemail API and is only kept here for backward compatibility.

Parameters:

person_id – Unique identifier for the person.
org_id – Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

devices(person_id: str, org_id: str | None = None) → DeviceList[source]

Get all devices for a person.

This requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

person_id (str) – Person to retrieve devices for
org_id (str) – organization that person belongs to

Returns:

device info for user

Return type:

DeviceList

modify_hoteling_settings_primary_devices(person_id: str, hoteling: Hoteling, org_id: str | None = None)[source]

Modify Hoteling Settings for a Person’s Primary Devices

Modify hoteling login configuration on a person’s Webex Calling Devices which are in effect when the device is the user’s primary device and device type is PRIMARY. To view the current hoteling login settings, see the hoteling field in Get Person Devices.

Modifying devices for a person requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

person_id (str) – ID of the person associated with the device.
hoteling (Hoteling) – Modify person Device Hoteling Setting.
org_id (str) – Organization to which the person belongs.

Return type:

None

class wxc_sdk.person_settings.DeviceOwner(*, id: str = None, lastName: str | None = None, firstName: str | None = None, type: UserType, location: IdAndName | None = None)[source]

Bases: ApiModel

owner_id: str: unique identifier for user or workspace the device is owned by

last_name: str | None: last name of device owner.

first_name: str | None: First name of device owner.

owner_type: UserType: user or workspace?

location: IdAndName | None: user location

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

Bases: str, SafeEnum

An enumeration.

activating = 'ACTIVATING'

activated = 'ACTIVATED'

deactivated = 'DEACTIVATED'

class wxc_sdk.person_settings.Hoteling(*, enabled: bool | None = None, limitGuestUse: bool | None = None, guestHoursLimit: int | None = None)[source]

Bases: ApiModel

enabled: bool | None: Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device as if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone.

limit_guest_use: bool | None: Enable limiting the time a guest can use the device. The time limit is configured via guestHoursLimit.

guest_hours_limit: int | None: Time Limit in hours until hoteling is enabled. Mandatory if limitGuestUse is enabled.

class wxc_sdk.person_settings.TelephonyDevice(*, id: str, description: list[str], model: str, type: PrimaryOrShared | None = None, modelType: DeviceType = None, mac: str | None = None, ipAddress: str | None = None, primaryOwner: bool, hoteling: Hoteling | None = None, owner: DeviceOwner | None = None, activationState: DeviceActivationState, location: IdAndName | None = None)[source]

Bases: ApiModel

device_id: str: Unique identifier for a device.

description: list[str]: Comma separated array of tags used to describe device.

model: str: Identifier for device model.

type: PrimaryOrShared | None

mod_type: DeviceType: Identifier for device model type.

mac: str | None: MAC address of device.

ip_address: str | None: IP address of device.

primary_owner: bool: This field indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device.

hoteling: Hoteling | None: Hoteling settings, which are available when the device is the user’s primary device and device type is PRIMARY

device_type: PrimaryOrShared: Indicates if the line is acting as a primary line or a shared line for this device.

owner: DeviceOwner | None: Owner of device.

activation_state: DeviceActivationState: Activation state of device.

location: IdAndName | None

class wxc_sdk.person_settings.DeviceList(*, devices: list[TelephonyDevice], maxDeviceCount: int, maxOwnedDeviceCount: int | None = None)[source]

Bases: ApiModel

devices: list[TelephonyDevice]: Array of devices available to person.

max_device_count: int: Maximum number of devices a person can be assigned to.

max_owned_device_count: int | None: Maximum number of devices a person can own.

wxc_sdk.person_settings package

Submodules