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, locationId: str | None = None, lineKeyLabel: str | None = None, **extra_data: Any)

Bases: MonitoredMember

location: str

location_id: str | None

The location ID for the location.

line_key_label: str | None

This is a custom line key label configured for the monitored member.

property ci_location_id: str | None

class wxc_sdk.person_settings.monitoring.MonitoredElementSpeedDial(*, id: str | None = None, firstName: str | None = None, lastName: str | None = None, displayName: str | None = None, type: UserType | None = None, phoneNumber: str | None = None, extension: str | None = None, lineKeyLabel: str | None = None, location: str | None = None, locationId: str | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

ID of the configured speed dial (person or workspace or virtual line).

first_name: str | None

First name of the monitored speed dial item (virtual line or person). For a workspace, this field is not applicable.

last_name: str | None

Last name of the monitored speed dial item (virtual line or person). For a workspace, this field is not applicable.

display_name: str | None

Display name of the configured speed dial (person or workspace or virtual line).

type: UserType | None

Indicates whether type is person, workspace, or virtual line.

phone_number: str | None

Primary phone number for the configured speed dial. It can be either a person, workspace or virtual line. In case of a custom speed dial, it can be any external phone number.

extension: str | None

Primary extension for the configured speed dial. It can be either of a person or workspace or virtual line.

line_key_label: str | None

This is a custom line key label configured for the speed dial on the device.

location: str | None

Name of the location for the call park.

location_id: str | None

ID of the location for the call park.

class wxc_sdk.person_settings.monitoring.MonitoredElementCPE(*, id: str | None = None, name: str | None = None, lineKeyLabel: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, location: str | None = None, locationId: str | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

The identifier of the call park extension.

name: str | None

The name used to describe the call park extension.

line_key_label: str | None

This is a custom line key label configured for the Call Park Extension.

extension: str | None

The extension number for the call park extension.

routing_prefix: str | None

Routing prefix of the location.

esn: str | None

Routing prefix plus extension of the Call Park Extension. If routing prefix is not configured for the location, esn will be same as extension.

location: str | None

The location name where the call park extension is.

location_id: str | None

The ID of the location.

class wxc_sdk.person_settings.monitoring.Monitoring(*, callParkNotificationEnabled: bool | None = None, monitoredElements: list[MonitoredElement] | None = None, availableEntriesCount: int | None = None, **extra_data: Any)

Bases: ApiModel

call_park_notification_enabled: bool | None

Call park notification is enabled or disabled.

monitored_elements: list[MonitoredElement] | None

Settings of monitored elements which can be person, place, or call park extension. for updates only the member IDs need to be set

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[MonitoredElementCPE]

property monitored_members: list[MonitoredElementMember]

class wxc_sdk.person_settings.monitoring.MonitoringMember(*, id: str | None = None, firstName: str | None = None, lastName: str | None = None, displayName: str | None = None, phoneNumber: str | None = None, extension: str | None = None, type: UserType | None = None, location: IdAndName | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier of the member (PEOPLE, PLACE or VIRTUAL_LINE resource type).

first_name: str | None

First name of the member (virtual line or person). For a workspace, this field is not applicable.

last_name: str | None

Last name of the member (virtual line or person). For a workspace, this field is not applicable.

display_name: str | None

The display name of the monitored person, workspace, or virtual line.

phone_number: str | None

Phone number of the member.

extension: str | None

Extension of the member.

type: UserType | None

location: IdAndName | None

Location details of the member.

class wxc_sdk.person_settings.monitoring.MonitoringApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

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

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)

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.

get_available_members_for_monitoring(entity_id: str, location_id: str = None, member_name: str = None, phone_number: str = None, order: list[str] = None, org_id: str = None, **params: Any) → Generator[MonitoringMember, None, None]

Get Available Members for Person or Workspace monitoring

Get available members for person monitoring. This API allows administrators to retrieve a list of members that can be added to the monitoring list for a specific person or workspace

Webex Calling monitoring allows a person to watch the line status of selected people, workspaces, and virtual lines. Configuring a monitoring list helps the person quickly see whether monitored members are on a call.

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

Parameters:

• entity_id (str) – Unique identifier for the person or workspace.

• location_id (str) – Search for the available members in the location ID.

• member_name (str) – Search for available members by name.

• phone_number (str) – Search for available members by number or extension.

• order (list[str]) – Sort response based on firstName or lastName with sort direction asc or desc. Example: lastName-asc or firstName-desc. Default sort is ascending order.

• org_id (str) – ID of the organization within which the person 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 the API.

Returns:

Generator yielding MonitoringMember instances

get_available_speed_dials_for_monitoring(entity_id: str, location_id: str = None, member_name: str = None, phone_number: str = None, order: list[str] = None, org_id: str = None, **params: Any) → Generator[MonitoringMember, None, None]

Get Available Speed Dials for Person or Workspace Monitoring

Get available speed dials for Person monitoring configuration. This API allows administrators to retrieve a list of members that can be added as speed dials for monitoring a specific person.

Speed dials allow quick access to frequently contacted members. When configured for monitoring, speed dials enable users to quickly call or monitor the status of specific members within the organization.

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

Parameters:

• entity_id (str) – Unique identifier for the person or workspace

• location_id (str) – Search for the available speed dials in the location ID.

• member_name (str) – Search for available members by name.

• phone_number (str) – Search for available members by number or extension.

• order (list[str]) – Sort response based on firstName or lastName with sort direction asc or desc. Example: lastName-asc or firstName-desc. Default sort is ascending order.

• org_id (str) – ID of the organization within which the person 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 the API.

Returns:

Generator yielding MonitoringMember instances

base = ''