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'

virtual_line = 'VIRTUAL_LINE'

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

Bases: ApiModel

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, **extra_data: Any)

Bases: ApiModel

Hunt group or call queue alternate number

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, routingPrefix: str | None = None, esn: str | None = None, primary: bool | None = None, **extra_data: Any)

Bases: ApiModel

phone number of the person or workspace.

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.

routingPrefix: str | None

Routing prefix of location.

esn: str | None

Routing prefix + extension of a person or workspace.

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[UserNumber] | None = None, location: IdAndName | None = None, **extra_data: Any)

Bases: UserBase

Agent (person or place)

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[UserNumber] | None

List of phone numbers of the person or workspace.

location: IdAndName | None

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[UserNumber] | None = None, location: str | IdAndName | None = None, **extra_data: Any)

Bases: ApiModel

a monitored user or place

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[UserNumber] | None

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

location: str | IdAndName | None

property ci_member_id: str | None

property location_name: str

Apparently location attribute is either the location name or an IdAndName instance

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

Bases: ApiModel

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.

routingPrefix: str | None

Routing prefix of location.

esn: str | None

Routing prefix + extension of a person or workspace.

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.AuthCodeLevel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

location = 'LOCATION'

Indicates the location level access code.

custom = 'CUSTOM'

Indicates the workspace level access code.

class wxc_sdk.common.AuthCode(*, code: str, description: str, level: AuthCodeLevel | None = None, **extra_data: Any)

Bases: ApiModel

authorization code and description.

code: str

Indicates an authorization code.

description: str

Indicates the description of the authorization code.

level: AuthCodeLevel | None

Indicates the level of each access 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'

cisco_pstn = 'CISCO_PSTN'

cloud_connected_pstn = 'CLOUD_CONNECTED_PSTN'

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

Bases: ApiModel

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, **extra_data: Any)

Bases: ApiModel

route_id: str

name: str | None

route_type: RouteType

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

Bases: ApiModel

Customer information.

customer_id: str

ID of the customer/organization.

name: str

Name of the customer/organization.

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

Bases: ApiModel

id: str

class wxc_sdk.common.IdAndName(*, id: str, name: str | None = None, **extra_data: Any)

Bases: IdOnly

name: str | None

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'

The number is activated and has calling capability.

inactive = 'INACTIVE'

A number is not yet activated and has no calling capability.

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, **extra_data: Any)

Bases: ApiModel

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[ValidateExtensionStatus] | None = None, **extra_data: Any)

Bases: ApiModel

status: ValidationStatus

extension_status: list[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'

The phone number is available.

duplicate = 'Duplicate'

Duplicate phone number.

duplicate_in_list = 'Duplicate In List'

Duplicate phone number in the list.

invalid = 'Invalid'

The phone number is invalid.

unavailable = 'Unavailable'

The phone number is unavailable and cannot be used.

class wxc_sdk.common.ValidatePhoneNumberStatus(*, phoneNumber: str, state: ~wxc_sdk.common.ValidatePhoneNumberStatusState, tollFreeNumber: bool, detail: list[str] = <factory>, **extra_data: ~typing.Any)

Bases: ApiModel

phone_number: str

Phone number that need to be validated.

state: ValidatePhoneNumberStatusState

The state of the number.

toll_free_number: bool

If true, it’s a toll-free number.

detail: list[str]

Error details if the number is unavailable.

property ok

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

Bases: ApiModel

status: ValidationStatus

This indicates the status of the numbers.

phone_numbers: list[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, **extra_data: Any)

Bases: ApiModel

Settings for message storage

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, **extra_data: Any)

Bases: ApiModel

enabled: bool

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

Bases: VoicemailEnabled

Settings for notifications when there are any new voicemails.

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.

sms_destination: str | None

SMS destination for notification delivery. Must be a US or Canada phone number in E.164 format (e.g., +12025551212).

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

Bases: VoicemailEnabled

Fax message settings

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, **extra_data: Any)

Bases: VoicemailEnabled

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

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, **extra_data: Any)

Bases: VoicemailEnabled

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

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, **extra_data: Any)

Bases: ApiModel

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

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, **extra_data: Any)

