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, desktopClientEnabled: bool | None = None, desktopClientId: str | None = None, tabletClientEnabled: bool | None = None, mobileClientEnabled: bool | None = None, availableLineCount: int | None = None, browserClientEnabled: bool | None = None, browserClientId: str | None = None)

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.

desktop_client_enabled: bool | None

Indicates that the desktop Webex Calling application is enabled for use.

desktop_client_id: str | None

desktop client id

tablet_client_enabled: bool | None

Indicates that the tablet Webex Calling application is enabled for use.

mobile_client_enabled: bool | None

indicates that the mobile Webex Calling application is enabled for use.

available_line_count: int | None

Number of available device licenses for assigning devices/apps. this value cannot be updated

browser_client_enabled: bool | None

Indicates that the browser Webex Calling application is enabled for use.

browser_client_id: str | None

class wxc_sdk.person_settings.appservices.AppServicesApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

Bases: PersonSettingsApiChild

API for person’s app services settings

feature = 'applications'

read(person_id: str, org_id: str | None = None) → AppServicesSettings

Retrieve a Person’s Application Services Settings

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.

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

Parameters:

• person_id (str) – Unique identifier for the person.

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

Returns:

privacy settings

Return type:

Privacy

configure(person_id: str, settings: AppServicesSettings, org_id: str | None = None)

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

base = ''