wxc_sdk.person_settings.hoteling module

Hoteling API

class wxc_sdk.person_settings.hoteling.HotelingApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)

Bases: PersonSettingsApiChild

API for person’s hoteling settings

feature = 'hoteling'

read(person_id: str, org_id: str | None = None) → bool

Read Hoteling Settings for a Person

Retrieve a person’s hoteling settings.

As an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone.

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:

hoteling setting

Return type:

bool

configure(person_id: str, enabled: bool, org_id: str | None = None)

Configure Hoteling Settings for a Person

Configure a person’s hoteling settings.

As an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone.

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.

• enabled (bool) – When true, allow this person to connect to a Hoteling host device.

• 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.

base = ''