wxc_sdk.person_settings.mode_management module

class wxc_sdk.person_settings.mode_management.ModeManagementApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Operating Mode Management for Person Call Settings

Person Call Settings supports modifying Webex Calling settings for a specific person.

Viewing People requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:people_read or, for select APIs, a user auth token with spark:people_read scope can be used by a person to read their own settings.

Configuring People settings requires a full, or user administrator or location administrator auth token with the spark-admin:people_write scope or, for select APIs, a user auth token with spark:people_write scope can be used by a person to update their own settings.

Call Settings API access can be restricted via Control Hub by a full administrator. Restricting access causes the APIs to throw a 403 Access Forbidden error.

See details about features available by license type for Webex Calling.

available_features(person_id: str = None, name: str = None, phone_number: str = None, extension: str = None, order: str = None, org_id: str = None, **params) → Generator[AvailableFeature, None, None][source]

Retrieve the List of Available Features.

Retrieve a list of feature identifiers that can be assigned to a user for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt Groups.

Features with mode-based call forwarding enabled can be assigned to a user for Mode Management.

Retrieving this list requires a full, read-only, or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • person_id (str) – A unique identifier for the user.

  • name (str) – List features whose name contains this string.

  • phone_number (str) – List features whose phoneNumber contains this matching string.

  • extension (str) – List features whose extension contains this matching string.

  • order (str) – Sort the list of features based on name, phoneNumber, or extension, either asc, or desc.

  • org_id (str) – Retrieve features list from this organization.

Returns:

Generator yielding AvailableFeature instances

assigned_features(person_id: str = None, org_id: str = None) → list[ModeManagementFeature][source]

Retrieve the List of Features Assigned to a User for Mode Management.

Retrieve a list of feature identifiers that are already assigned to a user for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt Groups. A maximum of 50 features can be assigned to a user for Mode Management.

Features with mode-based call forwarding enabled can be assigned to a user for Mode Management.

Retrieving this list requires a full, read-only, or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • person_id (str) – A unique identifier for the user.

  • org_id (str) – Retrieve features list from this organization.

Return type:

list[ModeManagementFeature]

assign_features(feature_ids: list[str], person_id: str = None, org_id: str = None)[source]

Assign a List of Features to a User for Mode Management.

Assign a user a list of feature identifiers for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt Groups. A maximum of 50 features can be assigned to a user for Mode Management.

Updating mode management settings for a user requires a full, or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • feature_ids (list[str]) – Array of feature IDs.

  • person_id (str) – A unique identifier for the user.

  • org_id (str) – Retrieve features list from this organization.

Return type:

None

base = 'telephony/config/people'
class wxc_sdk.person_settings.mode_management.ExceptionType(*values)[source]

Bases: str, SafeEnum

An enumeration.

manual_switch_back = 'MANUAL_SWITCH_BACK'

The mode was switched to or extended by the user for manual switch back and runs as an exception until the user manually switches the feature back to normal operation or a different mode.

automatic_switch_back_early_start = 'AUTOMATIC_SWITCH_BACK_EARLY_START'

The mode was switched to by the user before its start time and runs as an exception until its end time is reached, at which point it automatically switches the feature back to normal operation.

automatic_switch_back_extension = 'AUTOMATIC_SWITCH_BACK_EXTENSION'

The current mode was extended by the user before its end time and runs as an exception until the extension end time (mode’s end time + extension of up to 12 hours) is reached, at which point it automatically switches the feature back to normal operation.

automatic_switch_back_standard = 'AUTOMATIC_SWITCH_BACK_STANDARD'

The mode will remain the current operating mode for the feature until its normal end time is reached.

class wxc_sdk.person_settings.mode_management.FeatureType(*values)[source]

Bases: str, SafeEnum

An enumeration.

auto_attendant = 'AUTO_ATTENDANT'

Specifies the feature is an Auto Attendant.

call_queue = 'CALL_QUEUE'

Specifies the feature is a Call Queue.

hunt_group = 'HUNT_GROUP'

Specifies the feature is a Hunt Group.

class wxc_sdk.person_settings.mode_management.AvailableFeature(*, id: str | None = None, name: str | None = None, type: FeatureType | None = None, phoneNumber: str | None = None, extension: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

A unique identifier for the feature.

name: str | None

Unique name for the feature.

type: FeatureType | None

Defines the scheduling of the operating mode.

phone_number: str | None

The primary phone number configured for the feature.

extension: str | None

The extension configured for the feature.

class wxc_sdk.person_settings.mode_management.ModeManagementFeature(*, id: str | None = None, name: str | None = None, type: FeatureType | None = None, phoneNumber: str | None = None, extension: str | None = None, modeBasedForwardingEnabled: bool | None = None, forwardDestination: str | None = None, currentOperatingModeName: str | None = None, currentOperatingModeId: str | None = None, exceptionType: ExceptionType | None = None, location: IdAndName | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

A unique identifier for the feature.

name: str | None

Unique name for the feature.

type: FeatureType | None

Defines the scheduling of the operating mode.

phone_number: str | None

The primary phone number configured for the feature.

extension: str | None

The extension configured for the feature.

mode_based_forwarding_enabled: bool | None

A flag to indicate whether mode-based call forwarding is enabled for the feature.

forward_destination: str | None

The destination for call forwarding if mode-based call forwarding is enabled.

current_operating_mode_name: str | None

Name of the current operating mode.

current_operating_mode_id: str | None

Unique identifier for the current operating mode.

exception_type: ExceptionType | None

Defines the exception through which the current operating mode is set as active for the feature.

location: IdAndName | None

Location object that has a unique identifier for the location and its name.