wxc_sdk.person_settings.dnd module

Person DND settings API

class wxc_sdk.person_settings.dnd.DND(*, enabled: bool, ringSplashEnabled: bool)[source]

Bases: ApiModel

DND settings

enabled: bool

forwarding.py

ring_splash_enabled: bool

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

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

Bases: PersonSettingsApiChild

API for person’s DND settings

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

Read Do Not Disturb Settings for a Person Retrieve a Person’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, user, or read-only administrator auth token with a scope of spark-admin:people_read or a user auth token with spark:people_read scope can be used by a person to read their settings. :param person_id: Unique identifier for the person. :type person_id: str :param org_id: 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. :type org_id: str :return:

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

Configure Do Not Disturb Settings for a Person Configure a Person’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 a person to update their settings.

Parameters:

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

  • dnd_settings (DND) – new setting to be applied

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