wxc_sdk.me.selective_accept package

class wxc_sdk.me.selective_accept.MeSelectiveAcceptApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

get() → SelectiveAccept[source]

Get Selective Call Accept Settings for User

Get Selective Call Accept Settings for the authenticated user.

Selective Call Accept allows you to create customized rules to accept 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:

SelectiveAccept

update(enabled: bool)[source]

Modify Selective Call Accept Settings for User

Update Selective Call Accept Settings for the authenticated user.

Selective Call Accept allows you to create customized rules to accept 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 accept is enabled or not.

Return type:

None

criteria_create(criteria: SelectiveAcceptCriteria) → str[source]

Add User Selective Call Accept Criteria

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

Selective Call Accept allows you to create customized rules to accept 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 (SelectiveAcceptCriteria) – Selective Call Accept Criteria settings

Return type:

str

criteria_delete(criteria_id: str)[source]

Delete a Selective Call Accept Criteria

Delete a Selective Call Accept Criteria for the authenticated user.

Selective Call Accept allows you to create customized rules to accept 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 accept criteria.

Return type:

None

criteria_get(criteria_id: str) → SelectiveAcceptCriteria[source]

Get Selective Call Accept Criteria Settings for User

Get Selective Call Accept Criteria Settings for the authenticated user.

Selective Call Accept allows you to create customized rules to accept 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 accept criteria.

Return type:

SelectiveAcceptCallCriteriaGet

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

Modify a Selective Call Accept Criteria

Modify Selective Call Accept Criteria Settings for the authenticated user.

Selective Call Accept allows you to create customized rules to accept 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 (SelectiveAcceptCriteria) – Selective Call Accept Criteria settings

  • criteria_id (str) – Specifies the unique identifier for the selective call accept criteria. Default: id from criteria

Return type:

None

base = 'telephony/config/people/me'