Bases: ApiModel

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, nightlyResyncEnabled: bool | None = None, ataDtmfMode: AtaDtmfMode, ataDtmfMethod: AtaDtmfMethod, snmp: dict, webAccessEnabled: bool, **extra_data: Any)

Bases: CommonDeviceCustomization

settings that are applicable to ATA devices.

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

web_access_enabled: bool

Enable/disable user level web access to the local device.

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

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.

ata: AtaCustomization | None

dect: DectCustomization | 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, **extra_data: Any)

Bases: ApiModel

Device customization

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, nightlyResyncEnabled: bool | None = None, **extra_data: Any)

Bases: ApiModel

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.

nightly_resync_enabled: bool | None

Enable/disable automatic nightly configuration resync of the device.

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_min = 'ONE_MIN'

five_min = 'FIVE_MIN'

thirty_min = 'THIRTY_MIN'

always_on = 'ALWAYS_ON'

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, **extra_data: Any)

Bases: ApiModel

Background selection for MPP devices

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, **extra_data: Any)

Bases: ApiModel

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.EnabledAndValue(*, enabled: bool, value: int, **extra_data: Any)

Bases: ApiModel

enabled: bool

value: int

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

Bases: ApiModel

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

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: MppVlanDevice | None = None, nightlyResyncEnabled: bool | None = None, pnacEnabled: bool, backlightTimer: BacklightTimer | None = None, 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, enhancedMulticast: EnhancedMulticast | None = None, offHookTimer: int, phoneLanguage: PhoneLanguage, poeMode: str, screenTimeout: EnabledAndValue, usbPortsEnabled: bool | None = None, usbPorts: UsbPortsObject | None = None, wifiNetwork: WifiNetwork | None = None, migrationUrl: str | None = None, callHistory: CallHistoryMethod | None = None, contacts: DirectoryMethod | None = None, webexMeetingsEnabled: bool | None = None, volumeSettings: VolumeSettings | None = None, cfExpandedSoftKey: CallForwardExpandedSoftKey | None = None, httpProxy: HttpProxy | None = None, bluetooth: BluetoothSetting | None = None, passThroughPortEnabled: bool | None = None, userPasswordOverrideEnabled: bool | None = None, activeCallFocusEnabled: bool | None = None, peerFirmwareEnabled: bool | None = None, noiseCancellation: NoiseCancellation | None = None, voiceFeedbackAccessibilityEnabled: bool | None = None, dialAssistEnabled: bool | None = None, callsPerLine: int | None = None, missedCallNotificationEnabled: bool | None = None, softKeyLayout: SoftKeyLayout | None = None, backgroundImage8875: BackgroundImageColor | None = None, backlightTimer68XX78XX: BacklightTimer68XX78XX | None = None, allowMonitorLinesEnabled: bool | None = None, iceEnabled: bool | None = None, **extra_data: Any)

Bases: CommonDeviceCustomization

settings that are applicable to MPP devices.

pnac_enabled: bool

Indicates whether PNAC of MPP object is enabled or not

backlight_timer: BacklightTimer | None

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

Holds the Acd object value.

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).

enhanced_multicast: EnhancedMulticast | None

Specify the enhanced multicast settings for the MPP device.

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: EnabledAndValue

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.

usb_ports: UsbPortsObject | None

By default the Side USB port is enabled to support KEMs and other peripheral devices. Use the option to disable use of this port.

vlan: MppVlanDevice | None

Specify a numeric Virtual LAN ID for devices.

wifi_network: WifiNetwork | None

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

migration_url: str | None

call_history: CallHistoryMethod | None

Specify the call history information to use. Only applies to user devices.

contacts: DirectoryMethod | None

Specify the directory services to use.

webex_meetings_enabled: bool | None

Enable/disable the availability of the webex meetings functionality from the phone.

volume_settings: VolumeSettings | None

Specify all volume level values on the phone.

cf_expanded_soft_key: CallForwardExpandedSoftKey | None

Specify the call forward expanded soft key behavior.

http_proxy: HttpProxy | None

Specify HTTP Proxy values.

bluetooth: BluetoothSetting | None

Enable/disable the visibility of the bluetooth menu on the MPP device.

pass_through_port_enabled: bool | None

Enable/disable the use of the PC passthrough ethernet port on supported phone models.

user_password_override_enabled: bool | None

Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device.

active_call_focus_enabled: bool | None

