wxc_sdk.person_settings.personal_assistant module

class wxc_sdk.person_settings.personal_assistant.PersonalAssistantPresence(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

none_ = 'NONE'

User is available.

business_trip = 'BUSINESS_TRIP'

User is gone for a business trip.

gone_for_the_day = 'GONE_FOR_THE_DAY'

User is gone for the day.

lunch = 'LUNCH'

User is gone for lunch.

meeting = 'MEETING'

User is gone for a meeting.

out_of_office = 'OUT_OF_OFFICE'

User is out of office.

temporarily_out = 'TEMPORARILY_OUT'

User is temporarily out.

training = 'TRAINING'

User is gone for training.

unavailable = 'UNAVAILABLE'

User is unavailable.

vacation = 'VACATION'

User is gone for vacation.

class wxc_sdk.person_settings.personal_assistant.PersonalAssistantAlerting(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, SafeEnum

An enumeration.

alert_me_first = 'ALERT_ME_FIRST'

Ring the recipient first.

play_ring_reminder = 'PLAY_RING_REMINDER'

Reminder ring the recipient.

none_ = 'NONE'

No alert.

class wxc_sdk.person_settings.personal_assistant.PersonalAssistant(*, enabled: bool | None = None, presence: PersonalAssistantPresence | None = None, untilDateTime: datetime | None = None, transferEnabled: bool | None = None, transferNumber: str | None = None, alerting: PersonalAssistantAlerting | None = None, alertMeFirstNumberOfRings: int | None = None, **extra_data: Any)

Bases: ApiModel

enabled: bool | None

Toggles feature.

presence: PersonalAssistantPresence | None

Person’s availability.

until_date_time: datetime | None

The date until which personal assistant is active.

transfer_enabled: bool | None

Toggle the option to transfer to another number.

transfer_number: str | None

Number to transfer to.

alerting: PersonalAssistantAlerting | None

Alert type.

alert_me_first_number_of_rings: int | None

ALERT_ME_FIRST; available range is 2-20

Type:

Number of rings for alert type

class wxc_sdk.person_settings.personal_assistant.PersonalAssistantApi(*, session: RestSession, base: str | None = None)

Bases: ApiChild

API for personal assistant settings

get(person_id: str, org_id: str | None = None) → PersonalAssistant

Get Personal Assistant

Retrieve Personal Assistant details for a specific user.

Personal Assistant is used to manage a user’s incoming calls when they are away.

Retrieving Personal Assistant details requires a full, user, 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) – Get Personal Assistant details for the organization.

Return type:

PersonalAssistant

update(person_id: str, settings: PersonalAssistant, org_id: str | None = None)

Update Personal Assistant

Update Personal Assistant details for a specific user.

Personal Assistant is used to manage a user’s incoming calls when they are away.

Updating Personal Assistant details requires a full or user administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• person_id (str) – Unique identifier for the person.

• settings (PersonalAssistant) – Personal Assistant settings.

• org_id (str) – Update Personal Assistant details for the organization.

Return type:

None

base = ''