wxc_sdk.telephony.callpark module

class wxc_sdk.telephony.callpark.CallParkRecall(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

Call park recall option.

parking_user_only = 'ALERT_PARKING_USER_ONLY'
parking_user_first_then_hunt_group = 'ALERT_PARKING_USER_FIRST_THEN_HUNT_GROUP'
hunt_group_only = 'ALERT_HUNT_GROUP_ONLY'
class wxc_sdk.telephony.callpark.RecallHuntGroup(*, huntGroupId: str | None = None, huntGroupName: str | None = None, option: CallParkRecall | None = None)[source]

Bases: ApiModel

Recall options that are added to call park.

hunt_group_id: str | None

Alternate user which is a hunt group id for call park recall alternate destination.

hunt_group_name: str | None

Unique name for the hunt group.

option: CallParkRecall | None

Call park recall option.

static default() → RecallHuntGroup[source]

Default recall: parking user only, no hunt group

Returns:

RecallHuntGroup object

Return type:

RecallHuntGroup

class wxc_sdk.telephony.callpark.AvailableRecallHuntGroup(*, id: str, name: str)[source]

Bases: ApiModel

available recall hunt group

huntgroup_id: str

A unique identifier for the hunt group.

name: str

Unique name for the hunt group.

class wxc_sdk.telephony.callpark.CallPark(*, id: str | None = None, name: str | None = None, locationName: str | None = None, locationId: str | None = None, recall: RecallHuntGroup | None = None, agents: list[PersonPlaceAgent] | None = None, parkOnAgentsEnabled: bool | None = None, callParkExtensions: list[CallParkExtension] | None = None)[source]

Bases: ApiModel

Call Park

callpark_id: str | None

A unique identifier for the call park.

name: str | None

Unique name for the call park. The maximum length is 80.

location_name: str | None

Name of location for call park

location_id: str | None

ID of location for call park.

recall: RecallHuntGroup | None

Recall options that are added to call park.

agents: list[PersonPlaceAgent] | None

People, including workspaces, that are eligible to receive calls.

park_on_agents_enabled: bool | None

Whether or not the calls will be parked on agents as a destination.

call_park_extensions: list[CallParkExtension] | None

Array of call park extensions assigned to a call park.

static default(*, name: str) → CallPark[source]

Default (trivial) call park group

no agents, recall to parking user only

Parameters:

name (str) – call park group name

Returns:

CallPark instance

Return type:

:class`CallPark`

create_or_update() → str[source]

Get JSON for create or update call

Returns:

JSON

Return type:

str

class wxc_sdk.telephony.callpark.CallParkSettings(*, ringPattern: RingPattern | None = None, recallTime: int | None = None, huntWaitTime: int | None = None)[source]

Bases: ApiModel

Setting controlling call park behavior.

ring_pattern: RingPattern | None

Ring pattern for when this callpark is called.

recall_time: int | None

Amount of time within 30 and 600 seconds the Call Park will be parked. If the call isn’t picked up within the set time, then the call will be recalled based on the Call Park Recall setting.

hunt_wait_time: int | None

Amount of time within 30 and 600 seconds the Call Park will be parked. If the call isn’t picked up, the call will revert back to the hunt group (after the person who parked the call is alerted).

static default() → CallParkSettings[source]

Default call park settings

Returns:

CallParkSettings

class wxc_sdk.telephony.callpark.LocationCallParkSettings(*, callParkRecall: RecallHuntGroup | None = None, callParkSettings: CallParkSettings | None = None)[source]

Bases: ApiModel

call_park_recall: RecallHuntGroup | None

Recall options that are added to call park.

call_park_settings: CallParkSettings | None

Setting controlling call park behavior.

static default() → LocationCallParkSettings[source]

Default location call park settings

Returns:

LocationCallParkSettings

update() → str[source]

Get JSON for update call

Returns:

JSON

Return type:

str

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

Bases: ApiChild

Call Park API

list(location_id: str, order: Literal['ASC', 'DSC'] | None = None, name: str | None = None, org_id: str | None = None, **params) → Generator[CallPark, None, None][source]

Read the List of Call Parks

List all Call Parks for the organization.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

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

NOTE: The Call Park ID will change upon modification of the Call Park name.

Parameters:

  • location_id (str) – Return the list of call parks for this location.

  • order (str) – Sort the list of call parks by name, either ASC or DSC. Default is ASC.

  • name (str) – Return the list of call parks that contains the given name. The maximum length is 80.

  • org_id (str) – List call parks for this organization.

Returns:

yields CallPark objects

create(location_id: str, settings: CallPark, org_id: str | None = None) → str[source]

Create a Call Park

Create new Call Parks for the given location.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

Creating a call park requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

NOTE: The Call Park ID will change upon modification of the Call Park name.

Parameters:

  • location_id (str) – Create the call park for this location.

  • settings (CallPark) – settings for new call park

  • org_id – Create the call park for this organization.

Returns:

ID of the newly created call park.

Return type:

str

delete_callpark(location_id: str, callpark_id: str, org_id: str | None = None)[source]

Delete a Call Park

Delete the designated Call Park.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

Deleting a call park requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

NOTE: The Call Park ID will change upon modification of the Call Park name.

Parameters:

  • location_id (str) – Location from which to delete a call park.

  • callpark_id (str) – Delete the call park with the matching ID.

  • org_id (str) – Delete the call park from this organization.

details(location_id: str, callpark_id: str, org_id: str | None = None) → CallPark[source]

Get Details for a Call Park

Retrieve Call Park details.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

Retrieving call park details requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

NOTE: The Call Park ID will change upon modification of the Call Park name.

Parameters:

  • location_id (str) – Retrieve settings for a call park in this location.

  • callpark_id (str) – Retrieve settings for a call park with the matching ID.

  • org_id (str) – Retrieve call park settings from this organization.

Returns:

call park info

Return type:

CallPark

update(location_id: str, callpark_id: str, settings: CallPark, org_id: str | None = None) → str[source]

Update a Call Park

Update the designated Call Park.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

Updating a call park requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

NOTE: The Call Park ID will change upon modification of the Call Park name.

Parameters:

  • location_id (str) – RLocation in which this call park exists.

  • callpark_id (str) – Update settings for a call park with the matching ID.

  • settings (CallPark) – updates

  • org_id (str) – Update call park settings from this organization.

available_agents(location_id: str, call_park_name: str | None = None, name: str | None = None, phone_number: str | None = None, order: str | None = None, org_id: str | None = None) → Generator[PersonPlaceAgent, None, None][source]

Get available agents from Call Parks Retrieve available agents from call parks for a given location.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

Retrieving available agents from call parks requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Return the available agents for this location.

  • call_park_name (str) – Only return available agents from call parks with the matching name.

  • name (str) – Only return available agents with the matching name.

  • phone_number (str) – Only return available agents with the matching primary number.

  • order (str) – Order the available agents according to the designated fields. Up to three vertical bar (|) separated sort order fields may be specified. Available sort fields: fname, lname, number and extension. The maximum supported sort order value is 3.

  • org_id (str) – Return the available agents for this organization.

Returns:

yields PersonPlaceCallPark objects

available_recalls(location_id: str, name: str | None = None, order: str | None = None, org_id: str | None = None) → Generator[AvailableRecallHuntGroup, None, None][source]

Get available recall hunt groups from Call Parks

Retrieve available recall hunt groups from call parks for a given location.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

Retrieving available recall hunt groups from call parks requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Return the available recall hunt groups for this location.

  • name (str) – Only return available recall hunt groups with the matching name.

  • order – Order the available recall hunt groups according to the designated fields. Available sort fields: lname.

  • order – str

  • org_id (str) – Return the available recall hunt groups for this organization.

Returns:

yields AvailableRecallHuntGroup objects

call_park_settings(location_id: str, org_id: str | None = None) → LocationCallParkSettings[source]

Get Call Park Settings

Retrieve Call Park Settings from call parks for a given location.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

Retrieving settings from call parks requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Return the call park settings for this location.

  • org_id (str) – Return the call park settings for this organization.

Returns:

update_call_park_settings(location_id: str, settings: LocationCallParkSettings, org_id: str | None = None)[source]

Update Call Park settings

Update Call Park settings for the designated location.

Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

Updating call park settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Location for which call park settings will be updated.

  • settings (LocationCallParkSettings) – update settings

  • org_id (str) – Update call park settings from this organization.

base = 'telephony/config/callParks'