wxc_sdk.telephony.supervisor package

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

Bases: ApiChild

Supervisors

Supervisors are users who manage agents and who perform functions including monitoring, coaching, and more.

Viewing these read-only device settings requires a full, device or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Modifying these device settings requires a full or device administrator auth token with a scope of spark-admin:telephony_config_write.

list(name: str | None = None, phone_number: str | None = None, order: str | None = None, org_id: str | None = None, **params) → Generator[AgentOrSupervisor, None, None]

Get List of Supervisors

Get list of supervisors for an organization.

Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

Requires a full, location, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

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

• phone_number (str) – Only return supervisors with matching primary phone number.

• order (str) – Sort results alphabetically by supervisor name, in ascending or descending order.

• org_id (str) – List the supervisors for this organization.

Returns:

Generator yielding AgentOrSupervisor instances

create(id: str, agents: List[str], org_id: str | None = None)

Create a Supervisor

Create a new supervisor. The supervisor must be created with atleast one agent.

Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

Requires a full or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• id (str) – A unique identifier for the supervisor.

• agents (list[str]) – Ids of People, workspaces and virtual lines that are eligible to receive calls.

• org_id (str) – Create supervisor for this organization.

Return type:

None

delete(supervisor_id: str, org_id: str | None = None)

Delete A Supervisor

Deletes the supervisor from an organization.

Supervisors are users who manage agents and who perform functions including monitoring, coaching, and more.

Requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• supervisor_id (str) – Delete the specified supervisor.

• org_id (str) – Delete the supervisor in the specified organization.

Return type:

None

delete_bulk(supervisors_ids: List[str], delete_all: bool | None = None, org_id: str | None = None)

Delete Bulk supervisors

Deletes supervisors in bulk from an organization.

Supervisors are users who manage agents and who perform functions including monitoring, coaching, and more.

Requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• supervisors_ids (list[str]) – Array of supervisors IDs to be deleted.

• delete_all (bool) – If present the supervisorIds array is ignored, and all supervisors in the context are deleted. WARNING: This will remove all supervisors from the organization.

• org_id (str) – Delete supervisors in bulk for this organization.

Return type:

None

available_supervisors(name: str | None = None, phone_number: str | None = None, order: str | None = None, org_id: str | None = None, **params) → Generator[AgentOrSupervisor, None, None]

List Available Supervisors

Get list of available supervisors for an organization.

Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

Requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

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

• phone_number (str) – Only return supervisors with matching primary phone number.

• order (str) – Sort results alphabetically by supervisor name, in ascending or descending order.

• org_id (str) – List available supervisors of this organization.

Returns:

Generator yielding AgentOrSupervisor instances

details(supervisor_id: str, name: str | None = None, phone_number: str | None = None, order: str | None = None, org_id: str | None = None, **params) → Generator[AgentOrSupervisor, None, None]

GET Supervisor Details

Get list of agents associated with the supervisor for an organization.

Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

Requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

• supervisor_id (str) – List the agents assigned to specific supervisor.

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

• phone_number (str) – Only return supervisors with matching primary phone number.

• order (str) – Sort results alphabetically by supervisor name, in ascending or descending order.

• org_id (str) – List the agents assigned to specific supervisor for this organization.

Returns:

Generator yieldig AgentOtSupervisor instances

assign_un_assign_agents(supervisor_id: str, agents: List[IdAndAction], org_id: str | None = None) → List[SupervisorAgentStatus] | None

Assign/Un-assign Agents to Supervisor

Assign or unassign agents to the supervisor for an organization.

Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

Requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

• supervisor_id (str) – Identifier of the superviser to be updated.

• agents (list[IdAndAction]) – agents to be assigned or unasssigned

• org_id (str) – Assign or unassign agents to a supervisor for this organization.

Return type:

list[SupervisorAgentStatus]

available_agents(name: str | None = None, phone_number: str | None = None, order: str | None = None, org_id: str | None = None, **params) → Generator[AgentOrSupervisor, None, None]

List Available Agents

Get list of available agents for an organization.

Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

Requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

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

• phone_number (str) – Only return supervisors with matching primary phone number.

• order (str) – Sort results alphabetically by supervisor name, in ascending or descending order.

• org_id (str) – List of agents in a supervisor’s list for this organization.

Returns:

Generator yielding AgentOrSupervisor instances

base = 'telephony/config/supervisors'

class wxc_sdk.telephony.supervisor.IdAndAction(*, id: str | None, action: PatternAction)

Bases: ApiModel

id: str | None

ID of person, workspace or virtual line.

action: PatternAction

Enumeration that indicates whether an agent needs to be added (ADD) or deleted (DELETE) from a supervisor.

class wxc_sdk.telephony.supervisor.SupervisorAgentStatus(*, id: str | None = None, status: str | None = None, message: str | None = None)

Bases: ApiModel

id: str | None

ID of person, workspace or virtual line.

status: str | None

status of the agent.

message: str | None

Detailed message for the status.

class wxc_sdk.telephony.supervisor.AgentOrSupervisor(*, id: str | None = None, firstName: str | None = None, lastName: str | None = None, displayName: str | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, type: UserType | None = None, agentCount: int | None = None)

Bases: ApiModel

id: str | None

A unique identifier for the supervisor.

first_name: str | None

First name of the supervisor.

last_name: str | None

Last name of the supervisor.

display_name: str | None

phone_number: str | None

Primary phone number of the supervisor.

extension: str | None

Primary phone extension of the supervisor.

routing_prefix: str | None

Routing prefix of location.

esn: str | None

Routing prefix + extension of a person.

type: UserType | None

Type of the person, workspace or virtual line.

agent_count: int | None

Number of agents managed by supervisor. A supervisor must manage at least one agent.