Enable/disable the default screen behavior when inbound calls are received.

peer_firmware_enabled: bool | None

Enable/disable peer firmware sharing.

noise_cancellation: NoiseCancellation | None

Enable/disable local noise cancellation on active calls from the device.

voice_feedback_accessibility_enabled: bool | None

Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device.

dial_assist_enabled: bool | None

Enable/disable availability of dial assist feature on the phone.

calls_per_line: int | None

Specify the number of calls per unique line appearance on the phone.

missed_call_notification_enabled: bool | None

Enable/disable the visual indication of missed calls.

soft_key_layout: SoftKeyLayout | None

Specify the softkey layout per phone menu state.

background_image8875: BackgroundImageColor | None

Specify the image option for the MPP 8875 phone background.

backlight_timer_68xx78xx: BacklightTimer68XX78XX | None

Specify the use of the backlight feature on 6800 nad 7800 series devices.

allow_monitor_lines_enabled: bool | None

Enable/disable monitoring for MPP non-primary device.

ice_enabled: bool | None

Enable/disable SIP media streams to go directly between phones on the same local network.

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'

Primary line for the member.

shared_call_appearance = 'SHARED_CALL_APPEARANCE'

Shared line for the member. A shared line allows users to receive and place calls to and from another user’s extension, using their own device.

mobility = 'MOBILITY'

Device is a shared line.

hotdesking_guest = 'HOTDESKING_GUEST'

Device is a hotdesking guest.

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(*, id: str | None = None, fileName: str | None = None, fileSize: str | None = None, mediaFileType: MediaFileType | None = None, level: AnnouncementLevel | None = None, **extra_data: Any)

Bases: ApiModel

Announcement Audio Files

id: str | None

A unique identifier for the announcement. name, mediaFileType, level are mandatory if id is not provided for uploading an announcement.

file_name: str | None

Name of the file.

file_size: str | None

Size of greeting file in kilo-bytes.

media_file_type: MediaFileType | None

Media Type of the audio file.

level: AnnouncementLevel | None

Audio announcement file type location.

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

Bases: ApiModel

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.

class wxc_sdk.common.LinkRelation(*, rel: str | None = None, href: str | None = None, method: str | None = None, **extra_data: Any)

Bases: ApiModel

rel: str | None

Link relation describing how the target resource is related to the current context (conforming with RFC5998).

href: str | None

Target resource URI (conforming with RFC5998).

method: str | None

Target resource method (conforming with RFC5998).

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

Bases: SafeEnum

An enumeration.

organization = 'ORGANIZATION'

Specifies this audio file is configured across organization.

location = 'LOCATION'

Specifies this audio file is configured across location.

entity = 'ENTITY'

Specifies this audio file is configured on instance level.

class wxc_sdk.common.UsbPortsObject(*, enabled: bool | None = None, sideUsbEnabled: bool | None = None, rearUsbEnabled: bool | None = None, **extra_data: Any)

Bases: ApiModel

enabled: bool | None

New Control to Enable/Disable the side USB port.

side_usb_enabled: bool | None

Enable/disable use of the side USB port on the MPP device. Enabled by default.

rear_usb_enabled: bool | None

Enable/disable use of the rear USB port on the MPP device.

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

Bases: str, SafeEnum

An enumeration.

none = 'NONE'

No authentication.

eap_fast = 'EAP_FAST'

Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authentication.

peap_gtc = 'PEAP_GTC'

Protected Extensible Authentication Protocol - Generic Token Card. Requires username and password authentication.

peap_mschapv2 = 'PEAP_MSCHAPV2'

Protected Extensible Authentication Protocol - Microsoft Challenge Handshake Authentication Protocol version 2. Requires username and password authentication.

psk = 'PSK'

Pre-Shared Key. Requires shared passphrase for authentication.

wep = 'WEP'

Wired Equivalent Privacy. Requires encryption key for authentication.

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

Bases: str, SafeEnum

An enumeration.

xsi_directory = 'XSI_DIRECTORY'

Set directory services to use standard XSI query method from the device.

webex_directory = 'WEBEX_DIRECTORY'

Set directory services to use the Webex Enterprise directory.

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

Bases: str, SafeEnum

An enumeration.

unified = 'WEBEX_UNIFIED_CALL_HISTORY'

