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.AvailableCallerIdType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, SafeEnum

An enumeration.

call_queue = 'CALL_QUEUE'

A call queue has been selected for the agent’s caller ID.

hunt_group = 'HUNT_GROUP'

A hunt group has been selected for the agent’s caller ID.

class wxc_sdk.person_settings.agent_caller_id.AgentCallerId(*, id: str | None = None, type: AvailableCallerIdType | None = None, name: str | None = None, phoneNumber: str | None = None, extension: str | None = None, **extra_data: Any)[source]

Bases: ApiModel

id: str | None

Call queue or hunt group’s unique identifier.

type: AvailableCallerIdType | None

Member is of type CALL_QUEUE or HUNT_GROUP

name: str | None

Call queue or hunt group’s name.

phone_number: str | None

When not null, it is call queue or hunt group’s phone number.

extension: str | None

When not null, it is call queue or hunt group’s extension number.

class wxc_sdk.person_settings.agent_caller_id.AgentCallerIdApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API to manage agent caller id settings

Also used for virtual lines

feature = 'agent'
available_caller_ids(entity_id: str, org_id: str | None = None) → list[AgentCallerId][source]

Retrieve Agent’s List of Available Caller IDs

Get the list of call queues and hunt groups available for caller ID use by this person, virtual line, or workspace as an agent.

This API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:people_read.

Parameters:

  • entity_id (str) – Unique identifier for the person, virtual line, or workspace.

  • org_id (str) – ID of the organization in which the entity resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.

Return type:

list[AvailableCallerIdObject]

read(entity_id: str) → AgentCallerId[source]

Retrieve Agent’s Caller ID Information

Retrieve the Agent’s Caller ID Information.

Each agent will be able to set their outgoing Caller ID as either the Call Queue’s Caller ID, Hunt Group’s Caller ID or their own configured Caller ID.

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

Parameters:

entity_id (str) – Unique identifier for the person, virtual line, or workspace

Return type:

AgentCallerId

configure(entity_id: str, selected_caller_id: str | None = None)[source]

Modify Agent’s Caller ID Information.

Each Agent will be able to set their outgoing Caller ID as either the designated Call Queue’s Caller ID or Hunt Group’s Caller ID or their own configured Caller ID

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

Parameters:

  • entity_id (str) – Unique identifier for the person, virtual line, or workspace

  • selected_caller_id (str) – The unique identifier of the call queue or hunt group to use for the agent’s caller ID. Set to null to use the agent’s own caller ID.

Return type:

None

base = ''