wxc_sdk.me.priority_alert package

class wxc_sdk.me.priority_alert.MePriorityAlertApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

get() → PriorityAlert

Get Priority Alert Settings

Get Priority Alert Settings for the authenticated user.

Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

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

Return type:

PriorityAlert

update(enabled: bool)

Modify Priority Alert Settings for User

Update Priority Alert Settings for the authenticated user.

Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

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

Parameters:

enabled (bool) – Indicates whether the priority alert feature should be enabled or disabled for the user.

Return type:

None

criteria_create(criteria: PriorityAlertCriteria) → str

Add a Priority Alert Criteria

Create a Priority Alert Criteria for the authenticated user.

Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

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

Parameters:

criteria (PriorityAlertCriteria) – Priority Alert Criteria

Return type:

str

criteria_delete(criteria_id: str)

Delete a Priority Alert Criteria

Delete a Priority Alert criteria for the authenticated user.

Priority alert allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.

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 priority alert criteria.

Return type:

None

criteria_get(criteria_id: str) → PriorityAlertCriteria

Get Priority Alert Criteria Settings

Get Priority Alert Criteria Settings for the authenticated user.

Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

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 priority alert criteria.

Return type:

PriorityAlertCriteria

criteria_update(criteria: PriorityAlertCriteria, criteria_id: str | None = None)

Modify Settings for a Priority Alert Criteria

Modify Priority Alert Criteria Settings for the authenticated user.

Priority alert allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.

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 priority alert criteria. Default: id from criteria

• criteria (PriorityAlertCriteria) – Priority Alert Criteria

Return type:

None

base = 'telephony/config/people/me'