Set call history to use the unified call history from all of the end user’s devices.

local = 'LOCAL_CALL_HISTORY'

Set call history to use local device information only.

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

Bases: EnabledAndValue

pc_port: int | None

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

class wxc_sdk.common.VolumeSettings(*, ringerVolume: int | None = None, speakerVolume: int | None = None, handsetVolume: int | None = None, headsetVolume: int | None = None, eHookEnabled: bool | None = None, allowEndUserOverrideEnabled: bool | None = None, **extra_data: Any)

Bases: ApiModel

ringer_volume: int | None

Specify a ringer volume level through a numeric value between 0 and 15.

speaker_volume: int | None

Specify a speaker volume level through a numeric value between 0 and 15.

handset_volume: int | None

Specify a handset volume level through a numeric value between 0 and 15.

headset_volume: int | None

Specify a headset volume level through a numeric value between 0 and 15.

e_hook_enabled: bool | None

Enable/disable the wireless headset hookswitch control.

allow_end_user_override_enabled: bool | None

Enable/disable to preserve the existing values on the phone and not the values defined for the device settings.

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

Bases: str, SafeEnum

An enumeration.

only_the_call_forward_all = 'ONLY_THE_CALL_FORWARD_ALL'

Set the default call forward expanded soft key behavior to single option.

all_call_forwards = 'ALL_CALL_FORWARDS'

Set the default call forward expanded soft key behavior to multiple menu option.

class wxc_sdk.common.HttpProxy(*, mode: HttpProxyMode | None = None, autoDiscoveryEnabled: bool | None = None, host: str | None = None, port: str | None = None, packUrl: str | None = None, authSettingsEnabled: bool | None = None, username: str | None = None, password: str | None = None, **extra_data: Any)

Bases: ApiModel

mode: HttpProxyMode | None

Mode of the HTTP proxy.

auto_discovery_enabled: bool | None

Enable/disable auto discovery of the URL.

host: str | None

Specify the host URL if the HTTP mode is set to MANUAL.

port: str | None

Specify the port if the HTTP mode is set to MANUAL.

pack_url: str | None

Specify PAC URL if auto discovery is disabled.

auth_settings_enabled: bool | None

Enable/disable authentication settings.

username: str | None

Specify a username if authentication settings are enabled.

password: str | None

Specify a password if authentication settings are enabled.

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

Bases: str, SafeEnum

An enumeration.

off = 'OFF'

auto = 'AUTO'

manual = 'MANUAL'

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

Bases: str, SafeEnum

An enumeration.

phone = 'PHONE'

hands_free = 'HANDS_FREE'

both = 'BOTH'

class wxc_sdk.common.BluetoothSetting(*, enabled: bool | None = None, mode: BluetoothMode | None = None, **extra_data: Any)

Bases: ApiModel

enabled: bool | None

Enable/disable Bluetooth.

mode: BluetoothMode | None

Select a Bluetooth mode.

class wxc_sdk.common.NoiseCancellation(*, enabled: bool | None = None, allowEndUserOverrideEnabled: bool | None = None, **extra_data: Any)

Bases: ApiModel

enabled: bool | None

Enable/disable the Noise Cancellation.

allow_end_user_override_enabled: bool | None

Enable/disable to preserve the existing values on the phone and not the value defined for the device setting.

class wxc_sdk.common.SoftKeyLayout(*, softKeyMenu: SoftKeyMenu | None = None, psk: PskObject | None = None, softKeyMenuDefaults: SoftKeyMenu | None = None, pskDefaults: PskObject | None = None, **extra_data: Any)

Bases: ApiModel

soft_key_menu: SoftKeyMenu | None

Customize SoftKey menu settings.

psk: PskObject | None

Customize PSK.

soft_key_menu_defaults: SoftKeyMenu | None

Default SoftKey menu settings.

psk_defaults: PskObject | None

Default PSK.

class wxc_sdk.common.SoftKeyMenu(*, idleKeyList: str | None = None, offHookKeyList: str | None = None, dialingInputKeyList: str | None = None, progressingKeyList: str | None = None, connectedKeyList: str | None = None, connectedVideoKeyList: str | None = None, startTransferKeyList: str | None = None, startConferenceKeyList: str | None = None, conferencingKeyList: str | None = None, releasingKeyList: str | None = None, holdKeyList: str | None = None, ringingKeyList: str | None = None, sharedActiveKeyList: str | None = None, sharedHeldKeyList: str | None = None, **extra_data: Any)

