wxc_sdk.telephony.callpickup module

class wxc_sdk.telephony.callpickup.CallPickup(*, id: str | None = None, name: str | None = None, locationName: str | None = None, locationId: str | None = None, notificationType: PickupNotificationType | None = None, notificationDelayTimerSeconds: int | None = None, agents: list[PersonPlaceAgent] | None = None)[source]

Bases: ApiModel

pickup_id: str | None

A unique identifier for the call pickup.

name: str | None

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

location_name: str | None

Name of location for call pickup.

location_id: str | None

ID of location for call pickup.

notification_type: PickupNotificationType | None

Type of the notification when an incoming call is unanswered, the call pickup group notifies all of its members.

notification_delay_timer_seconds: int | None

After the number of seconds given by the notificationDelayTimerSeconds has elapsed, notify every member of the call pickup group when an incoming call goes unanswered. The notificationType field specifies the notification method.

agents: list[PersonPlaceAgent] | None

People, workspaces and virtual lines that are eligible to receive calls.

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

Bases: str, SafeEnum

An enumeration.

none = 'NONE'

Notification is not sent to any member of the call pickup group.

audio_only = 'AUDIO_ONLY'

When the notificationDelayTimerSeconds number of seconds has elapsed, play an audio notification for each call pickup group member.

visual_only = 'VISUAL_ONLY'

When the notificationDelayTimerSeconds number of seconds has elapsed, provide a visual notification to every call pickup group member.

audio_and_visual = 'AUDIO_AND_VISUAL'

When the notificationDelayTimerSeconds number of seconds has elapsed, provide a audio and visual notification to every call pickup group member.

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

Bases: ApiChild

Call Pickup API

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

Read the List of Call Pickups

List all Call Pickups for the organization.

Call Pickup enables a user(agent) to answer any ringing line within their pickup group.

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

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

Parameters:

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

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

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

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

Returns:

yields CallPickup objects

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

Create a Call Pickup

Create new Call Pickups for the given location.

Call Pickup enables a user(agent) to answer any ringing line within their pickup group.

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

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

Parameters:

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

  • settings (CallPickup) – settings for new call pickup

  • org_id – Create the call pickup for this organization.

Returns:

ID of the newly created call pickup.

Return type:

str

delete_pickup(location_id: str, pickup_id: str, org_id: str | None = None)[source]

Delete a Call Pickup

Delete the designated Call Pickup.

Call Pickup enables a user(agent) to answer any ringing line within their pickup group.

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

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

Parameters:

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

  • pickup_id (str) – Delete the call pickup with the matching ID.

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

details(location_id: str, pickup_id: str, org_id: str | None = None) → CallPickup[source]

Get Details for a Call Pickup

Retrieve Call Pickup details.

Call Pickup enables a user(agent) to answer any ringing line within their pickup group.

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

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

Parameters:

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

  • pickup_id (str) – Retrieve settings for a call pickup with the matching ID.

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

Returns:

call pickup info

Return type:

CallPickup

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

Update a Call Pickup

Update the designated Call Pickup.

Call Pickup enables a user(agent) to answer any ringing line within their pickup group.

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

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

Parameters:

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

  • pickup_id (str) – Update settings for a call pickup with the matching ID.

  • settings (CallPickup) – updates

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

available_agents(location_id: str, call_pickup_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 Pickups Retrieve available agents from call pickups for a given location.

Call Pickup enables a user(agent) to answer any ringing line within their pickup group.

Retrieving available agents from call pickups requires a full, user, 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_pickup_name (str) – Only return available agents from call pickups 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

base = 'telephony/config/callPickups'