wxc_sdk.person_settings.executive package

class wxc_sdk.person_settings.executive.ExecAlertingMode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

sequential = 'SEQUENTIAL'

Alerts assistants one at a time in the defined order.

simultaneous = 'SIMULTANEOUS'

Alerts all assistants at the same time.

class wxc_sdk.person_settings.executive.ExecAlertRolloverAction(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

voice_messaging = 'VOICE_MESSAGING'

The call is sent to the executive’s voicemail.

no_answer_processing = 'NO_ANSWER_PROCESSING'

The call is sent to no answer processing which may trigger executive services such as call forwarding or voicemail. Rollover is always triggered when no assistants remain for a filtered call. If the rollover timer is enabled, rollover can also be triggered when the timer expires, even if assistants are still available.

forward = 'FORWARD'

The call is forwarded to the specified destination (rolloverForwardToPhoneNumber).

class wxc_sdk.person_settings.executive.ExecAlertClidNameMode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

executive_originator = 'EXECUTIVE_ORIGINATOR'

Display executive name followed by caller name.

originator_executive = 'ORIGINATOR_EXECUTIVE'

Display caller name followed by executive name.

executive = 'EXECUTIVE'

Display only executive name.

originator = 'ORIGINATOR'

Display only caller name.

custom = 'CUSTOM'

Display a custom name.

class wxc_sdk.person_settings.executive.ExecAlertClidPhoneNumberMode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

executive = 'EXECUTIVE'

Display executive’s phone number.

originator = 'ORIGINATOR'

Display caller’s phone number.

custom = 'CUSTOM'

Display a custom phone number.

class wxc_sdk.person_settings.executive.ExecAlert(*, alertingMode: ExecAlertingMode | None = None, nextAssistantNumberOfRings: int | None = None, rolloverEnabled: bool | None = None, rolloverAction: ExecAlertRolloverAction | None = None, rolloverForwardToPhoneNumber: str | None = None, rolloverWaitTimeInSecs: int | None = None, clidNameMode: ExecAlertClidNameMode | None = None, customCLIDName: str | None = None, customCLIDNameInUnicode: str | None = None, clidPhoneNumberMode: ExecAlertClidPhoneNumberMode | None = None, customCLIDPhoneNumber: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

alerting_mode: ExecAlertingMode | None

  • SEQUENTIAL - Alerts assistants one at a time in the defined order.

next_assistant_number_of_rings: int | None

Number of rings before alerting the next assistant when in sequential mode.

rollover_enabled: bool | None

Controls whether the rollover timer (rolloverWaitTimeInSecs) is enabled. When set to true, rollover will trigger after the timer expires, even if assistants are still available. When false, rollover only occurs when no assistants remain.

rollover_action: ExecAlertRolloverAction | None

Specifies what happens when rollover is triggered: - VOICE_MESSAGING: Send to Voicemail—A voicemail is sent to the executive. - FORWARD: Forward—Calls are forwarded to a specified number. - NO_ANSWER_PROCESSING: Do nothing—No action is taken. Rollover is always triggered when no assistants remain for a filtered call. If the rollover timer is enabled, rollover can also be triggered when the timer expires, even if assistants are still available.

rollover_forward_to_phone_number: str | None

Phone number to forward calls to when rollover action is set to FORWARD.

rollover_wait_time_in_secs: int | None

Time in seconds to wait before applying the rollover action.

clid_name_mode: ExecAlertClidNameMode | None

  • EXECUTIVE_ORIGINATOR - Display executive name followed by caller name.

custom_clidname: str | None

Custom caller ID name to display (deprecated).

custom_clidname_in_unicode: str | None

Custom caller ID name in Unicode format.

clid_phone_number_mode: ExecAlertClidPhoneNumberMode | None

  • EXECUTIVE - Display executive’s phone number.

custom_clidphone_number: str | None

Custom caller ID phone number to display.

class wxc_sdk.person_settings.executive.ExecOrAssistant(*, id: str | None = None, firstName: str | None = None, lastName: str | None = None, directNumber: str | None = None, extension: str | None = None, optInEnabled: bool | None = None, location: IdAndName | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier of the assistant.

first_name: str | None

First name of the assistant.

last_name: str | None

Last name of the assistant.

direct_number: str | None

Direct number of the assistant.

extension: str | None

Extension number of the assistant.

opt_in_enabled: bool | None

If true, the assistant can opt in to the executive assistant pool.

location: IdAndName | None
class wxc_sdk.person_settings.executive.AssistantSettings(*, forwardFilteredCallsEnabled: bool | None = None, forwardToPhoneNumber: str | None = None, executives: list[ExecOrAssistant] | None = None, **extra_data: Any)[source]

Bases: ApiModel

forward_filtered_calls_enabled: bool | None

If true, the executive assistant forwards filtered calls to the forward to phone number.

forward_to_phone_number: str | None

Phone number to forward calls to.

executives: list[ExecOrAssistant] | None

List of assigned executives.

class wxc_sdk.person_settings.executive.ExecCallFilterType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

custom_call_filters = 'CUSTOM_CALL_FILTERS'

Choose this option to ensure only specific calls are sent to the executive assistant.

all_calls = 'ALL_CALLS'

Choose this option to send both internal and external calls to the executive assistant.

all_internal_calls = 'ALL_INTERNAL_CALLS'

Choose this option to send all the internal calls to the executive assistant.

all_external_calls = 'ALL_EXTERNAL_CALLS'

Choose this option to send all the external calls to the executive assistant.

class wxc_sdk.person_settings.executive.ExecCallFilteringCriteriaItem(*, id: str | None = None, filterName: str | None = None, source: SelectiveFrom | None = None, activationEnabled: bool | None = None, filterEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier for the filter criteria.

filter_name: str | None

Name of the criteria.

source: SelectiveFrom | None
activation_enabled: bool | None

Controls whether this filter criteria is active. When true, the criteria is evaluated for incoming calls. When false, the criteria is completely ignored and has no effect on call filtering.

filter_enabled: bool | None

Controls the action when this criteria matches a call. When true, matching calls are filtered (blocked). When false, matching calls are allowed through and take precedence over other filtering criteria, creating exceptions to let specific calls through.

class wxc_sdk.person_settings.executive.ExecCallFiltering(*, enabled: bool | None = None, filterType: ExecCallFilterType | None = None, criteria: list[ExecCallFilteringCriteriaItem] | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

Indicates if executive call filtering is enabled.

filter_type: ExecCallFilterType | None
criteria: list[ExecCallFilteringCriteriaItem] | None

List of call filtering criteria configured for executive call filtering.

class wxc_sdk.person_settings.executive.ExecCallFilteringScheduleLevel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

people = 'PEOPLE'

The schedule applies to the individual user.

location = 'LOCATION'

The schedule applies at the account level, potentially affecting multiple users.

class wxc_sdk.person_settings.executive.ExecCallFilteringToNumber(*, type: PrimaryOrSecondary | None = None, phoneNumber: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

type: PrimaryOrSecondary | None
phone_number: str | None

The phone number to call.

class wxc_sdk.person_settings.executive.ExecCallFilteringCriteria(*, id: str | None = None, filterName: str | None = None, scheduleName: str | None = None, scheduleType: ScheduleType | None = None, scheduleLevel: ExecCallFilteringScheduleLevel | None = None, callsFrom: SelectiveFrom | None = None, anonymousCallersEnabled: bool | None = None, unavailableCallersEnabled: bool | None = None, phoneNumbers: list[str] | None = None, filterEnabled: bool | None = None, callsToNumbers: list[ExecCallFilteringToNumber] | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier for the filter criteria.

filter_name: str | None

Name of the criteria.

schedule_name: str | None

Name of the schedule associated with this criteria.

schedule_type: ScheduleType | None

  • holidays - The schedule is based on specific times.

schedule_level: ExecCallFilteringScheduleLevel | None

  • PEOPLE - The schedule applies to the individual user.

calls_from: SelectiveFrom | None

  • ANY_PHONE_NUMBER - The criteria applies to any phone number.

anonymous_callers_enabled: bool | None

Indicates if the criteria applies to anonymous callers.

unavailable_callers_enabled: bool | None

Indicates if the criteria applies to unavailable callers.

phone_numbers: list[str] | None

List of phone numbers that this filtering criteria applies to.

filter_enabled: bool | None

Controls the action when this criteria matches a call. When true, matching calls are filtered (blocked). When false, matching calls are allowed through and take precedence over other filtering criteria, creating exceptions to let specific calls through.

calls_to_numbers: list[ExecCallFilteringToNumber] | None

List of phone numbers to route calls to when this criteria matches.

class wxc_sdk.person_settings.executive.ExecScreeningAlertType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

silent = 'SILENT'

No audible alert is provided for executive screening.

ring_splash = 'RING_SPLASH'

A short ring (splash) is used as an alert for executive screening.

class wxc_sdk.person_settings.executive.ExecScreening(*, enabled: bool | None = None, alertType: ExecScreeningAlertType | None = None, alertAnywhereLocationEnabled: bool | None = None, alertMobilityLocationEnabled: bool | None = None, alertSharedCallAppearanceLocationEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None

Indicates if executive screening is enabled.

alert_type: ExecScreeningAlertType | None
alert_anywhere_location_enabled: bool | None

Indicates if alerts are enabled for Single Number Reach locations.

alert_mobility_location_enabled: bool | None

Indicates if alerts are enabled for Webex Go locations.

alert_shared_call_appearance_location_enabled: bool | None

Indicates if alerts are enabled for Shared Call Appearance locations.

class wxc_sdk.person_settings.executive.ExecutiveSettingsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Person executive settings

alert_settings(person_id: str, org_id: str | None = None) → ExecAlert[source]

Get Person Executive Alert Settings

Get executive alert settings for the specified person.

Executive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren’t answered.

This API requires a full, user, 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 person.

  • org_id (str) – Organization ID for the person.

Return type:

ExecAlert

update_alert_settings(person_id: str, settings: ExecAlert, org_id: str | None = None)[source]

Modify Person Executive Alert Settings

Update executive alert settings for the specified person.

Executive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren’t answered.

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

Parameters:

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

  • settings (ExecutiveAlertSettings) – Alert Settings for the person.

  • org_id (str) – Organization ID for the person.

Return type:

None

assigned_assistants(person_id: str, org_id: str | None = None) → list[ExecOrAssistant][source]

Get Person Executive Assigned Assistants

Get list of assigned executive assistants for the specified person.

As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.

This API requires a full, user, 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 person.

  • org_id (str) – Organization ID for the person.

Return type:

list[ExecOrAssistant]

update_assigned_assistants(person_id: str, assistant_ids: list[str] | None = None, org_id: str | None = None)[source]

Modify Person Executive Assigned Assistants

Update assigned executive assistants for the specified person.

As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.

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

Parameters:

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

  • assistant_ids (list[str]) – List of people to be assigned as assistant. To remove all assigned assistants, set assistantIds to null.

  • org_id (str) – Organization ID for the person.

Return type:

None

executive_assistant_settings(person_id: str, org_id: str | None = None) → AssistantSettings[source]

Get Person Executive Assistant Settings

Get executive assistant settings for the specified person when person is configured as executive assistant.

Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive. Assistants can also set the call forwarding destination, and join or leave an executive’s pool.

This API requires a full, user, 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 person.

  • org_id (str) – Organization ID for the person.

Return type:

AssistantSettings

update_executive_assistant_settings(person_id: str, settings: AssistantSettings, org_id: str | None = None)[source]

Modify Person Executive Assistant Settings

Update executive assistant settings for the specified person when person is configured as executive assistant.

Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive. Assistants can also set the call forwarding destination, and join or leave an executive’s pool.

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

Parameters:

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

  • settings (AssistantSettings) – Person Executive Assistant Settings

  • org_id (str) – Organization ID for the person.

Return type:

None

executive_available_assistants(person_id: str, name: str | None = None, phone_number: str | None = None, org_id: str | None = None, **params) → List[ExecOrAssistant][source]

Get Person Executive Available Assistants

Retrieves a list of people available for assignment as executive assistants to the specified person.

As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.

This API requires a full, user, 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 person.

  • name (str) – Only return people with the matching name (person’s first and last name combination).

  • phone_number (str) – Only return people with the matching phone number or extension.

  • org_id (str) – Organization ID for the person.

Returns:

list of available assistants

executive_call_filtering_settings(person_id: str, org_id: str | None = None) → ExecCallFiltering[source]

Get Person Executive Call Filtering Settings

Retrieve the executive call filtering settings for the specified person.

Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.

This API requires a full, user, 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 person.

  • org_id (str) – Organization ID for the user.

Return type:

ExecCallFiltering

update_executive_call_filtering_settings(person_id: str, settings: ExecCallFiltering, org_id: str | None = None)[source]

Modify Person Executive Call Filtering Settings

Update the executive call filtering settings for the specified person.

Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.

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

Parameters:

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

  • settings (ExecCallFiltering) – Person Executive Call Filtering Settings

  • org_id (str) – Organization ID for the user.

Return type:

None

create_call_filtering_criteria(person_id: str, settings: ExecCallFilteringCriteria, org_id: str | None = None) → str[source]

Add Person Executive Call Filtering Criteria

Create a new executive call filtering criteria configuration for the specified person.

Executive Call Filtering Criteria in Webex allows you to define detailed filter rules for incoming calls. This API creates a new filter rule with the specified configuration, including schedule, phone numbers, and call routing preferences.

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

Parameters:

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

  • settings (ExecCallFilteringCriteria) – Call Filtering Settings

  • org_id (str) – Organization ID for the user.

Return type:

str

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

Delete Person Executive Call Filtering Criteria

Delete a specific executive call filtering criteria configuration for the specified person.

Executive Call Filtering Criteria in Webex allows you to manage detailed filter rules for incoming calls. This API removes a specific filter rule by its unique identifier.

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

Parameters:

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

  • id (str) – The id parameter specifies the unique identifier for the executive call filtering criteria. Example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0.

  • org_id (str) – Organization ID for the user.

Return type:

None

get_filtering_criteria(person_id: str, id: str, org_id: str | None = None) → ExecCallFilteringCriteria[source]

Get Person Executive Call Filtering Criteria Settings

Retrieve the executive call filtering criteria settings for the specified person.

Executive Call Filtering Criteria in Webex allows you to retrieve the detailed configuration for a specific filter rule. This includes schedule settings, phone number filters, and call routing preferences for executive call filtering.

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

Parameters:

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

  • id (str) – The id parameter specifies the unique identifier for the executive call filtering criteria.

  • org_id (str) – Organization ID for the user.

Return type:

ExecCallFilteringCriteria

update_call_filtering_criteria(person_id: str, id: str, settings: ExecCallFilteringCriteria, org_id: str | None = None)[source]

Modify Person Executive Call Filtering Criteria Settings

Update the executive call filtering settings for the specified person.

Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.

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

Parameters:

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

  • id (str) – The id parameter specifies the unique identifier for the executive call filtering criteria. Example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0.

  • settings (ExecCallFilteringCriteria) – Call Filtering Settings

  • org_id (str) – Organization ID for the user.

Return type:

None

screening_settings(person_id: str, org_id: str | None = None) → ExecScreening[source]

Get Person Executive Screening Settings

Get executive screening settings for the specified person.

Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications.

This API requires a full, user, 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 person.

  • org_id (str) – Organization ID for the person.

Return type:

ExecScreening

update_screening_settings(person_id: str, settings: ExecScreening, org_id: str | None = None)[source]

Modify Person Executive Screening Settings

Update executive screening settings for the specified person.

Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications.

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

Parameters:

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

  • settings (ExecScreening) – Screening Settings

  • org_id (str) – Organization ID for the person.

Return type:

None

base = ''