wxc_sdk.person_settings.call_waiting module

Call waiting API

class wxc_sdk.person_settings.call_waiting.CallWaitingApi(*, session: RestSession, workspaces: bool = False, locations: bool = False)

Bases: PersonSettingsApiChild

API for person’s call waiting settings

feature = 'callWaiting'

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

Read Call Waiting Settings for a Person

Retrieve a Person’s Call Waiting Settings

With this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.

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:

call waiting setting

Return type:

bool

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

Configure Call Waiting Settings for a Person

Configure a Person’s Call Waiting Settings

With this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.

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) – true if the Call Waiting feature is enabled.

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

session: RestSession

REST session