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, **extra_data: Any)[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, **extra_data: Any)[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'

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

Bases: ApiChild

Client Call Settings

Client Call Settings supports reading and writing of Webex Calling client settings for a specific organization.

Viewing these read-only organization settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Modifying these organization settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

A partner administrator can retrieve or change settings in a customer’s organization using the optional orgId query parameter.

read(org_id: str | None = None) → OrgMSTeamsSettings[source]

Get an Organization’s MS Teams Settings

Not supported for Webex for Government (FedRAMP)

Get organization MS Teams settings.

At an organization level, MS Teams settings allow access to viewing the HIDE WEBEX APP and PRESENCE SYNC settings.

To retrieve an organization’s MS Teams settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:: org_id (str) – Retrieve MS Teams settings for the organization.
Return type:: OrgMSTeamsSettings

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

Update an Organization’s MS Teams Setting

Not supported for Webex for Government (FedRAMP)

Update an MS Teams setting.

MS Teams setting can be updated at the organization level.

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

Parameters:

setting_name (SettingsObjectSettingName) – The enum value, either HIDE_WEBEX_APP or PRESENCE_SYNC, for the respective settingName to be updated.
value (bool) – The boolean value, either true or false, for the respective settingName to be updated.
org_id (str) – Update MS Teams setting value for the organization.

Return type:

None

base = 'telephony/config/settings/msTeams'

class wxc_sdk.person_settings.msteams.OrgMSTeamsSettings(*, level: str | None = None, orgId: str | None = None, settings: list[SettingsObject] | None = None, **extra_data: Any)[source]

Bases: ApiModel

level: str | None: Level at which the settingName has been set.

org_id: str | None: Unique identifier for the organization.

settings: list[SettingsObject] | None: Array of SettingsObject.