wxc_sdk.person_settings package
Person settings
- class wxc_sdk.person_settings.PersonSettingsApi(session: RestSession)[source]
Bases:
ApiChild
API for all user level settings
- appservices: AppServicesApi
Person’s Application Services Settings
- base = 'people'
- call_intercept: CallInterceptApi
Call Intercept Settings for a Person
- call_recording: CallRecordingApi
Call Recording Settings for a Person
- call_waiting: CallWaitingApi
Call Waiting Settings for a Person
- calling_behavior: CallingBehaviorApi
Person’s Calling Behavior
- caller_id: CallerIdApi
Caller ID Settings for a Person
- exec_assistant: ExecAssistantApi
Executive Assistant Settings for a Person
- forwarding: PersonForwardingApi
Forwarding Settings for a Person
- hoteling: HotelingApi
Hoteling Settings for a Person
- monitoring: MonitoringApi
Person’s Monitoring Settings
- numbers: NumbersApi
Phone Numbers for a Person
- permissions_in: IncomingPermissionsApi
Incoming Permission Settings for a Person
- permissions_out: OutgoingPermissionsApi
Person’s Outgoing Calling Permissions Settings
- privacy: PrivacyApi
Person’s Privacy Settings
- push_to_talk: PushToTalkApi
Push-to-Talk Settings for a Person
- receptionist: ReceptionistApi
Receptionist Client Settings for a Person
- schedules: ScheduleApi
Schedules for a Person
- voicemail: VoicemailApi
Voicemail Settings for a Person
- reset_vm_pin(person_id: str, org_id: Optional[str] = None)[source]
Reset Voicemail PIN
Reset a voicemail PIN for a person.
The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. A voicemail PIN is used to retrieve your voicemail messages.
This API requires a full or user administrator auth token with the spark-admin:people_write scope.
- Parameters
person_id – Unique identifier for the person.
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.
Submodules
- wxc_sdk.person_settings.appservices module
- wxc_sdk.person_settings.barge module
- wxc_sdk.person_settings.call_intercept module
- wxc_sdk.person_settings.call_recording module
- wxc_sdk.person_settings.call_waiting module
- wxc_sdk.person_settings.caller_id module
- wxc_sdk.person_settings.calling_behavior module
- wxc_sdk.person_settings.common module
- wxc_sdk.person_settings.dnd module
- wxc_sdk.person_settings.exec_assistant module
- wxc_sdk.person_settings.forwarding module
- wxc_sdk.person_settings.hoteling module
- wxc_sdk.person_settings.monitoring module
- wxc_sdk.person_settings.numbers module
- wxc_sdk.person_settings.permissions_in module
- wxc_sdk.person_settings.permissions_out module
- wxc_sdk.person_settings.privacy module
- wxc_sdk.person_settings.push_to_talk module
- wxc_sdk.person_settings.receptionist module
- wxc_sdk.person_settings.voicemail module