Bases: ApiModel

idle_key_list: str | None

Specify the idle key list.

off_hook_key_list: str | None

Specify the off hook key list.

dialing_input_key_list: str | None

Specify the dialing input key list.

progressing_key_list: str | None

Specify the progressing key list.

connected_key_list: str | None

Specify the connected key list.

connected_video_key_list: str | None

Specify the connected video key list.

start_transfer_key_list: str | None

Start the transfer key list.

start_conference_key_list: str | None

Start the conference key list.

conferencing_key_list: str | None

Specify the conferencing key list.

releasing_key_list: str | None

Specify the releasing key list.

hold_key_list: str | None

Specify the hold key list.

ringing_key_list: str | None

Specify the ringing key list.

shared_active_key_list: str | None

Specify the shared active key list.

shared_held_key_list: str | None

Specify the shared held key list.

class wxc_sdk.common.PskObject(*, psk1: str | None = None, psk2: str | None = None, psk3: str | None = None, psk4: str | None = None, psk5: str | None = None, psk6: str | None = None, psk7: str | None = None, psk8: str | None = None, psk9: str | None = None, psk10: str | None = None, psk11: str | None = None, psk12: str | None = None, psk13: str | None = None, psk14: str | None = None, psk15: str | None = None, psk16: str | None = None, **extra_data: Any)

Bases: ApiModel

psk1: str | None

Specify PSK1.

psk2: str | None

Specify PSK2.

psk3: str | None

Specify PSK3.

psk4: str | None

Specify PSK4.

psk5: str | None

Specify PSK5.

psk6: str | None

Specify PSK6.

psk7: str | None

Specify PSK7.

psk8: str | None

Specify PSK8.

psk9: str | None

Specify PSK9.

psk10: str | None

Specify PSK10.

psk11: str | None

Specify PSK11.

psk12: str | None

Specify PSK12.

psk13: str | None

Specify PSK13.

psk14: str | None

Specify PSK14.

psk15: str | None

Specify PSK15.

psk16: str | None

Specify PSK16.

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

Bases: str, SafeEnum

An enumeration.

cyan_dark = 'CYAN_DARK'

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

purple_dark = 'PURPLE_DARK'

Indicates the dark purple background image will be set for the devices.

blue_dark = 'BLUE_DARK'

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

violet_dark = 'VIOLET_DARK'

Indicates the dark violet background image will be set for the devices.

blue_light = 'BLUE_LIGHT'

Indicates the light blue background image will be set for the devices.

violet_light = 'VIOLET_LIGHT'

Indicates the light violet background image will be set for the devices.

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

Bases: str, SafeEnum

An enumeration.

always_on = 'ALWAYS_ON'

Keep the phone’s backlight always on.

ten_sec = 'TEN_SEC'

Set the phone’s backlight to be on for ten seconds.

twenty_sec = 'TWENTY_SEC'

Set the phone’s backlight to be on for twenty seconds.

thirty_sec = 'THIRTY_SEC'

Set the phone’s backlight to be on for thirty seconds.

off = 'OFF'

Keep the phone’s backlight off.

class wxc_sdk.common.DectCustomization(*, audioCodecPriority: AudioCodecPriority, cdpEnabled: bool, lldpEnabled: bool, qosEnabled: bool, vlan: VlanSetting, nightlyResyncEnabled: bool | None = None, webAccessEnabled: bool, **extra_data: Any)

Bases: CommonDeviceCustomization

web_access_enabled: bool

Enable/disable user level web access to the local device.

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

Bases: str, SafeEnum

An enumeration.

place = 'PLACE'

The PSTN phone number’s owner is a workspace.

people = 'PEOPLE'

The phone number’s owner is a person.

virtual_line = 'VIRTUAL_LINE'

The PSTN phone number’s owner is a virtual line.

auto_attendant = 'AUTO_ATTENDANT'

The PSTN phone number’s owner is an auto-attendant.

call_queue = 'CALL_QUEUE'

The PSTN phone number’s owner is a call queue.

paging_group = 'PAGING_GROUP'

The PSTN phone number’s owner is a paging group.

