wxc_sdk.person_settings.dnd module

Person DND settings API

class wxc_sdk.person_settings.dnd.DND(*, enabled: bool | None = None, ringSplashEnabled: bool | None = None, webexGoOverrideEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

DND settings

enabled: bool | None

forwarding.py

ring_splash_enabled: bool | None

Enables a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.

webex_go_override_enabled: bool | None

true if a mobile device will still ring even if Do Not Disturb is enabled.

class wxc_sdk.person_settings.dnd.DndApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API for person’s DND settings. Also used for workspaces

feature = 'doNotDisturb'
read(entity_id: str, org_id: str | None = None) → DND[source]

Read Do Not Disturb Settings for an entity

Retrieve an entity’s Do Not Disturb Settings

When enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • org_id – Entity 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. :type org_id: str :return:

configure(entity_id: str, dnd_settings: DND, org_id: str | None = None)[source]

Configure Do Not Disturb Settings for an entity

Configure an entity’s Do Not Disturb Settings

When enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.

This API requires a full or user administrator auth token with the spark-admin:people_write scope or a user auth token with spark:people_write scope can be used by an entity to update their settings.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • dnd_settings (DND) – new setting to be applied

  • org_id – Entity 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 = ''