wxc_sdk.common.selective module

class wxc_sdk.common.selective.SelectiveScheduleLevel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

group = 'GROUP': Indicates schedule specified is of GROUP level.

global_ = 'GLOBAL'

class wxc_sdk.common.selective.SelectiveFrom(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

any_phone_number = 'ANY_PHONE_NUMBER': Criteria applies to all incoming numbers.

select_phone_numbers = 'SELECT_PHONE_NUMBERS': Criteria applies only for specific incoming numbers.

class wxc_sdk.common.selective.SelectiveCriteria(*, 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[str] | None = None, enabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None: Unique identifier for criteria.

schedule_name: str | None: Name of the location’s schedule which determines when the sequential ring is in effect. Creating criteria without schedule_name nor schedule_type creates a criteria for all hours all days

schedule_type: ScheduleType | None: This indicates the type of schedule. Creating criteria without schedule_name nor schedule_type creates a criteria for all hours all days

schedule_level: SelectiveScheduleLevel | None: This indicates the level of the schedule specified by scheduleName.

calls_from: SelectiveFrom | None: This indicates if criteria are applicable for calls from any phone number or selected phone numbers.

anonymous_callers_enabled: bool | None: When true incoming calls from private numbers are allowed. This is only applicable when callsFrom is set to SELECT_PHONE_NUMBERS.

unavailable_callers_enabled: bool | None: When true incoming calls from unavailable numbers are allowed. This is only applicable when callsFrom is set to SELECT_PHONE_NUMBERS.

phone_numbers: list[str] | None: When callsFrom is set to SELECT_PHONE_NUMBERS, indicates a list of incoming phone numbers for which the criteria apply.

enabled: bool | None: When set to true selective treatment enabled for calls that meet the current criteria. Criteria with enabled set to false take priority.

class wxc_sdk.common.selective.SelectiveSource(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

all_numbers = 'ALL_NUMBERS': Criteria applies to all incoming numbers.

specific_numbers = 'SPECIFIC_NUMBERS': Criteria applies only for specific incoming numbers.

class wxc_sdk.common.selective.SelectiveCrit(*, id: str | None = None, scheduleName: str | None = None, source: SelectiveSource | None = None, enabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None: Unique identifier for criteria.

schedule_name: str | None: Name of the location’s schedule which determines when the sequential ring is in effect.

source: SelectiveSource | None: Indicates if criteria are applicable for calls from any phone number or specific phone number.

enabled: bool | None: When set to true selective treatment is enabled for calls that meet the current criteria. Criteria with enabled set to false take priority.