wxc_sdk.telephony.callpark_extension module

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

Bases: ApiChild

Call Park Extension API

list(extension: str | None = None, name: str | None = None, location_id: str | None = None, location_name: str | None = None, order: str | None = None, org_id: str | None = None, **params) → Generator[CallParkExtension, None, None][source]

Read the List of Call Park Extensions

List all Call Park Extensions for the organization.

The Call Park service, enabled for all users by default, allows a user to park a call against an available user’s extension or to a Call Park Extension. Call Park Extensions are extensions defined within the Call Park service for holding parked calls.

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

Parameters:

  • extension (str) – Only return call park extensions with the matching extension.

  • name (str) – Only return call park extensions with the matching name.

  • location_id (str) – Only return call park extensions with matching location ID.

  • location_name (str) – Only return call park extensions with matching location name.

  • order (str) – Order the available agents according to the designated fields. Available sort fields: groupName, callParkExtension, callParkExtensionName, callParkExtensionExternalId.

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

  • params – additional parameters

Returns:

yields wxc_sdk.common.CallParkExtension instances

details(location_id: str, cpe_id: str, org_id: str | None = None) → CallParkExtension[source]

Get Details for a Call Park Extension

Retrieve Call Park Extension details.

The Call Park service, enabled for all users by default, allows a user to park a call against an available user’s extension or to a Call Park Extension. Call Park Extensions are extensions defined within the Call Park service for holding parked calls.

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

Parameters:

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

  • cpe_id (str) – Retrieve details for a call park extension with the matching ID.

  • org_id (str) – Retrieve call park extension details from this organization

Returns:

call park extension details

Return type:

wxc_sdk.common.CallParkExtension instance (only name and extension are set)

create(location_id: str, name: str, extension: str, org_id: str | None = None) → str[source]

Create new Call Park Extensions for the given location. Call Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension. Call Park Extensions can be added as monitored lines by users’ Cisco phones, so users can park and retrieve calls by pressing the associated phone line key. Creating a call park extension requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

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

  • name (str) – Name for the call park extension. The maximum length is 30.

  • extension (str) – Unique extension which will be assigned to call park extension. The minimum length is 2, maximum length is 10.

  • org_id (str) – Create the call park extension for this organization.

Returns:

id of the new call park extension

Return type:

str

delete(location_id: str, cpe_id: str, org_id: str | None = None)[source]

Delete the designated Call Park Extension. Call Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension. Call Park Extensions can be added as monitored lines by users’ Cisco phones, so users can park and retrieve calls by pressing the associated phone line key. Deleting a call park extension requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

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

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

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

update(location_id: str, cpe_id: str, name: str | None = None, extension: str | None = None, org_id: str | None = None)[source]

Update the designated Call Park Extension. Call Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension. Call Park Extensions can be added as monitored lines by users’ Cisco phones, so users can park and retrieve calls by pressing the associated phone line key. Updating a call park extension requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

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

  • cpe_id (str) – Update a call park extension with the matching ID.

  • name (str) – Name for the call park extension. The maximum length is 30.

  • extension (str) – Unique extension which will be assigned to call park extension. The minimum length is 2, maximum length is 10.

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

base = 'telephony'