wxc_sdk.telephony.devices.dynamic_settings package

class wxc_sdk.telephony.devices.dynamic_settings.SettingsType(*values)[source]

Bases: str, SafeEnum

An enumeration.

tabs = 'TABS'
groups = 'GROUPS'
all = 'ALL'
class wxc_sdk.telephony.devices.dynamic_settings.DeviceSettingsGroupTag(*, tagBlock: list[str] | None = None, **extra_data: Any)[source]

Bases: ApiModel

tag_block: list[str] | None

Array of tags associated with the settings group.

class wxc_sdk.telephony.devices.dynamic_settings.SettingsGroup(*, path: str | None = None, friendlyName: str | None = None, tab: str | None = None, familyOrModelDisplayName: str | None = None, tags: list[DeviceSettingsGroupTag] | None = None, **extra_data: Any)[source]

Bases: ApiModel

path: str | None

Path of the settings group. Creates an easily navigable settings hierarchy.

friendly_name: str | None

Friendly name of the settings group.

tab: str | None

Tab name associated with the settings group.

family_or_model_display_name: str | None

Family or model display name associated with the settings group.

tags: list[DeviceSettingsGroupTag] | None

List of tagBlock objects associated with the settings group.

class wxc_sdk.telephony.devices.dynamic_settings.DynamicSettingsGroups(*, settingsGroups: list[SettingsGroup] | None = None, settingsTabs: list[str] | None = None, **extra_data: Any)[source]

Bases: ApiModel

settings_groups: list[SettingsGroup] | None

Array of settings groups defining structure and association of tags.

settings_tabs: list[str] | None

Array of settings tabs names. Can be filtered using the includeSettingsType parameter.

