wxc_sdk.person_settings package

Person settings

class wxc_sdk.person_settings.PersonSettingsApi(session: RestSession)[source]

Bases: ApiChild

API for all user level settings

agent_caller_id: AgentCallerIdApi

agent caller id Api

appservices: AppServicesApi

Person’s Application Services Settings

base = 'people'
barge: BargeApi

Barge In Settings for a Person

dnd: DndApi

Do Not Disturb Settings for a Person

call_bridge: CallBridgeApi

Call bridge settings for a person

call_intercept: CallInterceptApi

Call Intercept Settings for a Person

call_recording: CallRecordingApi

Call Recording Settings for a Person

call_waiting: CallWaitingApi

Call Waiting Settings for a Person

calling_behavior: CallingBehaviorApi

Person’s Calling Behavior

caller_id: CallerIdApi

Caller ID Settings for a Person

exec_assistant: ExecAssistantApi

Executive Assistant Settings for a Person

forwarding: PersonForwardingApi

Forwarding Settings for a Person

hoteling: HotelingApi

Hoteling Settings for a Person

monitoring: MonitoringApi

Person’s Monitoring Settings

numbers: NumbersApi

Phone Numbers for a Person

permissions_in: IncomingPermissionsApi

Incoming Permission Settings for a Person

permissions_out: OutgoingPermissionsApi

Person’s Outgoing Calling Permissions Settings

preferred_answer: PreferredAnswerApi

Preferred answer endpoint settings

privacy: PrivacyApi

Person’s Privacy Settings

push_to_talk: PushToTalkApi

Push-to-Talk Settings for a Person

receptionist: ReceptionistApi

Receptionist Client Settings for a Person

schedules: ScheduleApi

Schedules for a Person

voicemail: VoicemailApi

Voicemail Settings for a Person

reset_vm_pin(person_id: str, org_id: str | None = None)[source]

Reset Voicemail PIN

Reset a voicemail PIN for a person.

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.

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) → PersonDevicesResponse[source]

Get all devices for a person.

This requires a full or read-only 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:

PersonDevicesResponse

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, mac: str | None = None, ipAddress: str | None = None, primaryOwner: bool, hoteling: Hoteling | None = None, type: PrimaryOrShared, 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.

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.PersonDevicesResponse(*, devices: list[TelephonyDevice], maxDeviceCount: int)[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.

Submodules