wxc_sdk.person_settings.privacy module
user privacy API
- class wxc_sdk.person_settings.privacy.PrivacyApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]
Bases:
PersonSettingsApiChildAPI for privacy settings for users, vírtual lines and workspaces
- feature: str | None = 'privacy'
- read(entity_id: str, org_id: str = None) Privacy[source]
Get Privacy Settings for an entity
Get privacy settings for the specified entity id.
The privacy feature enables the entity’s line to be monitored by others and determine if they can be reached by Auto Attendant services.
This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.
- Parameters:
entity_id (str) – Unique identifier for the entity.
org_id (str) – 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.
- Returns:
privacy settings
- Return type:
- configure(entity_id: str, settings: Privacy, org_id: str = None)[source]
Configure an entity’s Privacy Settings
Configure an entity’s privacy settings for the specified entity ID.
The privacy feature enables the entity’s line to be monitored by others and determine if they can be reached by Auto Attendant services.
This API requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope.
- Parameters:
entity_id (str) – Unique identifier for the entity.
settings (
Monitoring) – settings for updateorg_id (str) – 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 = ''
- class wxc_sdk.person_settings.privacy.Privacy(*, aaExtensionDialingEnabled: bool | None = None, aaNamingDialingEnabled: bool | None = None, enablePhoneStatusDirectoryPrivacy: bool | None = None, enablePhoneStatusPickupBargeInPrivacy: bool | None = None, monitoringAgents: list[str | PersonPlaceAgent] | None = None, **extra_data: Any)[source]
Bases:
ApiModelPerson privacy settings
- aa_extension_dialing_enabled: bool | None
When true auto attendant extension dialing will be enabled.
- aa_naming_dialing_enabled: bool | None
When true auto attendant dialing by first or last name will be enabled.
- enable_phone_status_directory_privacy: bool | None
When true phone status directory privacy will be enabled.
- enable_phone_status_pickup_barge_in_privacy: bool | None
When true privacy is enforced for call pickup and barge-in. Only people specified by monitoringAgents can pick up the call or barge in by dialing the extension.
- monitoring_agents: list[str | PersonPlaceAgent] | None
List of people that are being monitored. for updates IDs can be used directly instead of
wxc_sdk.common.PersonPlaceAgentobjects