wxc_sdk.me.sim_ring package

class wxc_sdk.me.sim_ring.MeSimRingApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Retrieve My Simultaneous Ring Settings

Retrieve simultaneous ring settings for the authenticated user.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.

Retrieving settings requires a user auth token with a scope of spark:telephony_config_read.

Return type:: MeSimRing

update(settings: MeSimRing) → None[source]

Modify My Simultaneous Ring Settings

Modify simultaneous ring settings for the authenticated user.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.

Modifying settings requires a user auth token with a scope of spark:telephony_config_write.

Parameters:: settings – new sim ring settings
Return type:: None

criteria_create(criteria: SimRingCriteria) → str[source]

Create My Simultaneous Ring Criteria

Create simultaneous ring criteria settings for the authenticated user.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.

Creating criteria requires a user auth token with a scope of spark:telephony_config_write.

Parameters:: criteria (MeSimRingCriteria) – new sim ring criteria
Return type:: str

criteria_delete(criteria_id: str)[source]

Delete My Simultaneous Ring Criteria

Delete simultaneous ring criteria settings for the authenticated user.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.

Deleting criteria requires a user auth token with a scope of spark:telephony_config_write.

Parameters:: criteria_id (str) – Unique identifier for the criteria.
Return type:: None

criteria_get(criteria_id: str) → SimRingCriteria[source]

Retrieve My Simultaneous Ring Criteria

Retrieve simultaneous ring criteria settings for the authenticated user.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.

Retrieving criteria requires a user auth token with a scope of spark:telephony_config_read.

Parameters:: criteria_id (str) – Unique identifier for the criteria.
Return type:: SimRingCriteria

criteria_update(criteria: SimRingCriteria, criteria_id: str | None = None)[source]

Modify My Simultaneous Ring Criteria

Modify simultaneous ring criteria settings for the authenticated user.

The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.

Modifying criteria requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

criteria (SimRingCriteria) – new settings
criteria_id (str) – Unique identifier for the criteria. Default: id from criteria

Return type:

None

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

class wxc_sdk.me.sim_ring.MeSimRingNumber(*, phoneNumber: Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)] | None = None, answerConfirmationEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

phone_number: Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)] | None: Phone number set for simultaneous ring.

answer_confirmation_enabled: bool | None: When set to true, the called party is required to press any key on the keypad to confirm answer for the call.

class wxc_sdk.me.sim_ring.MeSimRing(*, enabled: bool | None = None, doNotRingIfOnCallEnabled: bool | None = None, phoneNumbers: list[MeSimRingNumber] | None = None, criteria: list[SelectiveCrit] | None = None, criteriasEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool | None: Simultaneous Ring is enabled or not.

do_not_ring_if_on_call_enabled: bool | None: When set to true, the configured phone numbers won’t ring when on a call.

phone_numbers: list[MeSimRingNumber] | None: Enter up to 10 phone numbers to ring simultaneously when workspace phone receives an incoming call.

criteria: list[SelectiveCrit] | None: A list of criteria specifying conditions when simultaneous ring is in effect.

criterias_enabled: bool | None: When true, enables the selected schedule for simultaneous ring.

update() → dict[source]

Data for update

:meta private