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, agents: list[wxc_sdk.common.PersonPlaceAgent] | None = None)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

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.

agents: list[wxc_sdk.common.PersonPlaceAgent] | None

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

create_or_update() → str

Get JSON for create or update call

Returns:

JSON

Return type:

str

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

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]

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

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)

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

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

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]

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'

session: RestSession

REST session