wxc_sdk.telephony.hotdesk package

class wxc_sdk.telephony.hotdesk.HotDesk(*, sessionId: str | None = None, workspaceId: str | None = None, personId: str | None = None, bookingStartTime: datetime | None = None, bookingEndTime: datetime | None = None, **extra_data: Any)[source]

Bases: ApiModel

session_id: str | None

A unique identifier for a hot desk session.

workspace_id: str | None

The workspace where the hot desk session is active.

person_id: str | None

The id of the person who initiated the hot desk session.

booking_start_time: datetime | None

The start time of the booking.

booking_end_time: datetime | None

The end time of the booking.

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

Bases: ApiChild

Hot Desk

list_sessions(person_id: str | None = None, workspace_id: str | None = None, org_id: str | None = None) → list[HotDesk][source]

List Sessions

List hot desk sessions.

Use query parameters to filter the response. The orgId parameter is for use by partner administrators acting on a managed organization. The personId and workspaceId parameters are optional and are used to filter the response to only include sessions for a specific person or workspace. When used together they are used as an AND filter.

Parameters:

  • person_id (str) – List sessions for this person.

  • workspace_id (str) – List sessions for this workspace.

  • org_id (str) – List sessions in this organization. Only admin users of another organization (such as partners) may use this parameter.

Return type:

list[HotDesk]

delete_session(session_id: str)[source]

Delete Session

Delete a hot desk session.

Parameters:

session_id (str) – The unique identifier for the hot desk session.

Return type:

None

base = 'hotdesk/sessions'