wxc_sdk.me.selective_forward package

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

Bases: ApiChild

get() → SelectiveForward

Get Selective Call Forward Settings for User

Get Selective Call Forward Settings for the authenticated user.

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

SelectiveForward

update(forward: SelectiveForward) → None

Modify Selective Call Forward Settings for User

Update the Selective Call Forward 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:

forward (SelectiveForward) – Selective Call Forward Settings

Return type:

None

criteria_create(criteria: MeSelectiveForwardCriteria) → str

Add a Selective Call Forwarding Criteria

Create a Selective Call Forwarding Criteria for the authenticated user.

Selective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.

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

Parameters:

criteria (MeSelectiveForwardCriteria) – Selective Call Forward Criteria settings

Return type:

str

criteria_delete(criteria_id: str)

Delete a Selective Call Forwarding Criteria

Delete a Selective Call Forwarding Criteria for the authenticated user.

Selective call forwarding allows you to define rules that automatically forward incoming calls based on specific 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 selective call forwarding criteria.

Return type:

None

criteria_get(criteria_id: str) → MeSelectiveForwardCriteria

Get Settings for a Selective Call Forwarding Criteria

Get settings for a Selective Call Forwarding Criteria for the authenticated user.

Selective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.

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

Parameters:

criteria_id – The criteria_id parameter specifies the unique identifier for the selective call

forwarding criteria. :type criteria_id: str :rtype: MeSelectiveForwardCriteria

criteria_update(criteria: MeSelectiveForwardCriteria, criteria_id: str)

Modify Settings for a Selective Call Forwarding Criteria

Modify settings for a Selective Call Forwarding Criteria for the authenticated user.

Selective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.

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

Parameters:

• criteria (MeSelectiveForwardCriteria) – Selective Call Forward Criteria settings

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

Return type:

None

base = 'telephony/config/people/me'

class wxc_sdk.me.selective_forward.MeSelectiveForwardCriteria(*, id: str | None = None, scheduleName: str | None = None, scheduleType: ScheduleType | None = None, scheduleLevel: SelectiveScheduleLevel | None = None, callsFrom: SelectiveFrom | None = None, anonymousCallersEnabled: bool | None = None, unavailableCallersEnabled: bool | None = None, phoneNumbers: list[Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)]] | None = None, enabled: bool | None = None, forwardToPhoneNumber: Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)] | None = None, destinationVoicemailEnabled: bool | None = None, **extra_data: Any)

Bases: SelectiveCriteria

forward_to_phone_number: Annotated[str, BeforeValidator(func=e164, json_schema_input_type=PydanticUndefined)] | None

Phone number to forward calls to during this schedule.

destination_voicemail_enabled: bool | None

Indicates whether calls that meet the criteria are forwarded to the destination phone number’s voicemail.

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self – The BaseModel instance.

• context – The context.