wxc_sdk.telephony.hotdesking_voiceportal package

class wxc_sdk.telephony.hotdesking_voiceportal.HotDeskingSigninViaVoicePortalApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Features: Hot Desking Sign-in via Voice Portal

Features: Hot desking is a feature that allows users to sign in to a shared phone and make calls using their own phone number.

Viewing these read-only organization settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Modifying these organization settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

A partner administrator can retrieve or change settings in a customer’s organization using the optional orgId query parameter.

location_get(location_id: str, org_id: str | None = None) → HotDeskingVoicePortalSetting[source]

Voice Portal Hot desking sign in details for a location

Get the Hot desking sign in details for a location.

This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Location in which the hot desking sign in resides.

  • org_id (str) – ID of the 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 the API.

Return type:

HotDeskingVoicePortalSetting

location_update(location_id: str, setting: HotDeskingVoicePortalSetting, org_id: str | None = None)[source]

Update Voice Portal Hot desking sign in details for a location

Update the Hot desking sign in details for a location.

This requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location in which the hot desking sign in resides.

  • setting (HotDeskingVoicePortalSetting) – Hot desking sign in details for a location.

  • org_id (str) – ID of the 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 the API.

Return type:

None

user_get(person_id: str, org_id: str | None = None) → HotDeskingVoicePortalSetting[source]

Voice Portal Hot desking sign in details for a user

Get the Hot desking sign in details for a user.

This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • person_id (str) – ID of the person associated with the hot desking details.

  • org_id (str) – ID of the 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 the API.

Return type:

HotDeskingVoicePortalSetting

user_update(person_id: str, setting: HotDeskingVoicePortalSetting, org_id: str | None = None)[source]

Update Voice Portal Hot desking sign in details for a user

Update the Hot desking sign in details for a user.

This requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • person_id (str) – ID of the person associated with the hot desking details.

  • setting (HotDeskingVoicePortalSetting) – Hot desking sign in details for a user.

  • org_id (str) – ID of the 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 the API.

Return type:

None

base = 'telephony/config'
class wxc_sdk.telephony.hotdesking_voiceportal.HotDeskingVoicePortalSetting(*, voicePortalHotDeskSignInEnabled: bool, **extra_data: Any)[source]

Bases: ApiModel

enabled: bool