wxc_sdk.person_settings.sequential_ring module

class wxc_sdk.person_settings.sequential_ring.SequentialRingNumber(*, phoneNumber: str | None = None, answerConfirmationRequiredEnabled: bool | None = None, numberOfRings: int | None = None, **extra_data: Any)

Bases: ApiModel

phone_number: str | None

Phone number set as the sequential number.

answer_confirmation_required_enabled: bool | None

When set to true the called party is required to press 1 on the keypad to receive the call.

number_of_rings: int | None

The number of rings to the specified phone number before the call advances to the subsequent number in the sequence or goes to voicemail.

class wxc_sdk.person_settings.sequential_ring.SequentialRing(*, enabled: bool | None = None, ringBaseLocationFirstEnabled: bool | None = None, baseLocationNumberOfRings: int | None = None, continueIfBaseLocationIsBusyEnabled: bool | None = None, callsToVoicemailEnabled: bool | None = None, phoneNumbers: list[SequentialRingNumber] | None = None, criteria: list[SelectiveCrit] | None = None, **extra_data: Any)

Bases: ApiModel

enabled: bool | None

When set to true sequential ring is enabled.

ring_base_location_first_enabled: bool | None

When set to true, the webex calling primary line will ring first.

base_location_number_of_rings: int | None

The number of times the primary line will ring.

continue_if_base_location_is_busy_enabled: bool | None

When set to true and the primary line is busy, the system redirects calls to the numbers configured for sequential ringing.

calls_to_voicemail_enabled: bool | None

When set to true calls are directed to voicemail.

phone_numbers: list[SequentialRingNumber] | None

A list of up to five phone numbers to which calls will be directed.

criteria: list[SelectiveCrit] | None

A list of criteria specifying conditions when sequential ringing is in effect.

class wxc_sdk.person_settings.sequential_ring.SequentialRingApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

Bases: PersonSettingsApiChild

API for sequential ring settings

For now only used for workspaces

feature: str | None = 'sequentialRing'

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

Retrieve sequential ring criteria for an entity.

The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.

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: SequentialRingCriteria, org_id: str = None)

Modify sequential ring criteria for an entity.

The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.

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 (SequentialRingCriteria) – 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)

Delete sequential ring criteria for an entity.

The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.

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: SequentialRingCriteria, org_id: str = None) → str

Create sequential ring criteria for an entity.

The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another. The sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.

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) → SequentialRing

Retrieve sequential ring settings for an entity.

The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.

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:

SequentialRing

configure(entity_id: str, settings: SequentialRing, org_id: str = None)

Modify sequential ring settings for an entity.

The sequential ring feature enables you to create a list of up to five phone numbers. When the entity receives incoming calls, these numbers will ring one after another.

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

Parameters:

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

• settings (SequentialRing) – 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 = ''

class wxc_sdk.person_settings.sequential_ring.SequentialRingCriteria(*, 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, **extra_data: Any)

Bases: SelectiveCriteria

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.