wxc_sdk.person_settings.agent_caller_id module

API to manage call queue agent caller ID information

class wxc_sdk.person_settings.agent_caller_id.AgentQueue(*, id: str | None = None, name: str | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None)[source]

Bases: ApiModel

Available queue

id: str | None

Indicates the Call Queue’s unique identifier.

name: str | None

Indicates the Call Queue’s name.

phone_number: str | None

When not null, indicates the Call Queue’s phone number.

extension: str | None

When not null, indicates the Call Queue’s extension number.

routing_prefix: str | None

Routing prefix of location.

esn: str | None

Routing prefix + extension of a person or workspace.

class wxc_sdk.person_settings.agent_caller_id.QueueCallerId(*, queueCallerIdEnabled: bool | None = None, selectedQueue: AgentQueue | None = None)[source]

Bases: ApiModel

call queue agent’s Caller ID information

queue_caller_id_enabled: bool | None

When true, indicates that this agent is using the selectedQueue for its Caller ID. When false, indicates that it is using the agent’s configured Caller ID.

selected_queue: AgentQueue | None

It is empty object when queueCallerIdEnabled is false. When queueCallerIdEnabled is true this data must be populated

classmethod root(values)[source]

:meta private

if no agent caller id is configured API returns a selectedQueue with id == None. In that case we pop the queue so that instead selectedQueue == None

class wxc_sdk.person_settings.agent_caller_id.AgentCallerIdApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

API to manage call queue agent caller ID information

available_queues(person_id: str, org_id: str | None = None) → Generator[AgentQueue, None, None][source]

Retrieve the list of the person’s available call queues and the associated Caller ID information

If the Agent is to enable queueCallerIdEnabled, they must choose which queue to use as the source for outgoing Caller ID. This API returns a list of Call Queues from which the person must select. If this setting is disabled or Agent does not belong to any queue this list will be empty.

This API requires a full admin or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • org_id (str) – organization id

Returns:

yields person’s available call queues and the associated Caller ID information

Return type:

Generator[AgentQueue, None, None]

read(person_id: str, org_id: str | None = None) → QueueCallerId[source]

Retrieve a call queue agent’s Caller ID information

Each agent in the Call Queue will be able to set their outgoing Caller ID as either the Call Queue’s phone number or their own configured Caller ID. This API fetches the configured Caller ID for the agent in the system.

This API requires a full admin or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • org_id (str) – organization id

Returns:

call queue agent’s Caller ID information

Return type:

QueueCallerId

update(person_id: str, update: QueueCallerId, org_id: str | None = None)[source]

Modify a call queue agent’s Caller ID information

Each Agent in the Call Queue will be able to set their outgoing Caller ID as either the designated Call Queue’s phone number or their own configured Caller ID. This API modifies the configured Caller ID for the agent in the system.

This API requires a full or user administrator auth token with the spark-admin:telephony_config_write scope.

Parameters:

  • person_id (str) – Unique identifier for the person.

  • update (QueueCallerId) – new settings

  • org_id (str) – organization id

base = 'telephony/config/people'