wxc_sdk.telephony.dect_devices package

class wxc_sdk.telephony.dect_devices.DECTNetworkModel(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

dms_cisco_dbs110 = 'DMS Cisco DBS110'

Supports 1 base station and 30 line ports.

dms_cisco_dbs210 = 'DMS Cisco DBS210'

Supports 250 base stations and 1000 line ports.

class wxc_sdk.telephony.dect_devices.DECTNetworkDetail(*, id: str | None = None, name: str | None = None, displayName: str | None = None, chainId: int | None = None, model: DECTNetworkModel | None = None, defaultAccessCodeEnabled: bool | None = None, defaultAccessCode: str | None = None, numberOfBaseStations: int | None = None, numberOfHandsetsAssigned: int | None = None, numberOfLines: int | None = None, location: IdAndName | None = None)[source]

Bases: ApiModel

id: str | None

Unique identifier for the DECT network.

name: str | None

Name of the DECT network. This should be unique across the location.

display_name: str | None

DECT network name that will be displayed on the handset.

chain_id: int | None

Chain ID of the DECT network.

model: DECTNetworkModel | None

Indicates the base station model deployed in the DECT network.

default_access_code_enabled: bool | None

Default access code is enabled. If true, the default access code is mandatory. If false, auto-generated access code is used.

default_access_code: str | None

Default access code for the DECT network. The default access code should be unique within the same location to avoid the handset accidentally registering with base stations from different DECT networks in range. This is mandatory when defaultAccessCodeEnabled is true.

number_of_base_stations: int | None

Number of base stations in the DECT network.

number_of_handsets_assigned: int | None

Number of handsets assigned to the DECT network.

number_of_lines: int | None

Number of lines in the DECT network.

location: IdAndName | None

Location of the DECT network.

class wxc_sdk.telephony.dect_devices.BaseStationResult(*, status: int | None = None, id: str | None = None)[source]

Bases: ApiModel

status: int | None

HTTP status code indicating the creation of base station. 201 status code indicates the successful creation of base stations

id: str | None

Unique identifier of the base station.

class wxc_sdk.telephony.dect_devices.BaseStationResponse(*, mac: str | None = None, result: BaseStationResult | None = None)[source]

Bases: ApiModel

mac: str | None

MAC Address added to the base station.

result: BaseStationResult | None

Object with base station POST Result.

class wxc_sdk.telephony.dect_devices.BaseStationsResponse(*, id: str | None = None, mac: str | None = None, numberOfLinesRegistered: int | None = None)[source]

Bases: ApiModel

id: str | None

Unique identifier of the base station.

mac: str | None

Mac address of the DECT base station device.

number_of_lines_registered: int | None

Number of handset member lines registered with the base station.

class wxc_sdk.telephony.dect_devices.DECTHandsetLine(*, memberId: str | None = None, firstName: str | None = None, lastName: str | None = None, external: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, lastRegistrationTime: str | None = None, hostIP: str | None = None, remoteIP: str | None = None, location: IdAndName | None = None, memberType: UserType | None = None)[source]

Bases: ApiModel

member_id: str | None

ID of the member on line1 of the handset. Members can be PEOPLE or PLACE.

first_name: str | None

Line members’s first name.

last_name: str | None

Line members’s last name.

external: str | None

Line members primary number.

extension: str | None

Line members extension.

routing_prefix: str | None

Routing prefix of location.

esn: str | None

Routing prefix + extension

last_registration_time: str | None

Last registration timestamp.

host_ip: str | None

Registration host IP address for the line port.

remote_ip: str | None

Registration remote IP address for the line port.

location: IdAndName | None

Location object having a unique identifier for the location and its name.

member_type: UserType | None

Indicates member type.

class wxc_sdk.telephony.dect_devices.Handset(*, id: str | None = None, displayName: str | None = None, accessCode: str | None = None, lines: list[DECTHandsetLine] | None = None)[source]

Bases: ApiModel

id: str | None
display_name: str | None

Display name of the DECT handset.

access_code: str | None

Access code for the DECT handset.

lines: list[DECTHandsetLine] | None

Details of the handset member lines registered with the base station. The maximum number of lines supported is 2.

class wxc_sdk.telephony.dect_devices.BaseStationDetail(*, id: str | None = None, mac: str | None = None, handsets: list[Handset] | None = None)[source]

Bases: ApiModel

id: str | None
mac: str | None

Mac address of the DECT base station device.

handsets: list[Handset] | None

List of handset and member line details registered with the base station.

class wxc_sdk.telephony.dect_devices.DECTHandsetItem(*, id: str | None = None, index: int | None = None, defaultDisplayName: str | None = None, customDisplayName: str | None = None, baseStationId: str | None = None, mac: str | None = None, accessCode: str | None = None, primaryEnabled: bool | None = None, lines: list[DECTHandsetLine] | None = None)[source]

Bases: ApiModel

id: str | None

Unique identifier of the handset.

index: int | None

Index of the handset.

default_display_name: str | None

Default display name for the handset.

custom_display_name: str | None

Custom display name on the handset.

base_station_id: str | None

Unique identifier of the associated base station.

mac: str | None

MAC Address associated with the handset.

access_code: str | None

Access code is used to pair handsets to the DECT Network for the first time or if a handset becomes disconnected.

primary_enabled: bool | None

Flags the handset as a primary line if true.

lines: list[DECTHandsetLine] | None

2 lines.

Type:

Array of lines associated to the handset.Maximum

class wxc_sdk.telephony.dect_devices.DECTHandsetList(*, numberOfHandsetsAssigned: int | None = None, numberOfLinesAssigned: int | None = None, handsets: list[DECTHandsetItem] | None = None)[source]

Bases: ApiModel

number_of_handsets_assigned: int | None

Number of handsets associated.

number_of_lines_assigned: int | None

Total number of lines assigned.

handsets: list[DECTHandsetItem] | None

Array of DECTHandsetItem objects, each representing a handset with its associated details and lines.

class wxc_sdk.telephony.dect_devices.UsageType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

device_owner = 'DEVICE_OWNER'
shared_line = 'SHARED_LINE'
class wxc_sdk.telephony.dect_devices.DECTDevicesApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

DECT Devices Settings

Not supported for Webex for Government (FedRAMP)

DECT APIs allow the admin to create a DECT network, and add base stations and handsets to the DECT network. People, places and virtual lines member types are supported on handset lines in the DECT network. Currently, APIs support Cisco DECT device models only.

Viewing and searching DECT settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Adding and modifying these DECT settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

create_dect_network(location_id: str, name: str, display_name: str, model: DECTNetworkModel, default_access_code_enabled: bool, default_access_code: str, org_id: str | None = None) → str[source]

Create a DECT Network

Create a multi-cell DECT network for a given location.

Creating a DECT network requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Create a DECT network in this location.

  • name (str) – Name of the DECT network. Min and max length supported for the DECT network name are 1 and 40 respectively.

  • display_name (str) – Add a default name (11 characters max) to display for all handsets. If left blank, the default name will be an indexed number followed by the DECT network name.

  • model (DECTNetworkModel) – Select a device model type depending on the number of base stations and handset lines needed in the DECT network.

  • default_access_code_enabled (bool) – If set to true, need to provide a default access code that will be shared for all users in this network to pair their lines to the next available handset. Otherwise, each user will get a unique 4-digit access code that will be auto-generated. Note: There is currently no public API to retrieve the auto generated access codes for handsets. Use Control Hub instead.

  • default_access_code (str) – If defaultAccessCodeEnabled is set to true, then provide a default access code that needs to be a 4-numeric digit. The access code should be unique to the DECT network for the location.

  • org_id (str) – Create a DECT network in this organization

Return type:

str

list_dect_networks(name: str | None = None, location_id: str | None = None, org_id: str | None = None) → list[DECTNetworkDetail][source]

Get the List of DECT Networks for an organization

Retrieves the list of DECT networks for an organization.

DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.

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

Parameters:

  • name (str) – List of DECT networks with this name.

  • location_id (str) – List of DECT networks at this location.

  • org_id (str) – List of DECT networks in this organization.

Return type:

list[DECTNetworkDetail]

dect_network_details(location_id: str, dect_network_id: str, org_id: str | None = None) → DECTNetworkDetail[source]

Get DECT Network Details

Retrieves the details of a DECT network.

DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.

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

Parameters:

  • location_id (str) – Details of the DECT network at this location.

  • dect_network_id (str) – Details of the specified DECT network.

  • org_id (str) – Details of the DECT network in this organization.

Return type:

DECTNetworkDetail

update_dect_network(location_id: str, dect_network_id: str, name: str, default_access_code_enabled: bool, default_access_code: str | None = None, display_name: str | None = None, org_id: str | None = None)[source]

Update DECT Network

Update the details of a DECT network.

DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.

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

Parameters:

  • location_id (str) – Update DECT network details in the specified location.

  • dect_network_id (str) – Update DECT network details in the specified DECT network.

  • name (str) – Name of the DECT network. This should be unique across the location.

  • default_access_code_enabled (bool) – Default access code is enabled. If true, the default access code is mandatory. If false, an auto-generated access code is used.

  • default_access_code (str) – Default access code for the DECT network. The default access code should be unique within the same location to avoid the handset accidentally registering with base stations from different DECT networks in range. This is mandatory when defaultAccessCodeEnabled is true.

  • display_name (str) – DECT network name that will be displayed on the handset.

  • org_id (str) – Update DECT network details in the specified organization.

Return type:

None

update_dect_network_settings(settings: DECTNetworkDetail, org_id: str | None = None)[source]

Update DECT Network from settings

Update the details of a DECT network from settings.

DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.

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

Parameters:

  • settings – DECT Network to update. location.id and id are used to address the DECT network to be updated. Only name, display_name, default_access_code_enabled, default_access_code are considered for the update

  • org_id (str) – Update DECT network details in the specified organization.

Return type:

None

delete_dect_network(location_id: str, dect_network_id: str, org_id: str | None = None)[source]

Delete DECT Network

Delete a DECT network.

DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.

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

Parameters:

  • location_id (str) – Delete the DECT network in the specified location.

  • dect_network_id (str) – Delete the specified DECT network.

  • org_id (str) – Delete the DECT network in the specified organization.

Return type:

None

create_base_stations(location_id: str, dect_id: str, base_station_macs: list[str], org_id: str | None = None) → list[BaseStationResponse][source]

Create Multiple Base Stations

This API is used to create multiple base stations in a DECT network in an organization.

Creating base stations in a DECT network requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Create a base station in this location.

  • dect_id (str) – Create a base station for the DECT network.

  • base_station_macs (list[str]) – Array of base stations.

  • org_id (str) – Create a base station for a DECT network in this organization.

Return type:

list[BaseStationResponse]

list_base_stations(location_id: str, dect_network_id: str, org_id: str | None = None) → list[BaseStationsResponse][source]

Get a list of DECT Network Base Stations

Retrieve a list of base stations in a DECT Network.

A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration.

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

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Retrieve the list of base stations in the specified DECT network ID.

  • org_id (str) – Organization containing the DECT network.

Return type:

list[BaseStationsResponse]

base_station_details(location_id: str, dect_network_id: str, base_station_id: str, org_id: str | None = None) → BaseStationDetail[source]

Get the details of a specific DECT Network Base Station

Retrieve details of a specific base station in the DECT Network.

A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration.

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

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Retrieve details of a specific base station in the specified DECT network ID.

  • base_station_id (str) – Retrieve details of the specific DECT base station ID.

  • org_id (str) – Organization containing the DECT network.

Return type:

BaseStationDetail

delete_bulk_base_stations(location_id: str, dect_network_id: str, org_id: str | None = None)[source]

Delete bulk DECT Network Base Stations

Delete all the base stations in the DECT Network.

A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration.

This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Delete all the base stations in the specified DECT network ID.

  • org_id (str) – Organization containing the DECT network.

Return type:

None

delete_base_station(location_id: str, dect_network_id: str, base_station_id: str, org_id: str | None = None)[source]

Delete a specific DECT Network Base Station

Delete a specific base station in the DECT Network.

A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration.

This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Delete a specific base station in the specified DECT network ID.

  • base_station_id (str) – Delete the specific DECT base station ID.

  • org_id (str) – Organization containing the DECT network.

Return type:

None

add_a_handset(location_id: str, dect_network_id: str, line1_member_id: str, line2_member_id: str | None = None, custom_display_name: str | None = None, org_id: str | None = None)[source]

Add a Handset to a DECT Network

Add a handset to a DECT network in a location in an organization.

Adding a handset to a DECT network requires a full administrator auth token with a scope of spark-admin:telephony_config_write

Parameters:

  • location_id (str) – Add handset in this location.

  • dect_network_id (str) – A unique identifier for the DECT network.

  • line1_member_id (str) – ID of the member on line1 of the handset. Members can be PEOPLE or PLACE.

  • line2_member_id (str) – ID of the member on line2 of the handset. Members can be PEOPLE, PLACE, or VIRTUAL_LINE.

  • custom_display_name (str) – Custom display name on the handset. Min and max length supported for the custom display name is 1 and 16 respectively. Mandatory parameter.

  • org_id (str) – Add handset in this organization.

Return type:

None

list_handsets(location_id: str, dect_network_id: str, basestation_id: str | None = None, member_id: str | None = None, org_id: str | None = None) → DECTHandsetList[source]

Get List of Handsets for a DECT Network ID

List all the handsets associated with a DECT Network ID.

A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE.

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

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Search handset details in the specified DECT network ID.

  • basestation_id (str) – Search handset details in the specified DECT base station ID.

  • member_id (str) – ID of the member of the handset. Members can be of type PEOPLE, PLACE, or VIRTUAL_LINE.

  • org_id (str) – Organization containing the DECT network.

Return type:

DECTHandsetList

handset_details(location_id: str, dect_network_id: str, handset_id: str, org_id: str | None = None) → DECTHandsetItem[source]

Get Specific DECT Network Handset Details

List the specific DECT Network handset details.

A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE.

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

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Search handset details in the specified DECT network ID.

  • handset_id (str) – A unique identifier for the handset.

  • org_id (str) – Organization containing the DECT network.

Return type:

DECTHandsetGet

update_handset(location_id: str, dect_network_id: str, handset_id: str, line1_member_id: str, custom_display_name: str, line2_member_id: str | None = None, org_id: str | None = None)[source]

Update DECT Network Handset

Update the line assignment on a handset.

A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE.

Updating a DECT Network handset requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Update handset details in the specified DECT network.

  • handset_id (str) – A unique identifier for the handset.

  • line1_member_id (str) – ID of the member on line1 of the handset. Members can be PEOPLE or PLACE.

  • custom_display_name (str) – Custom display name on the handset.

  • line2_member_id (str) – ID of the member on line2 of the handset. Members can be PEOPLE, PLACE, or VIRTUAL_LINE.

  • org_id (str) – Organization containing the DECT network.

Return type:

None

delete_handset(location_id: str, dect_network_id: str, handset_id: str, org_id: str | None = None)[source]

Delete specific DECT Network Handset Details

Delete a specific DECT Network handset.

A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE.

This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Delete handset details in the specified DECT network ID.

  • handset_id (str) – A unique identifier for the handset.

  • org_id (str) – Organization containing the DECT network.

Return type:

None

delete_handsets(location_id: str, dect_network_id: str, handset_ids: list[str], delete_all: bool | None = None, org_id: str | None = None)[source]

Delete multiple handsets

Delete multiple handsets or all of them.

A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets. A member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE.

This API requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location containing the DECT network.

  • dect_network_id (str) – Delete handset details in the specified DECT network ID.

  • handset_ids (list[str]) – Array of the handset IDs to be deleted.

  • delete_all (bool) – If present the items array is ignored and all items in the context are deleted.

  • org_id (str) – Organization containing the DECT network.

Return type:

None

dect_networks_associated_with_person(person_id: str, org_id: str | None = None) → list[AssignedDectNetwork][source]

GET List of DECT networks associated with a Person

Retrieves the list of DECT networks for a person in an organization.

DECT Network provides roaming voice services via base stations and wireless handsets. DECT network can be provisioned up to 1000 lines across up to 254 base stations.

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

Parameters:

  • person_id (str) – List of DECT networks associated with this person.

  • org_id (str) – List of DECT networks associated with a person in this organization.

Return type:

list[AssignedDectNetwork]

dect_networks_associated_with_workspace(workspace_id: str, org_id: str | None = None) → list[AssignedDectNetwork][source]

GET List of DECT networks associated with a workspace

Retrieves the list of DECT networks for a workspace in an organization.

DECT Network provides roaming voice services via base stations and wireless handsets. DECT network can be provisioned up to 1000 lines across up to 254 base stations.

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

Parameters:

  • workspace_id (str) – List of DECT networks associated with this workspace.

  • org_id (str) – List of DECT networks associated with a workspace in this organization.

Return type:

list[AssignedDectNetwork]

dect_networks_associated_with_virtual_line(virtual_line_id: str, org_id: str | None = None) → list[AssignedDectNetwork][source]

Get List of Dect Networks Handsets for a Virtual Line

Retrieve DECT Network details assigned for a virtual line.

Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

Retrieving the assigned device detials for a virtual line requires a full or user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • virtual_line_id (str) – Retrieve settings for a virtual line with the matching ID.

  • org_id (str) – Retrieve virtual line settings from this organization.

Return type:

list[AssignedDectNetwork]

available_members(member_name: str | None = None, phone_number: str | None = None, extension: str | None = None, location_id: str | None = None, order: str | None = None, exclude_virtual_line: bool | None = None, usage_type: UsageType | None = None, org_id: str | None = None, **params) → Generator[AvailableMember, None, None][source]

Search Available Members

List the members that are available to be assigned to DECT handset lines.

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

Parameters:

  • member_name (str) – Search (Contains) numbers based on member name.

  • phone_number (str) – Search (Contains) based on number.

  • extension (str) – Search (Contains) based on extension.

  • location_id (str) – List members for the location ID.

  • order (str) – Sort the list of available members on the device in ascending order by name, using either last name lname or first name fname. Default sort is the last name in ascending order.

  • exclude_virtual_line (bool) – If true, search results will exclude virtual lines in the member list. NOTE: Virtual lines cannot be assigned as the primary line.

  • usage_type (UsageType) – Search for members eligible to become the owner of the device, or share line on the device.

  • org_id (str) – Search members in this organization.

Returns:

Generator yielding AvailableMember instances

base = 'telephony/config'