hunt_group = 'HUNT_GROUP'

The PSTN phone number’s owner is a hunt group.

voice_messaging = 'VOICE_MESSAGING'

The PSTN phone number’s owner is a voice messaging.

office_anywhere = 'OFFICE_ANYWHERE'

The PSTN phone number’s owner is a Single Number Reach.

broadworks_anywhere = 'BROADWORKS_ANYWHERE'

PSTN phone number’s owner is a Single Number Reach.

contact_center_link = 'CONTACT_CENTER_LINK'

The PSTN phone number’s owner is a Contact Center link.

contact_center_adapter = 'CONTACT_CENTER_ADAPTER'

The PSTN phone number’s owner is a Contact Center adapter.

route_list = 'ROUTE_LIST'

The PSTN phone number’s owner is a route list.

voicemail_group = 'VOICEMAIL_GROUP'

The PSTN phone number’s owner is a voicemail group.

collaborate_bridge = 'COLLABORATE_BRIDGE'

The PSTN phone number’s owner is a collaborate bridge.

class wxc_sdk.common.NumberOwner(*, id: str | None = None, type: OwnerType | None = None, lastName: str | None = None, firstName: str | None = None, displayName: str | None = None, **extra_data: Any)

Bases: ApiModel

Owner of a phone number

owner_id: str | None

ID of the owner to which PSTN Phone number is assigned.

owner_type: OwnerType | None

Type of the PSTN phone number’s owner

last_name: str | None

Last name of the PSTN phone number’s owner

first_name: str | None

First name of the PSTN phone number’s owner

display_name: str | None

Display name of the PSTN phone number’s owner and will only be returned when the owner type is a Feature.

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

Bases: str, SafeEnum

An enumeration.

apply_template = 'APPLY_TEMPLATE'

Used to apply LinekeyTemplate to devices.

apply_default_templates = 'APPLY_DEFAULT_TEMPLATES'

Used to reset devices to its default Linekey Template configurations.

