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 person’s call monitoring settings
- feature = 'privacy'
- read(person_id: str, org_id: str | None = None) Privacy[source]
Get a person’s Privacy Settings
Get a person’s privacy settings for the specified person id.
The privacy feature enables the person’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:
person_id (str) – Unique identifier for the person.
org_id (str) – 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.
- Returns:
privacy settings
- Return type:
- configure(person_id: str, settings: Privacy, org_id: str | None = None)[source]
Configure Call Waiting Settings for a Person
Configure a Person’s Call Waiting Settings
With this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.
This API requires a full or user administrator auth token with the spark-admin:people_write scope.
- Parameters:
person_id (str) – Unique identifier for the person.
settings (
Monitoring) – settings for updateorg_id (str) – 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 = ''
- 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)[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