wxc_sdk.me.callcenter package
- class wxc_sdk.me.callcenter.MeCallCenterApi(*, session: RestSession, base: str | None = None)[source]
Bases:
ApiChild- settings() MeCallCenterSettings[source]
Get My Call Center Settings
Retrieves the call center settings and list of all call centers the logged in user belongs to.
Calls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors. The user must have the call center service assigned.
This API requires a user auth token with a scope of spark:telephony_config_read.
- Return type:
- modify(settings: MeCallCenterSettings)[source]
Modify My Call Center Settings
Modify the call center settings and availability for an agent in one or more call centers to which the logged in user belongs.
Calls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors. Contains a list specifying the desired availability status of one or more call centers.
This API requires a user auth token with a scope of spark:telephony_config_write.
- Parameters:
settings (
MeCallCenterSettings) – settings
- base = 'telephony/config/people/me'
- class wxc_sdk.me.callcenter.MeCallCenterSettings(*, agentACDState: AgentACDState | None = None, queues: list[MeCallQueue] | None = None, **extra_data: Any)[source]
Bases:
ApiModel- agent_acdstate: AgentACDState | None
- queues: list[MeCallQueue] | None
Indicates a list of call centers the agent has joined or may join.
- class wxc_sdk.me.callcenter.MeCallQueue(*, id: str | None = None, hasCxEssentials: bool | None = None, available: bool | None = None, skillLevel: int | None = None, phoneNumber: str | None = None, extension: str | None = None, allowLogOffEnabled: bool | None = None, **extra_data: Any)[source]
Bases:
ApiModel- id: str | None
Unique call queue identifier.
- has_cx_essentials: bool | None
Indicates if the call queue is normal or CxEssentials.
- available: bool | None
When true it indicates agent has joined the call center.
- skill_level: int | None
Call center skill level.
- phone_number: str | None
Call center phone number.
- extension: str | None
Call center extension.
- allow_log_off_enabled: bool | None
Determines whether a queue can be joined or not.
- class wxc_sdk.me.callcenter.AgentACDState(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
str,SafeEnumAn enumeration.
- sign_in = 'SIGN_IN'
Agent has signed in.
- sign_out = 'SIGN_OUT'
Agent has signed out.
- available = 'AVAILABLE'
Agent is available.
Agent is unavailable.
- wrap_up = 'WRAP_UP'
Agent has wrapped up.