wxc_sdk.person_settings.msteams module

class wxc_sdk.person_settings.msteams.MSTeamsSettings(*, personId: str | None = None, orgId: str | None = None, settings: list[SettingsObject] | None = None)[source]

Bases: ApiModel

person_id: str | None

Unique identifier for the person.

org_id: str | None

Unique identifier for the organization in which the person resides.

settings: list[SettingsObject] | None

Array of SettingsObject.

class wxc_sdk.person_settings.msteams.SettingsObject(*, settingName: str | None = None, level: str | None = None, value: bool | None = None, lastModified: datetime | None = None)[source]

Bases: ApiModel

setting_name: str | None

Name of the setting retrieved.

level: str | None

Level at which the settingName has been set.

value: bool | None

Either true or false for the respective settingName to be retrieved.

last_modified: datetime | None

The date and time when the respective settingName was last updated.

class wxc_sdk.person_settings.msteams.MSTeamsSettingApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

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

Retrieve a Person’s MS Teams Settings

At a person level, MS Teams settings allow access to retrieving the HIDE WEBEX APP and PRESENCE SYNC settings.

To retrieve a person’s MS Teams settings requires a full or read-only 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 since the default is the same organization as the token used to access the API.

Return type:

MSTeamsSettings

configure(person_id: str, setting_name: str, value: bool, org_id: str | None = None)[source]

Configure a Person’s MS Teams Setting

MS Teams settings can be configured at the person level.

Requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

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

  • setting_name (str) – The enum value to be set to HIDE_WEBEX_APP.

  • value (bool) – The boolean value to update the HIDE_WEBEX_APP setting, either true or false. Set to null to delete the HIDE_WEBEX_APP setting.

  • 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 since the default is the same organization as the token used to access the API.

Return type:

None

base = 'telephony/config/people'