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
base = 'people'
barge: BargeApi
dnd: DndApi
call_intercept: CallInterceptApi
call_recording: CallRecordingApi
call_waiting: CallWaitingApi
calling_behavior: CallingBehaviorApi
caller_id: CallerIdApi
exec_assistant: ExecAssistantApi
forwarding: PersonForwardingApi
hoteling: HotelingApi
monitoring: MonitoringApi
numbers: NumbersApi
permissions_in: IncomingPermissionsApi
permissions_out: OutgoingPermissionsApi
privacy: PrivacyApi
push_to_talk: PushToTalkApi
receptionist: ReceptionistApi
schedules: ScheduleApi
voicemail: VoicemailApi
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