wxc_sdk.me.executive package

class wxc_sdk.me.executive.AssignedAssistants(*, allowOptInOutEnabled: bool | None = None, assistants: list[ExecOrAssistant] | None = None, **extra_data: Any)[source]

Bases: ApiModel

allow_opt_in_out_enabled: bool | None: If true, the user can opt in or out of the executive assistant pool.

assistants: list[ExecOrAssistant] | None: List of assigned executive assistants.

class wxc_sdk.me.executive.MeExecutiveApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

alert_settings() → ExecAlert[source]

Get User Executive Alert Settings

Get executive alert settings for the authenticated user.

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 user auth token with a scope of spark:telephony_config_read.

Return type:: ExecAlert

update_alert_settings(settings: ExecAlert)[source]

Modify User Executive Alert Settings

Update executive alert settings for the authenticated user.

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 user auth token with a scope of spark:telephony_config_write.

Parameters:: settings (ExecAlert) – Alert settings

assigned_assistants() → AssignedAssistants[source]

Get My Executive Assigned Assistants

Get list of assigned executive assistants for an authenticated user.

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 user auth token with a scope of spark:telephony_config_read.

Return type:: AssignedAssistants

update_assigned_assistants(assigned_assistants: AssignedAssistants)[source]

Modify My Executive Assigned Assistants

Update assigned executive assistants for the authenticated user.

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 user auth token with a scope of spark:telephony_config_write.

Parameters:: assigned_assistants (AssignedAssistants) – Assigned Assistants
Return type:: None

executive_assistant_settings() → AssistantSettings[source]

Get My Executive Assistant Settings

Get settings for an 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 user auth token with a scope of spark:telephony_config_read.

Return type:: AssistantSettings

update_executive_assistant_settings(assistant_settings: AssistantSettings)[source]

Modify My Executive Assistant Settings

Update Settings for an 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 user auth token with a scope of spark:telephony_config_write.

Parameters:: assistant_settings (AssistantSettings) – My Executive Assistant Settings

executive_available_assistants() → list[ExecOrAssistant][source]

Get My Executive Available Assistants

Get a list of available executive assistants for the authenticated user.

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 user auth token with a scope of spark:telephony_config_read.

Return type:: list[ExecOrAssistant]

executive_call_filtering_settings() → ExecCallFiltering[source]

Get User Executive Call Filtering Settings

Get executive call filtering settings for the authenticated user.

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 user auth token with a scope of spark:telephony_config_read.

Return type:: ExecCallFiltering

update_executive_call_filtering_settings(settings: ExecCallFiltering)[source]

Update User Executive Call Filtering Settings

Update executive call filtering settings for the authenticated user.

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 user auth token with a scope of spark:telephony_config_write.

Parameters:: settings (ExecCallFiltering) – Call Filtering Settings

create_call_filtering_criteria(settings: ExecCallFilteringCriteria) → str[source]

Add User Executive Call Filtering Criteria

Create a new executive call filtering criteria for the authenticated user.

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 user auth token with a scope of spark:telephony_config_write.

Parameters:: settings (ExecCallFilteringCriteria) – Call Filtering Settings

delete_call_filtering_criteria(id: str)[source]

Delete User Executive Call Filtering Criteria

Delete a specific executive call filtering criteria for the authenticated user.

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 user auth token with a scope of spark:telephony_config_write.

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

call_filtering_criteria(id: str) → ExecCallFilteringCriteria[source]

Get User Executive Call Filtering Criteria Settings

Get executive call filtering criteria settings for the authenticated user.

Executive Call Filtering Criteria in Webex allows you to retrieve 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 user auth token with a scope of spark:telephony_config_read.

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

update_call_filtering_criteria(id: str, settings: ExecCallFilteringCriteria) → str[source]

Update User Executive Call Filtering Criteria Settings

Update executive call filtering criteria settings for the authenticated user.

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

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

id (str) – The id parameter specifies the unique identifier for the executive call filtering criteria. Example: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0.
settings (ExecCallFilteringCriteria) – Call Filtering Settings

Return type:

str

screening_settings() → ExecScreening[source]

Get User Executive Screening Settings

Get executive screening settings for the authenticated user.

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 user auth token with a scope of spark:telephony_config_read.

Return type:: ExecScreening

update_screening_settings(settings: ExecScreening)[source]

Modify User Executive Screening Settings

Update executive screening settings for the authenticated user.

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 user auth token with a scope of spark:telephony_config_write.

Parameters:: settings (ExecScreening) – Screening Settings

base = 'telephony/config/people/me'