class wxc_sdk.telephony.devices.dynamic_settings.ValidationRule(*, type: str | None = None, values: list[str] | None = None, min: int | float | None = None, max: int | float | None = None, increment: int | None = None, regex: str | None = None, maxLength: int | None = None, validationHint: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

type: str | None

The data type of the setting. Possible values are string, integer, boolean, enum , password or network.

values: list[str] | None

Possible values for enum or boolean types.

min: int | float | None

Minimum value for numeric types.

max_: int | float | None

Maximum value for numeric types.

increment: int | None

Increment value for numeric types.

regex: str | None

Regular expression pattern for string validation.

max_length: int | None

Maximum length for string values.

validation_hint: str | None

Hint to display to users about validation requirements.

class wxc_sdk.telephony.devices.dynamic_settings.DeviceTag(*, familyOrModelDisplayName: str | None = None, tag: str | None = None, friendlyName: str | None = None, tooltip: str | None = None, alert: str | None = None, level: list[str] | None = None, validationRule: ValidationRule | None = None, **extra_data: Any)[source]

Bases: ApiModel

family_or_model_display_name: str | None

The family or model name of the device to which these settings apply.

tag: str | None

The unique identifier for the setting.

friendly_name: str | None

A user-friendly name for the setting. It helps to correlate the tag with the UI in settings groups.

tooltip: str | None

Explanatory text for the setting.

alert: str | None

Alert message related to this setting, if applicable.

level: list[str] | None

The levels at which this setting can be configured. When fetching tags or updating tags, the tag should be allowed at the level the request is made for.

validation_rule: ValidationRule | None
class wxc_sdk.telephony.devices.dynamic_settings.DevicePutItem(*, tag: str | None = None, action: SetOrClear | None = None, value: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

tag: str | None

The unique identifier for the setting to be updated.

action: SetOrClear | None
value: str | None

The new value to set for the setting. This field is required when action is SET and ignored otherwise.

class wxc_sdk.telephony.devices.dynamic_settings.ParentLevel(*values)[source]

Bases: str, SafeEnum

An enumeration.

system_default = 'SYSTEM_DEFAULT'
regional_default = 'REGIONAL_DEFAULT'
organization = 'ORGANIZATION'
location = 'LOCATION'
class wxc_sdk.telephony.devices.dynamic_settings.DeviceDynamicTag(*, familyOrModelDisplayName: str | None = None, tag: str | None = None, value: str | None = None, parentValue: str | None = None, parentLevel: ParentLevel | None = None, **extra_data: Any)[source]

Bases: ApiModel

family_or_model_display_name: str | None

The familyOrModelDisplayName of the device.

tag: str | None

The unique identifier for the setting.

value: str | None

The current value of the setting at ORGANIZATION level. If the tag value is not set at the ORGANIZATION level, this field will not be included in the response.

parent_value: str | None

The value inherited from the immediate parent level above ORGANIZATION. It can be SYSTEM_DEFAULT, REGIONAL_DEFAULT, or ORGANIZATION, depending on which level the setting is actually configured at. If there is no parent level for this tag, this field will not be included in the response.

parent_level: ParentLevel | None
class wxc_sdk.telephony.devices.dynamic_settings.DeviceDynamicSettings(*, tags: list[DeviceDynamicTag] | None = None, lastUpdateTime: int | None = None, updateInProgress: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

tags: list[DeviceDynamicTag] | None

Array of device setting values matching the requested tags.

last_update_time: int | None

Timestamp of the last update to these settings.

update_in_progress: bool | None

Flag indicating if an update to these settings is currently in progress.

class wxc_sdk.telephony.devices.dynamic_settings.DevicesDynamicSettingsApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Telephony devices API

get_settings_groups(family_or_model_display_name: str = None, include_settings_type: SettingsType = None, org_id: str = None) → DynamicSettingsGroups[source]

Get Settings Groups

This API returns the settingsGroups that define the structure and association of tags for dynamic device settings.

The settingsGroups are used to organize the tags into logical groups, making it easier to manage and configure dynamic device settings.

Parameters:

  • family_or_model_display_name (str) – Device family or model display name to filter the settingsGroups.

  • include_settings_type (SettingsType) – To show groups or tabs or both. Query param is case insensitive. Default is ALL.

  • org_id (str) – Settings groups for devices in this organization.

Return type:

DynamicSettingsGroups

get_validation_schema(family_or_model_display_name: str = None, org_id: str = None) → list[DeviceTag][source]

Get Validation Schema

This API returns the validation schema for tags of all or specific familyOrModelDisplayName.

The schema is used to validate the tag for devices in the Webex Calling platform. The schema includes information about the required fields, data types, and validation rules for each setting.

Parameters:

  • family_or_model_display_name (str) – Device family or model display name to filter the schema.

  • org_id (str) – Validation schema for devices in this organization.

Return type:

list[DeviceTag]

update_specified_settings_for_the_device(device_id: str, tags: list[DevicePutItem] = None, org_id: str = None)[source]

Update specified settings for the device.

Modify dynamic settings for a specified device.

This API updates device settings based on the specified tags. If the tags field is empty, the request has no effect.

This requires a full, device, or read-only administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • device_id (str) – Device for which to update settings.

  • tags (list[DevicePutItem]) – Optional array of tag identifiers representing specific settings to update. If omitted or provided as an empty array, the request will have no effect.

  • org_id (str) – Organization to which the device belongs.

Return type:

None

get_customer_device_settings(family_or_model_display_name: str, tags: list[str] = None, org_id: str = None) → DeviceDynamicSettings[source]

Get Customer Device Dynamic Settings

Retrieve dynamic settings for specific device tags at customer level, allowing filters by familyOrModelDisplayName and tag identifier.

This API lets you request the values of multiple Device Settings at once by specifying a list of familyOrModelDisplayName and tag combinations.

This requires a full, device, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • family_or_model_display_name (str) – The family or model name for the device. If no tag is specified, all tags related to familyOrModelDisplayName are returned.

  • tags (list[str]) – Optional array of device tag identifiers to request settings for. Each identifier must have a length between 1 and 64 characters.

  • org_id (str) – List of device dynamic settings in this organization.

Return type:

CustomerDeviceDynamicSettings

get_device_settings(device_id: str, tags: list[str] = None, org_id: str = None) → DeviceDynamicSettings[source]

Get Device Dynamic Settings

Retrieve settings for a specified device.

This API retrieves device settings based on the specified tags; if the tags field is empty or missing, all settings for the device are returned.

This requires a full, device, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • device_id (str) – Device for which to retrieve settings.

  • tags (list[str]) – Optional array of tag identifiers representing specific settings to fetch. If omitted or provided as an empty array, all settings for the device will be returned.

  • org_id (str) – Organization to which the device belongs.

Return type:

DeviceDynamicSettings

get_location_device_settings(location_id: str, family_or_model_display_name: str, tags: list[str] = None, org_id: str = None) → DeviceDynamicSettings[source]

Get Location Device Dynamic Settings

Retrieve dynamic settings for specific device tags at the specified location level, allowing filters by familyOrModelDisplayName and tag identifier.

This API lets you request the values of multiple Device Settings at once by specifying a list of familyOrModelDisplayName and tag combinations for a specific location.

This requires a full, device, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Unique identifier for the location.

  • family_or_model_display_name (str) – The family or model name for the device. If no tag is specified, all tags related to familyOrModelDisplayName are returned.

  • tags (list[str]) – Optional array of device tag identifiers to request settings for. Each identifier must have a length between 1 and 64 characters.

  • org_id (str) – Unique identifier for the organization to which this location belongs.

Return type:

DeviceDynamicSettings

base = 'telephony/config'