wxc_sdk.person_settings.monitoring module

call monitoring API

class wxc_sdk.person_settings.monitoring.MonitoredElementMember(*, id: str | None = None, lastName: str | None = None, firstName: str | None = None, displayName: str | None = None, type: UserType | None = None, email: str | None = None, numbers: list[wxc_sdk.common.UserNumber] | None = None, location: str | None = None, locationId: str | None = None)[source]

Bases: MonitoredMember

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

location_name: str | None

The location name where the call park extension is.

location_id: str | None

The location ID for the location.

property ci_location_id: str | None
class wxc_sdk.person_settings.monitoring.MonitoredElement(*, member: MonitoredElementMember | None = None, callparkextension: CallParkExtension | None = None)[source]

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

member: MonitoredElementMember | None

monitored person or place

cpe: CallParkExtension | None

monitored call park extension

class wxc_sdk.person_settings.monitoring.Monitoring(*, callParkNotificationEnabled: bool | None = None, monitoredElements: list[Union[str, wxc_sdk.person_settings.monitoring.MonitoredElement]] | None = None)[source]

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

call_park_notification_enabled: bool | None

Call park notification is enabled or disabled.

monitored_elements: list[Union[str, wxc_sdk.person_settings.monitoring.MonitoredElement]] | None

Settings of monitored elements which can be person, place, or call park extension. for updates IDs can be used directly instead of MonitoredElement objects

property monitored_cpes: list[wxc_sdk.common.CallParkExtension]
property monitored_members: list[wxc_sdk.person_settings.monitoring.MonitoredElementMember]
class wxc_sdk.person_settings.monitoring.MonitoringApi(*, session: RestSession, workspaces: bool = False, locations: bool = False)[source]

Bases: PersonSettingsApiChild

API for person’s call monitoring settings

feature = 'monitoring'
read(person_id: str, org_id: str | None = None) → Monitoring[source]

Retrieve a Person’s Monitoring Settings

Retrieves the monitoring settings of the person, which shows specified people, places or, call park extensions under monitoring. Monitors the line status which indicates if a person or place is on a call and if a call has been parked on that extension.

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • org_id (str) – 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.

Returns:

monitoring settings

Return type:

Monitoring

configure(person_id: str, settings: Monitoring, org_id: str | None = None)[source]

Configure Call Waiting Settings for a Person

Configure a Person’s Call Waiting Settings

With this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.

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

Parameters:

  • person_id (str) – Unique identifier for the person.

  • settings (Monitoring) – settings for update

  • org_id (str) – 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.

base = ''
session: RestSession

REST session