wxc_sdk.person_settings.personal_assistant module

class wxc_sdk.person_settings.personal_assistant.PersonalAssistantPresence(*values)[source]

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(*values)[source]

Bases: str, SafeEnum

An enumeration.

alert_me_first = 'ALERT_ME_FIRST': Ring the user’s phone first before the personal assistant takes over.

play_ring_reminder = 'PLAY_RING_REMINDER': Play a ring reminder to the user.

none_ = 'NONE': No alerting..

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)[source]

Bases: ApiModel

enabled: bool | None: Enable/Disable the personal assistant feature.

presence: PersonalAssistantPresence | None: Presence status that triggers the personal assistant..

until_date_time: datetime | None: Date and time until which the personal assistant is active (ISO 8601 format).

transfer_enabled: bool | None: Enable/Disable call transfer when personal assistant is active.

transfer_number: str | None: Phone number to transfer calls to when transfer is enabled.

alerting: PersonalAssistantAlerting | None: Alerting behavior for incoming calls when personal assistant is active. Possible values: ALERT_ME_FIRST - Ring the user’s phone first before the personal assistant takes over. PLAY_RING_REMINDER - Play a ring reminder to the user. NONE - No alerting..

alert_me_first_number_of_rings: int | None: Number of rings before transferring the call when alerting is set to ALERT_ME_FIRST.

class wxc_sdk.person_settings.personal_assistant.PersonalAssistantApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

API for personal assistant settings

get(person_id: str, org_id: str = None) → PersonalAssistant[source]

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)[source]

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 = ''