wxc_sdk.common package

Common date types and APIs

class wxc_sdk.common.UserType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

people = 'PEOPLE'

place = 'PLACE'

class wxc_sdk.common.UserBase(*, firstName: str | None = None, lastName: str | None = None, type: UserType | None = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

first_name: str | None

last_name: str | None

user_type: UserType | None

class wxc_sdk.common.RingPattern(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

Ring Pattern

normal = 'NORMAL'

Normal incoming ring pattern.

long_long = 'LONG_LONG'

Incoming ring pattern of two long rings.

short_short_long = 'SHORT_SHORT_LONG'

Incoming ring pattern of two short rings, followed by a short ring.

short_long_short = 'SHORT_LONG_SHORT'

Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.

class wxc_sdk.common.AlternateNumber(*, phoneNumber: str | None = None, ringPattern: RingPattern | None = None, tollFreeNumber: bool | None = None)

Bases: ApiModel

Hunt group or call queue alternate number

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

phone_number: str | None

Alternate phone number for the hunt group or call queue

ring_pattern: RingPattern | None

Ring pattern for when this alternate number is called. Only available when distinctiveRing is enabled for the hunt group.

toll_free_number: bool | None

phone_number is a toll free number

Type:

Flag

class wxc_sdk.common.Greeting(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

DEFAULT indicates that a system default message will be placed when incoming calls are intercepted.

custom = 'CUSTOM'

A custom will be placed when incoming calls are intercepted.

default = 'DEFAULT'

A System default message will be placed when incoming calls are intercepted.

class wxc_sdk.common.UserNumber(*, external: str | None = None, extension: str | None = None, primary: bool | None = None)

Bases: ApiModel

phone number of the person or workspace.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

external: str | None

Phone number of person or workspace. Either phoneNumber or extension is mandatory

extension: str | None

Extension of person or workspace. Either phoneNumber or extension is mandatory.

primary: bool | None

Flag to indicate primary phone.

class wxc_sdk.common.PersonPlaceAgent(*, firstName: str | None = None, lastName: str | None = None, type: UserType | None = None, id: str, displayName: str | None = None, email: str | None = None, numbers: list[wxc_sdk.common.UserNumber] | None = None)

Bases: UserBase

Agent (person or place)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

agent_id: str

ID of person or workspace.

display_name: str | None

Display name of person or workspace.

email: str | None

Email of the person or workspace.

numbers: list[wxc_sdk.common.UserNumber] | None

List of phone numbers of the person or workspace.

class wxc_sdk.common.MonitoredMember(*, id: str | None = None, lastName: str | None = None, firstName: str | None = None, displayName: str | None = None, type: UserType | None = None, email: str | None = None, numbers: list[wxc_sdk.common.UserNumber] | None = None)

Bases: ApiModel

a monitored user or place

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

member_id: str | None

The identifier of the monitored person.

last_name: str | None

The last name of the monitored person or place.

first_name: str | None

The first name of the monitored person or place.

display_name: str | None

The display name of the monitored person or place.

member_type: UserType | None

Indicates whether type is PEOPLE or PLACE.

email: str | None

The email address of the monitored person or place.

numbers: list[wxc_sdk.common.UserNumber] | None

The list of phone numbers of the monitored person or place.

property ci_member_id: str | None

class wxc_sdk.common.CallParkExtension(*, id: str | None = None, name: str | None = None, extension: str | None = None, locationName: str | None = None, locationId: str | None = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

cpe_id: str | None

The identifier of the call park extension.

name: str | None

The name to describe the call park extension.

extension: str | None

The extension number for this call park extension.

location_name: str | None

The location name where the call park extension is.

location_id: str | None

The location ID for the location.

property ci_cpe_id: str | None

call park extension ID as UUID

class wxc_sdk.common.AuthCode(*, code: str, description: str)

Bases: ApiModel

authorization codea and description.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

code: str

Indicates an authorization code.

description: str

Indicates the description of the authorization code.

class wxc_sdk.common.RouteType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

route_group = 'ROUTE_GROUP'

Route group must include at least one trunk with a maximum of 10 trunks per route group.

trunk = 'TRUNK'

class wxc_sdk.common.DialPatternValidate(*, dialPattern: str, patternStatus: DialPatternStatus, message: str)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

dial_pattern: str

input dial pattern that is being validate

pattern_status: DialPatternStatus

validation status.

message: str

failure details.

class wxc_sdk.common.DialPatternStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

validation status.

invalid = 'INVALID'

invalid pattern

duplicate = 'DUPLICATE'

duplicate pattern

duplicate_in_list = 'DUPLICATE_IN_LIST'

duplicate in input

class wxc_sdk.common.RouteIdentity(*, id: str, name: str | None = None, type: RouteType)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

route_id: str

name: str | None

route_type: RouteType

class wxc_sdk.common.Customer(*, id: str, name: str)

Bases: ApiModel

Customer information.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

customer_id: str

ID of the customer/organization.

name: str

Name of the customer/organization.

class wxc_sdk.common.IdOnly(*, id: str)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

id: str

class wxc_sdk.common.IdAndName(*, id: str, name: str)

Bases: IdOnly

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

name: str

class wxc_sdk.common.PatternAction(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

add = 'ADD'

add action, when adding a new dial pattern

delete = 'DELETE'

delete action, when deleting an existing dial pattern

class wxc_sdk.common.NumberState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

active = 'ACTIVE'

inactive = 'INACTIVE'

class wxc_sdk.common.ValidationStatus(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

ok = 'OK'

errors = 'ERRORS'

class wxc_sdk.common.ValidateExtensionStatusState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

valid = 'VALID'

duplicate = 'DUPLICATE'

duplicate_in_list = 'DUPLICATE_IN_LIST'

invalid = 'INVALID'

class wxc_sdk.common.ValidateExtensionStatus(*, extension: str, state: ValidateExtensionStatusState, errorCode: int | None = None, message: str | None = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

extension: str

Indicates the extension id for which the status is about .

state: ValidateExtensionStatusState

Indicate the status for the given extension id .

error_code: int | None

Error Code .

message: str | None

property ok

class wxc_sdk.common.ValidateExtensionsResponse(*, status: ValidationStatus, extensionStatus: list[wxc_sdk.common.ValidateExtensionStatus] | None = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

status: ValidationStatus

extension_status: list[wxc_sdk.common.ValidateExtensionStatus] | None

property ok: bool

class wxc_sdk.common.ValidatePhoneNumberStatusState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

available = 'Available'

This means the phone number is available.

duplicate = 'Duplicate'

This means it’s a duplicate phone number.

duplicate_in_list = 'Duplicate In List'

This means it’s a duplicate phone number in the list.

invalid = 'Invalid'

The phone number is invalid.

unavailable = 'Unavailable'

This phone number is unavailable and cannot be used.

class wxc_sdk.common.ValidatePhoneNumberStatus(*, phoneNumber: str, state: ValidatePhoneNumberStatusState, tollFreeNumber: bool, detail: list[str] = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

phone_number: str

Phone number that need to be validated.

state: ValidatePhoneNumberStatusState

This indicates the state of the number.

toll_free_number: bool

This indicated whether it’s a toll-free number

detail: list[str]

This field has the details if error if the number is unavailable.

property ok

class wxc_sdk.common.ValidatePhoneNumbersResponse(*, status: ValidationStatus, phoneNumbers: list[wxc_sdk.common.ValidatePhoneNumberStatus] | None = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

status: ValidationStatus

This indicates the status of the numbers.

phone_numbers: list[wxc_sdk.common.ValidatePhoneNumberStatus] | None

This is an array of number objects with number details.

property ok: bool

class wxc_sdk.common.StorageType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

Designates which type of voicemail message storage is used.

internal = 'INTERNAL'

For message access via phone or the Calling User Portal.

external = 'EXTERNAL'

For sending all messages to the person’s email.

class wxc_sdk.common.VoicemailMessageStorage(*, mwiEnabled: bool | None = None, storageType: StorageType | None = None, externalEmail: str | None = None)

Bases: ApiModel

Settings for message storage

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

mwi_enabled: bool | None

When true desktop phone will indicate there are new voicemails.

storage_type: StorageType | None

Designates which type of voicemail message storage is used.

external_email: str | None

class wxc_sdk.common.VoicemailEnabled(*, enabled: bool)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

enabled: bool

class wxc_sdk.common.VoicemailNotifications(*, enabled: bool, destination: str | None = None)

Bases: VoicemailEnabled

Settings for notifications when there are any new voicemails.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

destination: str | None

Email address to which the notification will be sent. For text messages, use an email to text message gateway like 2025551212@txt.att.net.

class wxc_sdk.common.VoicemailFax(*, enabled: bool, extension: str | None = None, phoneNumber: str | None = None)

Bases: VoicemailEnabled

Fax message settings

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

extension: str | None

Designates optional extension for fax.

phone_number: str | None

Designates phone number for fax. A value for this field must be provided in the request if faxMessage enabled field is given as true in the request.

class wxc_sdk.common.VoicemailTransferToNumber(*, enabled: bool, destination: str | None = None)

Bases: VoicemailEnabled

Settings for voicemail caller to transfer to a different number by pressing zero (0).

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

destination: str | None

Number voicemail caller will be transferred to when they press zero (0).

class wxc_sdk.common.VoicemailCopyOfMessage(*, enabled: bool, emailId: str | None = None)

Bases: VoicemailEnabled

Settings for sending a copy of new voicemail message audio via email.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

email_id: str | None

Email address to which the new voicemail audio will be sent.

class wxc_sdk.common.AudioCodecPriority(*, selection: str, primary: str | None = None, secondary: str | None = None, tertiary: str | None = None)

Bases: ApiModel

Choose up to three predefined codec priority options available for your region.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

selection: str

Indicates the selection of an Audio Code Priority Object.

primary: str | None

Indicates the primary Audio Codec.

secondary: str | None

Indicates the secondary Audio Codec.

tertiary: str | None

Indicates the tertiary Audio Codec.

class wxc_sdk.common.AtaDtmfMode(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

DTMF Detection Tx Mode selection for Cisco ATA devices.

strict = 'STRICT'

It means a) DTMF digit requires an extra hold time after detection and b) DTMF level threshold is raised to -20 dBm.

normal = 'NORMAL'

It means normal threshold mode.

class wxc_sdk.common.AtaDtmfMethod(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

Method for transmitting DTMF signals to the far end.

inband = 'INBAND'

Sends DTMF by using the audio path.

avt = 'AVT'

Audio video transport. Sends DTMF as AVT events.

auto = 'AUTO'

class wxc_sdk.common.VlanSetting(*, enabled: bool, value: int, pcPort: int | None = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

enabled: bool

Denotes whether the VLAN object is enabled

value: int

The value of the VLAN Object

pc_port: int | None

Indicates the PC port value of a VLAN object for an MPP object

class wxc_sdk.common.AtaCustomization(*, audioCodecPriority: AudioCodecPriority, cdpEnabled: bool, lldpEnabled: bool, qosEnabled: bool, vlan: VlanSetting, ataDtmfMode: AtaDtmfMode, ataDtmfMethod: AtaDtmfMethod, snmp: dict)

Bases: CommonDeviceCustomization

settings that are applicable to ATA devices.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

ata_dtmf_mode: AtaDtmfMode

DTMF Detection Tx Mode selection for Cisco ATA devices.

ata_dtmf_method: AtaDtmfMethod

Method for transmitting DTMF signals to the far end.

snmp: dict

class wxc_sdk.common.DeviceCustomizations(*, ata: AtaCustomization | None = None, dect: CommonDeviceCustomization | None = None, mpp: MppCustomization | None = None, wifi: WifiCustomization | None = None)

Bases: ApiModel

Customization object of the device settings.

At the device level only one of ata, dect, and mpp is set. At location and org level all three customizations are set.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

ata: AtaCustomization | None

dect: CommonDeviceCustomization | None

mpp: MppCustomization | None

wifi: WifiCustomization | None

class wxc_sdk.common.DeviceCustomization(*, customizations: DeviceCustomizations, customEnabled: bool | None = None, updateInProgress: bool | None = None, deviceCount: int | None = None, lastUpdateTime: datetime | None = None)

Bases: ApiModel

Device customization

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

customizations: DeviceCustomizations

customization object of the device settings.

custom_enabled: bool | None

Indicates if customization is allowed at repective (location or device) level. If true - customized at this level. If false - not customized, using higher level config (location or org). Only present in location and device level customization response

update_in_progress: bool | None

Indicates the progress of the device update. Not present at device level

device_count: int | None

Indicates the device count. Not present at device level

last_update_time: datetime | None

Indicates the last updated time.

class wxc_sdk.common.CommonDeviceCustomization(*, audioCodecPriority: AudioCodecPriority, cdpEnabled: bool, lldpEnabled: bool, qosEnabled: bool, vlan: VlanSetting)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

audio_codec_priority: AudioCodecPriority

Choose up to three predefined codec priority options available for your region.

cdp_enabled: bool

Enable/disable Cisco Discovery Protocol for local devices.

lldp_enabled: bool

Enable/disable Link Layer Discovery Protocol for local devices.

qos_enabled: bool

Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform.

vlan: VlanSetting

Specify a numeric Virtual LAN ID for devices.

class wxc_sdk.common.BacklightTimer(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

one_m = 'ONE_M'

five_m = 'FIVE_M'

thirty_m = 'THIRTY_M'

always_on = 'ALWAYS_ON'

off = 'OFF'

class wxc_sdk.common.Background(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

no_background = 'NONE'

Indicates that there will be no background image set for the devices.

dark_blue = 'DARK_BLUE'

Indicates that dark blue background image will be set for the devices.

cisco_dark_blue = 'CISCO_DARK_BLUE'

Indicates that Cisco themed dark blue background image will be set for the devices.

webex_dark_blue = 'WEBEX_DARK_BLUE'

Indicates that Cisco webex dark blue background image will be set for the devices.

custom_background = 'CUSTOM_BACKGROUND'

Indicates that a custom background image will be set for the devices.

class wxc_sdk.common.BackgroundSelection(*, image: Background, customUrl: str | None = None)

Bases: ApiModel

Background selection for MPP devices

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

image: Background

custom_url: str | None

class wxc_sdk.common.DisplayNameSelection(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

person_number = 'PERSON_NUMBER'

Indicates that devices will display the person’s phone number, or if a person doesn’t have a phone number, the location number will be displayed.

person_first_then_last_name = 'PERSON_FIRST_THEN_LAST_NAME'

Indicates that devices will display the name in first name then last name format.

person_last_then_first_name = 'PERSON_LAST_THEN_FIRST_NAME'

Indicates that devices will display the name in last name then first name format.

class wxc_sdk.common.LoggingLevel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

standard = 'STANDARD'

Enables standard logging.

debugging = 'DEBUGGING'

Enables detailed debugging logging.

class wxc_sdk.common.DisplayCallqueueAgentSoftkey(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

Chooses the location of the Call Queue Agent Login/Logout softkey on Multi-Platform Phones.

front_page = 'FRONT_PAGE'

last_page = 'LAST_PAGE'

class wxc_sdk.common.AcdCustomization(*, enabled: bool, displayCallqueueAgentSoftkeys: str)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

enabled: bool

Indicates whether the ACD object is enabled.

display_callqueue_agent_softkeys: str

Indicates the call queue agent soft key value of an ACD object.

class wxc_sdk.common.LineKeyLabelSelection(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

Line key labels define the format of what’s shown next to line keys.

person_extension = 'PERSON_EXTENSION'

This will display the person extension, or if a person doesn’t have an extension, the person’s first name will be displayed.

person_first_then_last_name = 'PERSON_FIRST_THEN_LAST_NAME'

Indicates that devices will display the name in first name then last name format.

person_last_then_first_name = 'PERSON_LAST_THEN_FIRST_NAME'

Indicates that devices will display the name in last name then first name format.

class wxc_sdk.common.LineKeyLedPattern(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

default = 'DEFAULT'

preset_1 = 'PRESET_1'

class wxc_sdk.common.PhoneLanguage(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

person = 'PERSON_LANGUAGE'

Indicates a person’s announcement language.

arabic = 'ARABIC'

bulgarian = 'BULGARIAN'

catalan = 'CATALAN'

chinese_simplified = 'CHINESE_SIMPLIFIED'

chinese_traditional = 'CHINESE_TRADITIONAL'

croatian = 'CROATIAN'

czech = 'CZECH'

danish = 'DANISH'

dutch = 'DUTCH'

english_united_states = 'ENGLISH_UNITED_STATES'

english_united_kingdom = 'ENGLISH_UNITED_KINGDOM'

finnish = 'FINNISH'

french_canada = 'FRENCH_CANADA'

french_france = 'FRENCH_FRANCE'

german = 'GERMAN'

greek = 'GREEK'

hebrew = 'HEBREW'

hungarian = 'HUNGARIAN'

italian = 'ITALIAN'

japanese = 'JAPANESE'

korean = 'KOREAN'

norwegian = 'NORWEGIAN'

polish = 'POLISH'

portuguese_portugal = 'PORTUGUESE_PORTUGAL'

russian = 'RUSSIAN'

spanish_colombia = 'SPANISH_COLOMBIA'

spanish_spain = 'SPANISH_SPAIN'

slovak = 'SLOVAK'

swedish = 'SWEDISH'

slovenian = 'SLOVENIAN'

turkish = 'TURKISH'

ukraine = 'UKRAINE'

class wxc_sdk.common.ScreenTimeout(*, enabled: bool, value: int)

Bases: ApiModel

Specify the amount of inactive time needed (in seconds) before the phone’s screen saver activates.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

enabled: bool

Indicates whether the Screen Time object is enabled.

value: int

Indicates the value of screen timeout.

class wxc_sdk.common.WifiNetwork(*, enabled: bool, authenticationMethod: str, ssidName: str | None = None, userId: str | None = None)

Bases: ApiModel

Specify the Wi-Fi SSID and password for wireless-enabled MPP phones.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

enabled: bool

Indicates whether the wifi network is enabled.

authentication_method: str

Authentication method of wifi network.

ssid_name: str | None

SSID name of the wifi network.

user_id: str | None

User ID of the wifi network.

class wxc_sdk.common.MppCustomization(*, audioCodecPriority: AudioCodecPriority, cdpEnabled: bool, lldpEnabled: bool, qosEnabled: bool, vlan: VlanSetting, pnacEnabled: bool, backlightTimer: BacklightTimer, background: BackgroundSelection, displayNameFormat: DisplayNameSelection, defaultLoggingLevel: LoggingLevel, dndServicesEnabled: bool, displayCallqueueAgentSoftkeys: DisplayCallqueueAgentSoftkey | None = None, hotelingGuestAssociationTimer: int | None = None, acd: AcdCustomization, shortInterdigitTimer: int, longInterdigitTimer: int, lineKeyLabelFormat: LineKeyLabelSelection, lineKeyLEDPattern: LineKeyLedPattern, mppUserWebAccessEnabled: bool, multicast: list[str] | None = None, offHookTimer: int, phoneLanguage: PhoneLanguage, poeMode: str, screenTimeout: ScreenTimeout, usbPortsEnabled: bool | None = None, wifiNetwork: WifiNetwork)

Bases: CommonDeviceCustomization

settings that are applicable to MPP devices.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

pnac_enabled: bool

Indicates whether PNAC of MPP object is enabled or not

backlight_timer: BacklightTimer

Choose the length of time (in minutes) for the phone’s backlight to remain on.

background: BackgroundSelection

Holds the background object of MPP Object.

display_name_format: DisplayNameSelection

The display name that appears on the phone screen.

default_logging_level: LoggingLevel

Choose the desired logging level for an MPP devices

dnd_services_enabled: bool

Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones.

display_callqueue_agent_softkeys: DisplayCallqueueAgentSoftkey | None

Chooses the location of the Call Queue Agent Login/Logout softkey on Multi-Platform Phones.

hoteling_guest_association_timer: int | None

Choose the duration (in hours) of Hoteling guest login.

acd: AcdCustomization

short_interdigit_timer: int

Indicates the short inter digit timer value.

long_interdigit_timer: int

Indicates the long inter digit timer value.

line_key_label_format: LineKeyLabelSelection

Line key labels define the format of what’s shown next to line keys.

line_key_led_pattern: LineKeyLedPattern

LED patterns define lighting schemes for the line keys on the MPP devices. Note – This parameter is not supported on the MPP 8875

mpp_user_web_access_enabled: bool

Enable/disable user-level access to the web interface of Multi-Platform Phones.

multicast: list[str] | None

Select up to 10 Multicast Group URLs (each with a unique Listening Port).

off_hook_timer: int

Specify the amount of time (in seconds) that a phone can remain off-hook.

phone_language: PhoneLanguage

Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location.

poe_mode: str

Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones.

screen_timeout: ScreenTimeout

Specify the amount of inactive time needed (in seconds) before the phone’s screen saver activates.

usb_ports_enabled: bool | None

Enable/disable the use of the USB ports on Multi-Platform phones.

wifi_network: WifiNetwork

Specify the Wi-Fi SSID and password for wireless-enabled MPP phones.

class wxc_sdk.common.PrimaryOrShared(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

primary = 'PRIMARY'

This indicates a Primary line for the member

shared = 'SHARED_CALL_APPEARANCE'

This indicates a Shared line for the member. Shared line appearance allows users to receive and place calls to and from another user’s extension, using their device.

mobility = 'MOBILITY'

class wxc_sdk.common.MediaFileType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

Media Type of the audio file.

wma = 'WMA'

WMA File Extension.

wav = 'WAV'

WAV File Extension.

three_gp = '3GP'

3GP File Extension.

class wxc_sdk.common.AnnAudioFile(*, fileName: str, mediaFileType: MediaFileType)

Bases: ApiModel

Announcement Audio Files

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

file_name: str

Name of the file.

media_file_type: MediaFileType

Media Type of the audio file.

class wxc_sdk.common.WifiCustomization(*, audioCodecPriority: AudioCodecPriority, ldap: Any = None, webAccess: Any = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

audio_codec_priority: AudioCodecPriority

Choose up to three predefined codec priority options available for your region.

ldap: Any

web_access: Any

class wxc_sdk.common.RoomType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

direct = 'direct'

1 room.

Type:

1

group = 'group'

Group room.

Submodules

• wxc_sdk.common.schedules module
  • ScheduleApi
    • ScheduleApi.list()
    • ScheduleApi.details()
    • ScheduleApi.create()
    • ScheduleApi.update()
    • ScheduleApi.delete_schedule()
    • ScheduleApi.event_details()
    • ScheduleApi.event_create()
    • ScheduleApi.event_update()
    • ScheduleApi.base
    • ScheduleApi.event_delete()
    • ScheduleApi.session
  • ScheduleType
    • ScheduleType.business_hours
    • ScheduleType.holidays
    • ScheduleType.type_or_str()
  • ScheduleMonth
    • ScheduleMonth.jan
    • ScheduleMonth.feb
    • ScheduleMonth.mar
    • ScheduleMonth.apr
    • ScheduleMonth.may
    • ScheduleMonth.jun
    • ScheduleMonth.jul
    • ScheduleMonth.aug
    • ScheduleMonth.sep
    • ScheduleMonth.oct
    • ScheduleMonth.nov
    • ScheduleMonth.dec
  • ScheduleDay
    • ScheduleDay.monday
    • ScheduleDay.tuesday
    • ScheduleDay.wednesday
    • ScheduleDay.thursday
    • ScheduleDay.friday
    • ScheduleDay.saturday
    • ScheduleDay.sunday
    • ScheduleDay.mon_to_fri()
  • ScheduleWeek
    • ScheduleWeek.first
    • ScheduleWeek.second
    • ScheduleWeek.third
    • ScheduleWeek.fourth
  • RecurWeekly
    • RecurWeekly.recur_interval
    • RecurWeekly.sunday
    • RecurWeekly.monday
    • RecurWeekly.tuesday
    • RecurWeekly.wednesday
    • RecurWeekly.thursday
    • RecurWeekly.friday
    • RecurWeekly.saturday
    • RecurWeekly.enable_day()
    • RecurWeekly.single_day()
  • RecurYearlyByDate
    • RecurYearlyByDate.day_of_month
    • RecurYearlyByDate.month
    • RecurYearlyByDate.from_date()
  • RecurYearlyByDay
    • RecurYearlyByDay.day
    • RecurYearlyByDay.week
    • RecurYearlyByDay.month
  • Recurrence
    • Recurrence.recur_for_ever
    • Recurrence.recur_end_date
    • Recurrence.recur_end_of_occurrence
    • Recurrence.recur_daily
    • Recurrence.recur_weekly
    • Recurrence.recur_yearly_by_date
    • Recurrence.recur_yearly_by_day
    • Recurrence.every_week()
  • Event
    • Event.event_id
    • Event.name
    • Event.new_name
    • Event.start_date
    • Event.end_date
    • Event.start_time
    • Event.end_time
    • Event.all_day_enabled
    • Event.recurrence
    • Event.Config
      • Event.Config.json_encoders
    • Event.day_start_end()
  • Schedule
    • Schedule.name
    • Schedule.new_name
    • Schedule.schedule_id
    • Schedule.location_name
    • Schedule.location_id
    • Schedule.schedule_type
    • Schedule.events
    • Schedule.Config
      • Schedule.Config.json_encoders
    • Schedule.business()
  • ScheduleApiBase
    • ScheduleApiBase.locations
    • ScheduleApiBase.people