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[UserNumber] | None = None, location: str | IdAndName | None = None, locationId: str | None = None, **extra_data: Any)[source]

Bases: MonitoredMember

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, **extra_data: Any)[source]

Bases: ApiModel

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[str | MonitoredElement] | None = None, availableEntriesCount: int | None = None, **extra_data: Any)[source]

Bases: ApiModel

call_park_notification_enabled: bool | None

Call park notification is enabled or disabled.

monitored_elements: list[str | 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. Maximum 50 elements.

available_entries_count: int | None

Indicates additional number of entries that can be stored (more than the number of entries listed).

property monitored_cpes: list[CallParkExtension]
property monitored_members: list[MonitoredElementMember]
class wxc_sdk.person_settings.monitoring.MonitoringApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API for person’s call monitoring settings, also used for workspaces

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

Retrieve an entity’s Monitoring Settings

Retrieves the monitoring settings of the entity, which shows specified people, places, virtual lines or call park extensions that are being monitored.

Monitors the line status which indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.

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

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • org_id (str) – ID of the organization in which the entity resides. 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(entity_id: str, settings: Monitoring, org_id: str = None)[source]

Modify an entity’s Monitoring Settings

Modifies the monitoring settings of the entity.

Monitors the line status of specified people, places, virtual lines or call park extension. The line status indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.

The number of monitored elements is limited to 50.

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

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • 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 = ''