wxc_sdk.person_settings.appservices module

app services settings API

class wxc_sdk.person_settings.appservices.AppServicesSettings(*, ringDevicesForClickToDialCallsEnabled: bool | None = None, ringDevicesForGroupPageEnabled: bool | None = None, ringDevicesForCallParkEnabled: bool | None = None, browserClientEnabled: bool | None = None, browserClientId: str | None = None, desktopClientEnabled: bool | None = None, desktopClientId: str | None = None, tabletClientEnabled: bool | None = None, tabletClientId: str | None = None, mobileClientEnabled: bool | None = None, mobileClientId: str | None = None, availableLineCount: int | None = None, **extra_data: Any)[source]

Bases: ApiModel

Person app services settings

ring_devices_for_click_to_dial_calls_enabled: bool | None: When true, indicates to ring devices for outbound Click to Dial calls.

ring_devices_for_group_page_enabled: bool | None: When true, indicates to ring devices for inbound Group Pages.

ring_devices_for_call_park_enabled: bool | None: When true, indicates to ring devices for Call Park recalled.

browser_client_enabled: bool | None: Indicates that the browser Webex Calling application is enabled for use.

browser_client_id: str | None: Device ID of WebRTC client. Returns only if browserClientEnabled is true.

desktop_client_enabled: bool | None: Indicates that the desktop Webex Calling application is enabled for use.

desktop_client_id: str | None: Device ID of Desktop client. Returns only if desktopClientEnabled is true.

tablet_client_enabled: bool | None: Indicates that the tablet Webex Calling application is enabled for use.

tablet_client_id: str | None: Device ID of Tablet client. Returns only if tabletClientEnabled is true.

mobile_client_enabled: bool | None: Indicates that the mobile Webex Calling application is enabled for use.

mobile_client_id: str | None: Device ID of Mobile client. Returns only if mobileClientEnabled is true.

available_line_count: int | None: Number of available device licenses for assigning devices/apps.

class wxc_sdk.person_settings.appservices.AppServicesApi(*, session: RestSession)[source]

Bases: ApiChild

API for person’s app services settings

__init__(*, session: RestSession)[source]

shared_line: AppSharedLineApi

read(person_id: str, org_id: str | None = None) → AppServicesSettings[source]

Retrieve a person’s Application Services Settings New

Gets mobile and PC applications settings for a user.

Application services let you determine the ringing behavior for calls made to people in certain scenarios. You can also specify which devices can download the Webex Calling app.

Requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

person_id (str) – Unique identifier for the person.
org_id (str) – ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Return type:

AppServicesSettings

base = ''

configure(person_id: str, settings: AppServicesSettings, org_id: str | None = None)[source]

Modify a person’s Application Services Settings

Application services let you determine the ringing behavior for calls made to users in certain scenarios. You can also specify which devices users can download the Webex Calling app on.

This API requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope.

Parameters:

person_id (str) – Unique identifier for the person.
settings (AppServicesSettings) – settings for update
org_id (str) – Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.