wxc_sdk.me.selective_reject package

class wxc_sdk.me.selective_reject.MeSelectiveRejectApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

get() → SelectiveReject[source]

Get Selective Call Reject Settings for User

Get Selective Call Reject Settings for the authenticated user.

Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

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

Return type:

SelectiveReject

update(enabled: bool)[source]

Modify Selective Call Reject Settings for User

Update Selective Call Reject Settings for the authenticated user.

Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

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

Parameters:

enabled (bool) – Indicates whether selective reject is enabled.

Return type:

None

criteria_create(criteria: SelectiveRejectCriteria) → str[source]

Add User Selective Call Reject Criteria

Create a new Selective Call Reject Criteria for the authenticated user.

Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

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

Parameters:

criteria (SelectiveRejectCriteria) – Selective Call Reject Criteria settings

Return type:

str

criteria_delete(criteria_id: str)[source]

Delete a Selective Call Reject Criteria

Delete a Selective Call Reject Criteria for the authenticated user.

Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

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 selective call reject criteria.

Return type:

None

criteria_get(criteria_id: str) → SelectiveRejectCriteria[source]

Get Selective Call Reject Criteria Settings for User

Get Selective Call Reject Criteria Settings for the authenticated user.

Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

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 selective call reject criteria.

Return type:

SelectiveRejectCriteria

criteria_update(criteria: SelectiveRejectCriteria, criteria_id: str = None)[source]

Modify a Selective Call Reject Criteria

Modify Selective Call Reject Criteria Settings for the authenticated user.

Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

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

Parameters:

  • criteria (SelectiveRejectCriteria) – Selective Call Reject Criteria settings

  • criteria_id (str) – The criteria_id parameter specifies the unique identifier for the selective call reject. Default: id from criteria.

Return type:

None

base = 'telephony/config/people/me'