wxc_sdk.person_settings.selective_forward module

class wxc_sdk.person_settings.selective_forward.SelectiveForwardCriteria(*, id: str | None = None, scheduleName: str | None = None, scheduleType: ScheduleType | None = None, scheduleLevel: SelectiveScheduleLevel | None = None, callsFrom: SelectiveFrom | None = None, anonymousCallersEnabled: bool | None = None, unavailableCallersEnabled: bool | None = None, phoneNumbers: list[Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)]] | None = None, enabled: bool | None = None, forwardToPhoneNumber: str | None = None, sendToVoicemailEnabled: bool | None = None, **extra_data: Any)

Bases: SelectiveCriteria

forward_to_phone_number: str | None

Phone number to forward calls to during this schedule.

send_to_voicemail_enabled: bool | None

Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions.

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self – The BaseModel instance.

• context – The context.

class wxc_sdk.person_settings.selective_forward.SelectiveForward(*, enabled: bool | None = None, defaultPhoneNumberToForward: str | None = None, ringReminderEnabled: bool | None = None, destinationVoicemailEnabled: bool | None = None, criteria: list[SelectiveCrit] | None = None, **extra_data: Any)

Bases: ApiModel

enabled: bool | None

true if the Selective Forward feature is enabled.

default_phone_number_to_forward: str | None

Enter the phone number to forward calls to during this schedule.

ring_reminder_enabled: bool | None

When true, enables a ring reminder for such calls.

destination_voicemail_enabled: bool | None

Enables forwarding for all calls to voicemail. This option is only available for internal phone numbers or extensions.

criteria: list[SelectiveCrit] | None

A list of criteria specifying conditions when selective forward feature is in effect.

class wxc_sdk.person_settings.selective_forward.SelectiveForwardApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

Bases: PersonSettingsApiChild

API for selective forward settings

For now only used for workspaces

feature = 'selectiveForward'

read_criteria(entity_id: str, id: str, org_id: str | None = None) → SelectiveForwardCriteria

Retrieve Selective Forward Criteria for a Workspace

Retrieve Selective Forward Criteria Settings for a Workspace.

With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

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

• id (str) – Unique identifier for the criteria.

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

Return type:

SelectiveCriteria

configure_criteria(entity_id: str, id: str, settings: SelectiveForwardCriteria, org_id: str | None = None)

Modify Selective Forward Criteria for a Workspace

Modify Selective Forward Call Criteria Settings for a Workspace.

With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

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

• id (str) – Unique identifier for the criteria.

• settings (SelectiveForwardCriteria) – new settings to be applied.

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

Return type:

None

delete_criteria(entity_id: str, id: str, org_id: str | None = None)

Delete Selective Forward Criteria for a Workspace

Delete Selective Forward Call criteria Settings for a workspace.

With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

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

• id (str) – Unique identifier for the criteria.

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

Return type:

None

create_criteria(entity_id: str, settings: SelectiveForwardCriteria, org_id: str | None = None) → str

Create Selective Forward Criteria for a Workspace

Create Selective Forward Call Criteria Settings for a Workspace.

With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week.

This API requires a full, user or location administrator auth token with the spark-admin:workspaces_write scope or a user auth token with a scope of spark:workspaces_write to update workspace settings.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

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

• settings (SelectiveCriteria) – new settings to be applied.

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

Return type:

str

read(entity_id: str, org_id: str | None = None) → SelectiveForward

Retrieve Selective Forward Settings for a Workspace

Retrieve Selective Forward Call Settings for a Workspace.

With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

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

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

Return type:

SelectiveForward

configure(entity_id: str, settings: SelectiveForward, org_id: str | None = None)

Modify Selective Forward Settings for a Workspace

Modify Selective Forward Call Settings for a Workspace.

With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding. Schedules can also be set up for this feature during certain times of the day or days of the week.

NOTE: This API is only available for professional licensed workspaces.

Parameters:

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

• settings (SelectiveForward) – Settings for new criteria

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

Return type:

None

base = ''