wxc_sdk.telephony.callqueue.agents package

class wxc_sdk.telephony.callqueue.agents.CallQueueAgent(*, id: str | None = None, firstName: str | None = None, lastName: str | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, queueCount: int | None = None, locationCount: int | None = None, joinCount: int | None = None, unjoinCount: int | None = None, location: IdAndName | None = None, type: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique call queue agent identifier.

first_name: str | None

First name for the call queue agent.

last_name: str | None

Last name for the call queue agent.

phone_number: str | None

Primary phone number of the call queue agent.

extension: str | None

Primary phone extension of the call queue agent.

routing_prefix: str | None
esn: str | None

Routing prefix + extension of a agent.

queue_count: int | None

Denotes the queue count for call queue agent.

location_count: int | None

Denotes the location count for call queue agent.

join_count: int | None

Denotes the join count for call queue agent.

unjoin_count: int | None

Denotes unjoin count for call queue agent.

location: IdAndName | None

Specifies the location information.

type: str | None

Specifies the type of the call queue agent.

class wxc_sdk.telephony.callqueue.agents.CallQueueAgentQueue(*, id: str | None = None, name: str | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, locationId: str | None = None, locationName: str | None = None, joinEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Unique identifier of the call queue.

name: str | None

Unique name for the call queue.

phone_number: str | None

Primary phone number of the call queue.

extension: str | None

The extension number for this call queue.

routing_prefix: str | None

Specifies the routing prefix of the call queue.

esn: str | None

Routing prefix + extension of the call queue.

location_id: str | None

The location identifier of the call queue.

location_name: str | None

The location name where the call queue resides.

join_enabled: bool | None

Whether or not the call queue is enabled.

class wxc_sdk.telephony.callqueue.agents.CallQueueAgentDetail(*, agent: CallQueueAgent | None = None, queues: list[CallQueueAgentQueue] | None = None, **extra_data: Any)[source]

Bases: ApiModel

agent: CallQueueAgent | None
queues: list[CallQueueAgentQueue] | None
class wxc_sdk.telephony.callqueue.agents.AgentCallQueueSetting(*, queueId: str | None = None, joinEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

queue_id: str | None

Unique call queue identifier.

join_enabled: bool | None

Whether or not the call queue is enabled.

class wxc_sdk.telephony.callqueue.agents.CallQueueAgentsApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Call Queue Agents API

list(location_id: str | None = None, queue_id: str | None = None, name: str | None = None, phone_number: str | None = None, join_enabled: bool | None = None, has_cx_essentials: bool | None = None, order: str | None = None, org_id: str | None = None, **params) → Generator[CallQueueAgent, None, None][source]

Read the List of Call Queue Agents

List all Call Queues Agents for the organization.

Agents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.

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

Note: The decoded value of the agent’s id, and the type returned in the response, are always returned as PEOPLE, even when the agent is a workspace or virtual line. This will be addressed in a future release.

Parameters:

  • location_id (str) – Return only the call queue agents in this location.

  • queue_id (str) – Only return call queue agents with the matching queue ID.

  • name (str) – Returns only the list of call queue agents that match the given name.

  • phone_number (str) – Returns only the list of call queue agents that match the given phone number or extension.

  • join_enabled (bool) – Returns only the list of call queue agents that match the given joinEnabled value.

  • has_cx_essentials (bool) – Returns only the list of call queues with Customer Experience Essentials license when true, otherwise returns the list of Customer Experience Basic call queues.

  • order (str) – Sort results alphabetically by call queue agent’s name, in ascending or descending order.

  • org_id (str) – List call queues agents in this organization.

Returns:

Generator yielding ListCallQueueAgentObject instances

details(id: str, has_cx_essentials: bool | None = None, max_: int = 50, start: int = 0, org_id: str | None = None) → CallQueueAgentDetail[source]

Get Details for a Call Queue Agent

Retrieve details of a particular Call queue agent based on the agent ID.

Agents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.

Retrieving a call queue agent’s details require a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Note: The agent’s type returned in the response and in the decoded value of the agent’s id, is always of type PEOPLE, even if the agent is a workspace or virtual line. This` will be corrected in a future release.

Parameters:

  • id (str) – Retrieve call queue agents with this identifier.

  • max (int) – Limits the number of objects returned to this maximum count.

  • start (int) – Start at the zero-based offset in the list of matching objects.

  • has_cx_essentials (bool) – Must be set to true to view the details of an agent with Customer Experience Essentials license. This can otherwise be ommited or set to false.

  • org_id (str) – Retrieve call queue agents from this organization.

Return type:

CallQueueAgentDetail

update_call_queue_settings(id: str, settings: List[AgentCallQueueSetting], has_cx_essentials: bool | None = None, org_id: str | None = None)[source]

Update an Agent’s Settings of One or More Call Queues

Modify an agent’s call queue settings for an organization.

Calls from the call queue are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.

This operation requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • id (str) – Identifier of the agent to be updated.

  • has_cx_essentials (bool) – Must be set to true to modify an agent that has Customer Experience Essentials license. This can otherwise be ommited or set to false.

  • org_id (str) – Update the settings of an agent in this organization.

Return type:

None

base = 'telephony/config/queues/agents'