wxc_sdk.me.sequential_ring package

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

Bases: ApiChild

get() → SequentialRing[source]

Get Sequential Ring Settings for User

Get Sequential Ring Settings for the authenticated user.

Sequential Ring allows calls to ring additional phone numbers in sequence if the initial call is not answered. This can be configured to ring up to five phone numbers with customizable ring patterns.

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

Return type:: SequentialRing

update(settings: SequentialRing)[source]

Modify Sequential Ring Settings for User

Update Sequential Ring Settings for the authenticated user.

Sequential Ring allows calls to ring additional phone numbers in sequence if the initial call is not answered. This can be configured to ring up to five phone numbers with customizable ring patterns.

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

Parameters:: settings (SequentialRing) – New sequential ring settings
Return type:: None

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

Add User Sequential Ring Criteria

Create a new Sequential Ring Criteria for the authenticated user.

Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule.

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

Parameters:: criteria (SequentialRingCriteria) – New sequential ring criteria settings
Return type:: str

criteria_delete(criteria_id: str)[source]

Delete Sequential Ring Criteria

Delete a Sequential Ring Criteria for the authenticated user.

Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule.

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

Parameters:: criteria_id (str) – The criteria_id parameter specifies the unique identifier for the sequential ring criteria.
Return type:: None

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

Get Sequential Ring Criteria Settings for User

Get Sequential Ring Criteria Settings for the authenticated user.

Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule.

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

Parameters:: criteria_id (str) – The criteria_id parameter specifies the unique identifier for the sequential ring criteria.
Return type:: SequentialRingCriteria

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

Modify Sequential Ring Criteria Settings for User

Update Sequential Ring Criteria Settings for the authenticated user.

Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule.

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

Parameters:

criteria (SequentialRingCriteria) – New sequential ring criteria settings
criteria_id (str) – The criteria_id parameter specifies the unique identifier for the sequential ring criteria. Default: id from criteria

Return type:

None

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