class wxc_sdk.common.AssignedDectNetwork(*, id: str | None = None, name: str | None = None, primaryEnabled: bool | None = None, numberOfHandsetsAssigned: int | None = None, location: IdAndName | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for a dect network.

name: str | None

Identifier for device DECT network.

primary_enabled: bool | None

Indicates whether the virtual profile is the primary line.

number_of_handsets_assigned: int | None

Number of dect handsets assigned to the virtual profile.

location: IdAndName | None

Location details of virtual line.

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

Bases: str, SafeEnum

An enumeration.

cisco = 'cisco'

microsoft_teams_room = 'microsoftTeamsRoom'

class wxc_sdk.common.Multicast(*, hostAndPort: str | None = None, hasXmlAppUrl: bool | None = None, xmlAppTimeout: int | None = None, **extra_data: Any)

Bases: ApiModel

host_and_port: str | None

Specify the multicast group URL and listening port.

has_xml_app_url: bool | None

Specify whether the multicast group URL has an XML application URL.

xml_app_timeout: int | None

Specify the timeout for the XML application.

class wxc_sdk.common.EnhancedMulticast(*, xmlAppUrl: str | None = None, multicastList: list[Multicast] | None = None, **extra_data: Any)

Bases: ApiModel

xml_app_url: str | None

Specify the URL for the XML application.

multicast_list: list[Multicast] | None

Specify up to 10 multicast group URLs each with a unique listening port, an XML application URL, and a timeout.

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

Bases: str, SafeEnum

An enumeration.

mpp = 'MPP'

Cisco Multiplatform Phone

ata = 'ATA'

Analog Telephone Adapters

generic_sip = 'GENERIC_SIP'

GENERIC Session Initiation Protocol

esim = 'ESIM'

Esim Supported Webex Go

desk_phone = 'DESK_PHONE'

Desk Phone

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

Bases: str, SafeEnum

An enumeration.

basic_user = 'BASIC_USER'

Member is a Webex Calling standard user

professional_user = 'PROFESSIONAL_USER'

Member is a Webex Calling professional user

workspace = 'WORKSPACE'

Member is a Webex Calling Common area workspace

professional_workspace = 'PROFESSIONAL_WORKSPACE'

Member is a Webex Calling professional workspace

virtual_profile = 'VIRTUAL_PROFILE'

Member is a Webex Calling virtual line

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

Bases: str, SafeEnum

An enumeration.

off = 'off'

on = 'on'

upcoming = 'upcoming'

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

Bases: str, SafeEnum

An enumeration.

set = 'SET'

clear = 'CLEAR'

class wxc_sdk.common.MeGroupSettings(*, groupName: str | None = None, memberList: list[MeGroupMember] | None = None, **extra_data: Any)

Bases: ApiModel

group_name: str | None

Unique name for the call park. The maximum length is 80..

member_list: list[MeGroupMember] | None

List of members in the call park group.

class wxc_sdk.common.MeGroupMember(*, id: str | None = None, type: UserType | None = None, firstName: str | None = None, lastName: str | None = None, displayName: str | None = None, departmentName: str | None = None, directNumber: str | None = None, extension: str | None = None, email: str | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier of the member.

type: UserType | None

first_name: str | None

First name of the member.

last_name: str | None

Last name of the member.

display_name: str | None

Display name of the member.

department_name: str | None

Department name of the member.

direct_number: str | None

Direct number of the member.

extension: str | None

Extension of the member.

email: str | None

Email address of the member.

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

Bases: str, SafeEnum

An enumeration.

primary = 'PRIMARY'

Primary number to call.

secondary = 'SECONDARY'

Secondary number to call, if available.

class wxc_sdk.common.MediaFile(*, name: str | None = None, mediaType: str | None = None, **extra_data: Any)

Bases: ApiModel

name: str | None

File name of the custom greeting uploaded.

media_type: str | None

Media type of the custom greeting uploaded.

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

Bases: str, SafeEnum

An enumeration.

device_owner = 'DEVICE_OWNER'

shared_line = 'SHARED_LINE'

class wxc_sdk.common.DirectLineCallerIdName(*, selection: DirectLineCallerIdNameSelection | None = None, customName: str | None = None, **extra_data: Any)

Bases: ApiModel

selection: DirectLineCallerIdNameSelection | None

The selection of the direct line caller ID name.

custom_name: str | None

Sets or clears the custom direct line caller ID name. To clear the customName, the attribute must be set to null or empty string. Required if selection is set to CUSTOM_NAME.

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

Bases: str, SafeEnum

An enumeration.

custom_name = 'CUSTOM_NAME'

When this option is selected, customName is to be shown for this user.

first_name_last_name = 'FIRSTNAME_LASTNAME'

When this option is selected, firstName and lastName are to be shown for this user.

last_name_first_name = 'LASTNAME_FIRSTNAME'

When this option is selected, lastName and firstName are to be shown for this user.

display_name = 'DISPLAY_NAME'

When this option is selected, displayName is to be shown for this user.

Submodules

• wxc_sdk.common.schedules module
  • ScheduleApi
    • ScheduleApi.__init__()
    • 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()
  • 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_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.level
    • Schedule.location_name
    • Schedule.location_id
    • Schedule.schedule_type
    • Schedule.events
    • Schedule.Config
      • Schedule.Config.json_encoders
    • Schedule.business()
  • ScheduleApiBase
    • ScheduleApiBase.locations
    • ScheduleApiBase.people
  • ScheduleLevel
    • ScheduleLevel.location
    • ScheduleLevel.organization
    • ScheduleLevel.people
• wxc_sdk.common.selective module
  • SelectiveScheduleLevel
    • SelectiveScheduleLevel.group
    • SelectiveScheduleLevel.global_
  • SelectiveFrom
    • SelectiveFrom.any_phone_number
    • SelectiveFrom.select_phone_numbers
    • SelectiveFrom.any_internal
    • SelectiveFrom.any_external
  • SelectiveCriteria
    • SelectiveCriteria.id
    • SelectiveCriteria.schedule_name
    • SelectiveCriteria.schedule_type
    • SelectiveCriteria.schedule_level
    • SelectiveCriteria.calls_from
    • SelectiveCriteria.anonymous_callers_enabled
    • SelectiveCriteria.unavailable_callers_enabled
    • SelectiveCriteria.phone_numbers
    • SelectiveCriteria.enabled
  • SelectiveCrit
    • SelectiveCrit.id
    • SelectiveCrit.schedule_name
    • SelectiveCrit.source
    • SelectiveCrit.enabled