@webex/contact-center 3.12.0-webex-services-ready.4 → 3.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.sdd/manifest.json +24 -13
- package/ai-docs/ARCHITECTURE.md +1 -1
- package/ai-docs/CONTRACTS.md +19 -3
- package/ai-docs/SECURITY.md +1 -1
- package/ai-docs/SERVICE_STATE.md +4 -0
- package/ai-docs/contact-center-spec.md +50 -6
- package/ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md +362 -0
- package/ai-docs/features/contact-owner-change-refactor.md +78 -0
- package/dist/cc.js +757 -22
- package/dist/cc.js.map +1 -1
- package/dist/config.js +7 -0
- package/dist/config.js.map +1 -1
- package/dist/constants.js +23 -2
- package/dist/constants.js.map +1 -1
- package/dist/index.js +34 -12
- package/dist/index.js.map +1 -1
- package/dist/metrics/MetricsManager.js +16 -0
- package/dist/metrics/MetricsManager.js.map +1 -1
- package/dist/metrics/behavioral-events.js +110 -0
- package/dist/metrics/behavioral-events.js.map +1 -1
- package/dist/metrics/constants.js +33 -0
- package/dist/metrics/constants.js.map +1 -1
- package/dist/services/AddressBook.js +18 -15
- package/dist/services/AddressBook.js.map +1 -1
- package/dist/services/AnswerCallOnWebexService.js +202 -0
- package/dist/services/AnswerCallOnWebexService.js.map +1 -0
- package/dist/services/ApiAiAssistant.js +221 -11
- package/dist/services/ApiAiAssistant.js.map +1 -1
- package/dist/services/EntryPoint.js +46 -68
- package/dist/services/EntryPoint.js.map +1 -1
- package/dist/services/Queue.js +27 -22
- package/dist/services/Queue.js.map +1 -1
- package/dist/services/WebCallingService.js +10 -2
- package/dist/services/WebCallingService.js.map +1 -1
- package/dist/services/WebexCrossClientService.js +225 -0
- package/dist/services/WebexCrossClientService.js.map +1 -0
- package/dist/services/WxAppTelephonyMercurySync.js +111 -0
- package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
- package/dist/services/config/Util.js +46 -46
- package/dist/services/config/Util.js.map +1 -1
- package/dist/services/config/constants.js +34 -77
- package/dist/services/config/constants.js.map +1 -1
- package/dist/services/config/index.js +100 -226
- package/dist/services/config/index.js.map +1 -1
- package/dist/services/config/types.js +51 -18
- package/dist/services/config/types.js.map +1 -1
- package/dist/services/constants.js +11 -1
- package/dist/services/constants.js.map +1 -1
- package/dist/services/core/Err.js.map +1 -1
- package/dist/services/core/Utils.js +25 -1
- package/dist/services/core/Utils.js.map +1 -1
- package/dist/services/core/WebexRequest.js +6 -2
- package/dist/services/core/WebexRequest.js.map +1 -1
- package/dist/services/core/aqm-reqs.js +17 -11
- package/dist/services/core/aqm-reqs.js.map +1 -1
- package/dist/services/core/constants.js +9 -1
- package/dist/services/core/constants.js.map +1 -1
- package/dist/services/core/types.js.map +1 -1
- package/dist/services/core/websocket/WebSocketManager.js +17 -1
- package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
- package/dist/services/task/Task.js +275 -8
- package/dist/services/task/Task.js.map +1 -1
- package/dist/services/task/TaskFactory.js +11 -6
- package/dist/services/task/TaskFactory.js.map +1 -1
- package/dist/services/task/TaskManager.js +590 -42
- package/dist/services/task/TaskManager.js.map +1 -1
- package/dist/services/task/TaskUtils.js +11 -1
- package/dist/services/task/TaskUtils.js.map +1 -1
- package/dist/services/task/WebexCallingUtils.js +70 -0
- package/dist/services/task/WebexCallingUtils.js.map +1 -0
- package/dist/services/task/constants.js +14 -2
- package/dist/services/task/constants.js.map +1 -1
- package/dist/services/task/contact.js +29 -0
- package/dist/services/task/contact.js.map +1 -1
- package/dist/services/task/digital/Digital.js +4 -3
- package/dist/services/task/digital/Digital.js.map +1 -1
- package/dist/services/task/state-machine/TaskStateMachine.js +162 -53
- package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -1
- package/dist/services/task/state-machine/actions.js +6 -1
- package/dist/services/task/state-machine/actions.js.map +1 -1
- package/dist/services/task/state-machine/guards.js +7 -10
- package/dist/services/task/state-machine/guards.js.map +1 -1
- package/dist/services/task/state-machine/types.js.map +1 -1
- package/dist/services/task/state-machine/uiControlsComputer.js +118 -18
- package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -1
- package/dist/services/task/types.js +47 -1
- package/dist/services/task/types.js.map +1 -1
- package/dist/services/task/voice/Voice.js +477 -17
- package/dist/services/task/voice/Voice.js.map +1 -1
- package/dist/services/task/voice/WebRTC.js +6 -3
- package/dist/services/task/voice/WebRTC.js.map +1 -1
- package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
- package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
- package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
- package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
- package/dist/services/wxAppDiagnosticLogging.js +159 -0
- package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
- package/dist/services/wxAppTelephonyUtils.js +19 -0
- package/dist/services/wxAppTelephonyUtils.js.map +1 -0
- package/dist/types/cc.d.ts +102 -8
- package/dist/types/config.d.ts +7 -0
- package/dist/types/constants.d.ts +21 -0
- package/dist/types/index.d.ts +34 -15
- package/dist/types/metrics/MetricsManager.d.ts +6 -0
- package/dist/types/metrics/constants.d.ts +31 -0
- package/dist/types/services/AddressBook.d.ts +2 -1
- package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
- package/dist/types/services/ApiAiAssistant.d.ts +48 -4
- package/dist/types/services/EntryPoint.d.ts +7 -5
- package/dist/types/services/Queue.d.ts +5 -3
- package/dist/types/services/WebexCrossClientService.d.ts +32 -0
- package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
- package/dist/types/services/config/Util.d.ts +4 -8
- package/dist/types/services/config/constants.d.ts +28 -76
- package/dist/types/services/config/index.d.ts +16 -64
- package/dist/types/services/config/types.d.ts +146 -173
- package/dist/types/services/constants.d.ts +9 -0
- package/dist/types/services/core/Err.d.ts +2 -0
- package/dist/types/services/core/Utils.d.ts +10 -0
- package/dist/types/services/core/WebexRequest.d.ts +1 -0
- package/dist/types/services/core/constants.d.ts +7 -0
- package/dist/types/services/core/types.d.ts +2 -0
- package/dist/types/services/task/Task.d.ts +34 -5
- package/dist/types/services/task/TaskFactory.d.ts +4 -2
- package/dist/types/services/task/TaskUtils.d.ts +6 -0
- package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
- package/dist/types/services/task/constants.d.ts +12 -0
- package/dist/types/services/task/contact.d.ts +4 -0
- package/dist/types/services/task/digital/Digital.d.ts +4 -3
- package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +304 -56
- package/dist/types/services/task/state-machine/guards.d.ts +6 -5
- package/dist/types/services/task/state-machine/types.d.ts +9 -1
- package/dist/types/services/task/types.d.ts +192 -5
- package/dist/types/services/task/voice/Voice.d.ts +68 -11
- package/dist/types/services/task/voice/WebRTC.d.ts +5 -4
- package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
- package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
- package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
- package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
- package/dist/types/types.d.ts +80 -13
- package/dist/types/utils/PageCache.d.ts +20 -3
- package/dist/types.js +54 -8
- package/dist/types.js.map +1 -1
- package/dist/utils/PageCache.js +19 -5
- package/dist/utils/PageCache.js.map +1 -1
- package/dist/webex.js +9 -1
- package/dist/webex.js.map +1 -1
- package/package.json +10 -9
- package/src/cc.ts +969 -38
- package/src/config.ts +7 -0
- package/src/constants.ts +24 -0
- package/src/index.ts +39 -10
- package/src/metrics/MetricsManager.ts +16 -0
- package/src/metrics/ai-docs/metrics-spec.md +138 -21
- package/src/metrics/behavioral-events.ts +112 -0
- package/src/metrics/constants.ts +36 -0
- package/src/services/AddressBook.ts +17 -6
- package/src/services/AnswerCallOnWebexService.ts +239 -0
- package/src/services/ApiAiAssistant.ts +297 -13
- package/src/services/EntryPoint.ts +59 -60
- package/src/services/Queue.ts +29 -12
- package/src/services/WebCallingService.ts +16 -2
- package/src/services/WebexCrossClientService.ts +298 -0
- package/src/services/WxAppTelephonyMercurySync.ts +142 -0
- package/src/services/agent/ai-docs/AGENTS.md +1 -1
- package/src/services/agent/ai-docs/agent-spec.md +1 -0
- package/src/services/ai-docs/AGENTS.md +10 -10
- package/src/services/ai-docs/services-spec.md +25 -5
- package/src/services/config/Util.ts +52 -82
- package/src/services/config/ai-docs/AGENTS.md +35 -40
- package/src/services/config/ai-docs/ARCHITECTURE.md +90 -103
- package/src/services/config/ai-docs/config-spec.md +132 -132
- package/src/services/config/constants.ts +39 -85
- package/src/services/config/index.ts +116 -277
- package/src/services/config/types.ts +140 -195
- package/src/services/constants.ts +10 -0
- package/src/services/core/Err.ts +1 -0
- package/src/services/core/Utils.ts +28 -0
- package/src/services/core/WebexRequest.ts +3 -1
- package/src/services/core/ai-docs/core-spec.md +25 -11
- package/src/services/core/aqm-reqs.ts +18 -12
- package/src/services/core/constants.ts +8 -0
- package/src/services/core/types.ts +33 -1
- package/src/services/core/websocket/WebSocketManager.ts +26 -2
- package/src/services/task/Task.ts +386 -12
- package/src/services/task/TaskFactory.ts +33 -6
- package/src/services/task/TaskManager.ts +857 -41
- package/src/services/task/TaskUtils.ts +13 -0
- package/src/services/task/WebexCallingUtils.ts +136 -0
- package/src/services/task/ai-docs/ARCHITECTURE.md +1 -0
- package/src/services/task/ai-docs/task-spec.md +190 -8
- package/src/services/task/constants.ts +13 -0
- package/src/services/task/contact.ts +30 -0
- package/src/services/task/digital/Digital.ts +11 -4
- package/src/services/task/state-machine/TaskStateMachine.ts +235 -81
- package/src/services/task/state-machine/actions.ts +5 -2
- package/src/services/task/state-machine/ai-docs/AGENTS.md +6 -4
- package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +35 -16
- package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +103 -33
- package/src/services/task/state-machine/guards.ts +7 -10
- package/src/services/task/state-machine/types.ts +16 -1
- package/src/services/task/state-machine/uiControlsComputer.ts +206 -32
- package/src/services/task/types.ts +269 -4
- package/src/services/task/voice/Voice.ts +625 -17
- package/src/services/task/voice/WebRTC.ts +11 -4
- package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
- package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
- package/src/services/wxAppDiagnosticLogging.ts +286 -0
- package/src/services/wxAppTelephonyUtils.ts +14 -0
- package/src/types.ts +108 -13
- package/src/utils/AGENTS.md +21 -10
- package/src/utils/PageCache.ts +38 -5
- package/src/utils/ai-docs/utils-spec.md +21 -11
- package/src/webex.js +8 -0
- package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
- package/test/unit/spec/cc.ts +3408 -152
- package/test/unit/spec/index.ts +885 -0
- package/test/unit/spec/metrics/MetricsManager.ts +25 -0
- package/test/unit/spec/metrics/behavioral-events.ts +60 -0
- package/test/unit/spec/services/AddressBook.ts +37 -6
- package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
- package/test/unit/spec/services/ApiAiAssistant.ts +269 -8
- package/test/unit/spec/services/EntryPoint.ts +87 -40
- package/test/unit/spec/services/Queue.ts +123 -12
- package/test/unit/spec/services/WebCallingService.ts +38 -0
- package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
- package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
- package/test/unit/spec/services/config/Util.ts +501 -0
- package/test/unit/spec/services/config/index.ts +313 -543
- package/test/unit/spec/services/core/Utils.ts +22 -0
- package/test/unit/spec/services/core/WebexRequest.ts +8 -7
- package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
- package/test/unit/spec/services/core/websocket/WebSocketManager.ts +64 -14
- package/test/unit/spec/services/task/Task.ts +2257 -11
- package/test/unit/spec/services/task/TaskFactory.ts +56 -2
- package/test/unit/spec/services/task/TaskManager.ts +5559 -1493
- package/test/unit/spec/services/task/TaskUtils.ts +72 -0
- package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
- package/test/unit/spec/services/task/contact.ts +33 -0
- package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +1501 -92
- package/test/unit/spec/services/task/state-machine/guards.ts +210 -8
- package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +445 -7
- package/test/unit/spec/services/task/voice/Voice.ts +1710 -4
- package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
- package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
- package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
- package/test/unit/spec/wellnessSampleUtils.ts +288 -0
- package/typedoc.md +1 -1
- package/umd/contact-center.min.js +2 -2
- package/umd/contact-center.min.js.map +1 -1
package/src/cc.ts
CHANGED
|
@@ -26,6 +26,9 @@ import {
|
|
|
26
26
|
UpdateDeviceTypeResponse,
|
|
27
27
|
GenericError,
|
|
28
28
|
ConfigFlags,
|
|
29
|
+
WellnessBreakEvent,
|
|
30
|
+
WellnessBreakNotificationAction,
|
|
31
|
+
WELLNESS_BREAK_NOTIFICATION_ACTIONS,
|
|
29
32
|
} from './types';
|
|
30
33
|
import {
|
|
31
34
|
READY,
|
|
@@ -38,6 +41,7 @@ import {
|
|
|
38
41
|
UNKNOWN_ERROR,
|
|
39
42
|
MERCURY_DISCONNECTED_SUCCESS,
|
|
40
43
|
METHODS,
|
|
44
|
+
WELLNESS_BREAK_HANDLER,
|
|
41
45
|
} from './constants';
|
|
42
46
|
import {AGENT_STATE_AVAILABLE, AGENT_STATE_AVAILABLE_ID} from './services/config/constants';
|
|
43
47
|
import {AGENT, RTD_SUBSCRIBE_API, SUBSCRIBE_API, WEB_RTC_PREFIX} from './services/constants';
|
|
@@ -45,17 +49,22 @@ import Services from './services';
|
|
|
45
49
|
import WebexRequest from './services/core/WebexRequest';
|
|
46
50
|
import LoggerProxy from './logger-proxy';
|
|
47
51
|
import {StateChange, Logout, StateChangeSuccess, AGENT_EVENTS} from './services/agent/types';
|
|
48
|
-
import {getErrorDetails, isValidDialNumber} from './services/core/Utils';
|
|
52
|
+
import {getErrorDetails, isRecord, isValidDialNumber} from './services/core/Utils';
|
|
49
53
|
import {
|
|
50
54
|
Profile,
|
|
51
55
|
WelcomeEvent,
|
|
52
56
|
CC_EVENTS,
|
|
53
57
|
OutdialAniEntriesResponse,
|
|
54
58
|
OutdialAniParams,
|
|
59
|
+
Entity,
|
|
55
60
|
} from './services/config/types';
|
|
56
61
|
import {ConnectionLostDetails} from './services/core/websocket/types';
|
|
57
62
|
import TaskManager from './services/task/TaskManager';
|
|
58
63
|
import WebCallingService from './services/WebCallingService';
|
|
64
|
+
import AnswerCallOnWebexService from './services/AnswerCallOnWebexService';
|
|
65
|
+
import WebexCrossClientService from './services/WebexCrossClientService';
|
|
66
|
+
import WxAppTelephonyMercurySync from './services/WxAppTelephonyMercurySync';
|
|
67
|
+
import {logWxAppSessionReadiness} from './services/wxAppDiagnosticLogging';
|
|
59
68
|
import {
|
|
60
69
|
ITask,
|
|
61
70
|
TASK_EVENTS,
|
|
@@ -78,6 +87,13 @@ import type {
|
|
|
78
87
|
ContactServiceQueueSearchParams,
|
|
79
88
|
} from './types';
|
|
80
89
|
|
|
90
|
+
/**
|
|
91
|
+
* Typed allow-list of server-controlled websocket event names this SDK re-emits verbatim.
|
|
92
|
+
* Guards against emitting an arbitrary/unknown `data.type` supplied by the websocket payload.
|
|
93
|
+
* @ignore
|
|
94
|
+
*/
|
|
95
|
+
const CC_EVENT_ALLOW_LIST = new Set<string>(Object.values(CC_EVENTS));
|
|
96
|
+
|
|
81
97
|
/**
|
|
82
98
|
* The main Contact Center plugin class that enables integration with Webex Contact Center.
|
|
83
99
|
*
|
|
@@ -161,7 +177,7 @@ import type {
|
|
|
161
177
|
*
|
|
162
178
|
* // Login with browser-based calling
|
|
163
179
|
* await cc.stationLogin({
|
|
164
|
-
* teamId: profile.teams[0].
|
|
180
|
+
* teamId: profile.teams[0].id,
|
|
165
181
|
* loginOption: 'BROWSER'
|
|
166
182
|
* });
|
|
167
183
|
*
|
|
@@ -232,6 +248,34 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
232
248
|
*/
|
|
233
249
|
private webCallingService: WebCallingService;
|
|
234
250
|
|
|
251
|
+
/**
|
|
252
|
+
* REST telephony for wxApp thick-client answer (WXCC-6026)
|
|
253
|
+
* @private
|
|
254
|
+
*/
|
|
255
|
+
private answerCallOnWebexService: AnswerCallOnWebexService;
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* usersub cross-client state for Webex App toast suppression
|
|
259
|
+
* @private
|
|
260
|
+
*/
|
|
261
|
+
private webexCrossClientService: WebexCrossClientService;
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Mercury telephony mute sync for wxApp thick-client answer
|
|
265
|
+
* @private
|
|
266
|
+
*/
|
|
267
|
+
private wxAppTelephonyMercurySync: WxAppTelephonyMercurySync;
|
|
268
|
+
|
|
269
|
+
/** True when wxApp mute sync opened Mercury (Extension/DN-only profiles). */
|
|
270
|
+
private wxAppMercuryConnectedByCc = false;
|
|
271
|
+
|
|
272
|
+
/** True when wxApp mute sync registered the Webex device. */
|
|
273
|
+
private wxAppDeviceRegisteredByCc = false;
|
|
274
|
+
|
|
275
|
+
private static readonly WXAPP_FALSE_PUBLISH_RETRY_DELAY_MS = 30_000;
|
|
276
|
+
private static readonly WXAPP_FALSE_PUBLISH_MAX_RETRIES = 3;
|
|
277
|
+
private wxAppFalsePublishRetryTimer?: ReturnType<typeof setTimeout>;
|
|
278
|
+
|
|
235
279
|
/**
|
|
236
280
|
* Core service managers for Contact Center operations
|
|
237
281
|
* Includes agent, connection, and configuration services
|
|
@@ -264,6 +308,19 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
264
308
|
*/
|
|
265
309
|
private metricsManager: MetricsManager;
|
|
266
310
|
|
|
311
|
+
/** Current login/relogin session used for agent-scoped wellness validation. */
|
|
312
|
+
private currentAgentSessionId?: string;
|
|
313
|
+
|
|
314
|
+
/** Registered-session cache for the system WellbeingBreak idle code. */
|
|
315
|
+
private wellbeingBreakIdleCode?: Entity;
|
|
316
|
+
|
|
317
|
+
/** Registration generation that owns the wellness idle-code cache and in-flight lookups. */
|
|
318
|
+
private wellnessRegistrationGeneration = 0;
|
|
319
|
+
|
|
320
|
+
private updateWellnessSession(agentSessionId?: string): void {
|
|
321
|
+
this.currentAgentSessionId = agentSessionId;
|
|
322
|
+
}
|
|
323
|
+
|
|
267
324
|
/**
|
|
268
325
|
* API instance for managing Webex Contact Center entry points
|
|
269
326
|
* Provides functionality to fetch entry points with caching support
|
|
@@ -405,7 +462,14 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
405
462
|
});
|
|
406
463
|
|
|
407
464
|
this.webCallingService = new WebCallingService(this.$webex);
|
|
408
|
-
this.
|
|
465
|
+
this.answerCallOnWebexService = new AnswerCallOnWebexService(this.$webex);
|
|
466
|
+
this.webexCrossClientService = new WebexCrossClientService(this.$webex);
|
|
467
|
+
this.wxAppTelephonyMercurySync = new WxAppTelephonyMercurySync(this.$webex);
|
|
468
|
+
this.apiAIAssistant = new ApiAIAssistant(this.$webex, () => ({
|
|
469
|
+
isWellnessBreakEnabled: this.agentConfig?.isWellnessBreakEnabled === true,
|
|
470
|
+
agentId: this.agentConfig?.agentId,
|
|
471
|
+
agentSessionId: this.currentAgentSessionId,
|
|
472
|
+
}));
|
|
409
473
|
this.metricsManager = MetricsManager.getInstance({webex: this.$webex});
|
|
410
474
|
this.taskManager = TaskManager.getTaskManager(
|
|
411
475
|
this.apiAIAssistant,
|
|
@@ -414,6 +478,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
414
478
|
this.services.webSocketManager,
|
|
415
479
|
this.services.rtdWebSocketManager
|
|
416
480
|
);
|
|
481
|
+
this.taskManager.setAnswerCallOnWebexService(this.answerCallOnWebexService);
|
|
417
482
|
this.incomingTaskListener();
|
|
418
483
|
|
|
419
484
|
// Initialize API instances
|
|
@@ -476,7 +541,126 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
476
541
|
this.trigger(TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, task);
|
|
477
542
|
};
|
|
478
543
|
|
|
544
|
+
private trackInvalidWellnessEvent(reason: string): void {
|
|
545
|
+
this.metricsManager.trackEvent(
|
|
546
|
+
METRIC_EVENT_NAMES.AI_ASSISTANT_WELLNESS_EVENT_INVALID,
|
|
547
|
+
{reason},
|
|
548
|
+
['operational']
|
|
549
|
+
);
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
private normalizeWellnessBreakEvent(payload: Record<string, unknown>): WellnessBreakEvent | null {
|
|
553
|
+
if (this.agentConfig?.isWellnessBreakEnabled !== true) {
|
|
554
|
+
this.trackInvalidWellnessEvent('wellness_disabled');
|
|
555
|
+
|
|
556
|
+
return null;
|
|
557
|
+
}
|
|
558
|
+
|
|
559
|
+
const notificationData = isRecord(payload.data) ? payload.data : null;
|
|
560
|
+
const notificationDetails =
|
|
561
|
+
notificationData && isRecord(notificationData.notifDetails)
|
|
562
|
+
? notificationData.notifDetails
|
|
563
|
+
: null;
|
|
564
|
+
const sessionData =
|
|
565
|
+
notificationData && isRecord(notificationData.data) ? notificationData.data : null;
|
|
566
|
+
const actionEvent = notificationDetails?.actionEvent;
|
|
567
|
+
|
|
568
|
+
if (
|
|
569
|
+
payload.type !== WELLNESS_BREAK_HANDLER ||
|
|
570
|
+
notificationData?.notifType !== WELLNESS_BREAK_HANDLER ||
|
|
571
|
+
typeof actionEvent !== 'string'
|
|
572
|
+
) {
|
|
573
|
+
this.trackInvalidWellnessEvent('malformed_wellness_event');
|
|
574
|
+
|
|
575
|
+
return null;
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
if (
|
|
579
|
+
!Object.values(WELLNESS_BREAK_NOTIFICATION_ACTIONS).includes(
|
|
580
|
+
actionEvent as WellnessBreakNotificationAction
|
|
581
|
+
)
|
|
582
|
+
) {
|
|
583
|
+
this.trackInvalidWellnessEvent('unknown_wellness_action');
|
|
584
|
+
|
|
585
|
+
return null;
|
|
586
|
+
}
|
|
587
|
+
|
|
588
|
+
const agentId = notificationData.agentId;
|
|
589
|
+
const eventOrgId = notificationData.orgId;
|
|
590
|
+
const sessionOrgId = sessionData?.orgId;
|
|
591
|
+
const envelopeOrgId = payload.orgId;
|
|
592
|
+
const agentSessionId = sessionData?.agentSessionId;
|
|
593
|
+
const currentOrgId = this.$webex.credentials.getOrgId();
|
|
594
|
+
|
|
595
|
+
if (
|
|
596
|
+
typeof agentId !== 'string' ||
|
|
597
|
+
typeof eventOrgId !== 'string' ||
|
|
598
|
+
typeof sessionOrgId !== 'string' ||
|
|
599
|
+
typeof envelopeOrgId !== 'string' ||
|
|
600
|
+
typeof agentSessionId !== 'string' ||
|
|
601
|
+
!agentId ||
|
|
602
|
+
!eventOrgId ||
|
|
603
|
+
!sessionOrgId ||
|
|
604
|
+
!envelopeOrgId ||
|
|
605
|
+
!agentSessionId
|
|
606
|
+
) {
|
|
607
|
+
this.trackInvalidWellnessEvent('missing_wellness_identity');
|
|
608
|
+
|
|
609
|
+
return null;
|
|
610
|
+
}
|
|
611
|
+
|
|
612
|
+
if (
|
|
613
|
+
agentId !== this.agentConfig?.agentId ||
|
|
614
|
+
eventOrgId !== currentOrgId ||
|
|
615
|
+
sessionOrgId !== currentOrgId ||
|
|
616
|
+
envelopeOrgId !== currentOrgId
|
|
617
|
+
) {
|
|
618
|
+
this.trackInvalidWellnessEvent('mismatched_wellness_identity');
|
|
619
|
+
|
|
620
|
+
return null;
|
|
621
|
+
}
|
|
622
|
+
|
|
623
|
+
const interactionValue = sessionData.interactionId ?? sessionData.InteractionId;
|
|
624
|
+
const actionText = notificationDetails.actionText;
|
|
625
|
+
const trackingId = payload.trackingId;
|
|
626
|
+
|
|
627
|
+
return {
|
|
628
|
+
agentId,
|
|
629
|
+
orgId: currentOrgId,
|
|
630
|
+
agentSessionId,
|
|
631
|
+
actionEvent: actionEvent as WellnessBreakNotificationAction,
|
|
632
|
+
...(typeof actionText === 'string' ? {actionText} : {}),
|
|
633
|
+
...(typeof interactionValue === 'string' ? {interactionId: interactionValue} : {}),
|
|
634
|
+
...(typeof trackingId === 'string' ? {trackingId} : {}),
|
|
635
|
+
};
|
|
636
|
+
}
|
|
637
|
+
|
|
638
|
+
private handleWellnessBreakWebsocketPayload(payload: Record<string, unknown>): boolean {
|
|
639
|
+
if (payload.type !== WELLNESS_BREAK_HANDLER) {
|
|
640
|
+
return false;
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
const wellnessEvent = this.normalizeWellnessBreakEvent(payload);
|
|
644
|
+
if (wellnessEvent) {
|
|
645
|
+
// @ts-ignore - WebexPlugin emit is available at runtime but absent from its declaration.
|
|
646
|
+
this.emit(CC_EVENTS.WELLNESS_BREAK, wellnessEvent);
|
|
647
|
+
}
|
|
648
|
+
|
|
649
|
+
return true;
|
|
650
|
+
}
|
|
651
|
+
|
|
479
652
|
private handleRTDWebsocketMessage = (event: string) => {
|
|
653
|
+
let payload: unknown;
|
|
654
|
+
try {
|
|
655
|
+
payload = JSON.parse(event);
|
|
656
|
+
} catch {
|
|
657
|
+
// TaskManager retains its existing malformed RTD message handling.
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
if (isRecord(payload) && this.handleWellnessBreakWebsocketPayload(payload)) {
|
|
661
|
+
return;
|
|
662
|
+
}
|
|
663
|
+
|
|
480
664
|
this.taskManager.handleRealtimeWebsocketEvent(event);
|
|
481
665
|
};
|
|
482
666
|
|
|
@@ -524,15 +708,17 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
524
708
|
*
|
|
525
709
|
* console.log('Agent ID:', profile.agentId);
|
|
526
710
|
* console.log('Default DN:', profile.defaultDn);
|
|
527
|
-
* console.log('Teams:', profile.teams.map(t => t.
|
|
711
|
+
* console.log('Teams:', profile.teams.map(t => t.id));
|
|
528
712
|
* console.log('WebRTC Enabled:', profile.webRtcEnabled);
|
|
529
713
|
* console.log('Supported Login Options:', profile.loginVoiceOptions);
|
|
530
714
|
*
|
|
531
715
|
* // Now you can proceed with station login, state changes, etc.
|
|
532
|
-
* await cc.stationLogin({ teamId: profile.teams[0].
|
|
716
|
+
* await cc.stationLogin({ teamId: profile.teams[0].id, loginOption: 'BROWSER' });
|
|
533
717
|
* ```
|
|
534
718
|
*/
|
|
535
719
|
public async register(): Promise<Profile> {
|
|
720
|
+
this.wellnessRegistrationGeneration += 1;
|
|
721
|
+
this.wellbeingBreakIdleCode = undefined;
|
|
536
722
|
LoggerProxy.log('Starting CC SDK registration', {
|
|
537
723
|
module: CC_FILE,
|
|
538
724
|
method: METHODS.REGISTER,
|
|
@@ -562,7 +748,12 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
562
748
|
method: METHODS.REGISTER,
|
|
563
749
|
});
|
|
564
750
|
|
|
565
|
-
|
|
751
|
+
// Registration can silently restore a station session without emitting a
|
|
752
|
+
// relogin event. Project the active session for consumers that must
|
|
753
|
+
// recover session-scoped state after a page refresh.
|
|
754
|
+
return resp.isAgentLoggedIn && this.currentAgentSessionId
|
|
755
|
+
? {...resp, agentSessionId: this.currentAgentSessionId}
|
|
756
|
+
: resp;
|
|
566
757
|
} catch (error) {
|
|
567
758
|
this.metricsManager.trackEvent(
|
|
568
759
|
METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_FAILED,
|
|
@@ -615,12 +806,16 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
615
806
|
|
|
616
807
|
*/
|
|
617
808
|
public async deregister(): Promise<void> {
|
|
809
|
+
this.wellnessRegistrationGeneration += 1;
|
|
810
|
+
this.wellbeingBreakIdleCode = undefined;
|
|
811
|
+
this.updateWellnessSession();
|
|
618
812
|
try {
|
|
619
813
|
this.metricsManager.timeEvent([
|
|
620
814
|
METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_SUCCESS,
|
|
621
815
|
METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_FAIL,
|
|
622
816
|
]);
|
|
623
817
|
|
|
818
|
+
this.taskManager.clearAISummaryState();
|
|
624
819
|
this.taskManager.off(TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
|
|
625
820
|
this.taskManager.off(TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
|
|
626
821
|
this.taskManager.off(TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this.handleTaskMultiLoginHydrate);
|
|
@@ -634,6 +829,10 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
634
829
|
this.services.rtdWebSocketManager.off('message', this.handleRTDWebsocketMessage);
|
|
635
830
|
this.services.connectionService.off('connectionLost', this.handleConnectionLost);
|
|
636
831
|
|
|
832
|
+
const {publishError: wxAppPublishError} = await this.teardownWxAppLocalState({
|
|
833
|
+
clearInitFlag: true,
|
|
834
|
+
});
|
|
835
|
+
|
|
637
836
|
if (
|
|
638
837
|
this.agentConfig.webRtcEnabled &&
|
|
639
838
|
this.agentConfig.loginVoiceOptions.includes(LoginOption.BROWSER)
|
|
@@ -663,7 +862,13 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
663
862
|
}
|
|
664
863
|
|
|
665
864
|
// Clear any cached agent configuration
|
|
865
|
+
this.wellbeingBreakIdleCode = undefined;
|
|
666
866
|
this.agentConfig = null;
|
|
867
|
+
this.updateWellnessSession();
|
|
868
|
+
|
|
869
|
+
if (wxAppPublishError) {
|
|
870
|
+
throw wxAppPublishError;
|
|
871
|
+
}
|
|
667
872
|
|
|
668
873
|
LoggerProxy.log('Deregistered successfully', {
|
|
669
874
|
module: CC_FILE,
|
|
@@ -727,6 +932,9 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
727
932
|
* ```
|
|
728
933
|
*/
|
|
729
934
|
public async getBuddyAgents(data: BuddyAgents): Promise<BuddyAgentsResponse> {
|
|
935
|
+
const {action, state, mediaType = 'telephony'} = data;
|
|
936
|
+
const buddyAgentState = state ?? (action === 'Transfer' ? AGENT_STATE_AVAILABLE : undefined);
|
|
937
|
+
|
|
730
938
|
LoggerProxy.info('Fetching buddy agents', {
|
|
731
939
|
module: CC_FILE,
|
|
732
940
|
method: METHODS.GET_BUDDY_AGENTS,
|
|
@@ -737,15 +945,19 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
737
945
|
METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_FAILED,
|
|
738
946
|
]);
|
|
739
947
|
const resp = await this.services.agent.buddyAgents({
|
|
740
|
-
data: {
|
|
948
|
+
data: {
|
|
949
|
+
agentProfileId: this.agentConfig.agentProfileID,
|
|
950
|
+
mediaType,
|
|
951
|
+
...(buddyAgentState ? {state: buddyAgentState} : {}),
|
|
952
|
+
},
|
|
741
953
|
});
|
|
742
954
|
|
|
743
955
|
this.metricsManager.trackEvent(
|
|
744
956
|
METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_SUCCESS,
|
|
745
957
|
{
|
|
746
958
|
...MetricsManager.getCommonTrackingFieldForAQMResponse(resp),
|
|
747
|
-
mediaType
|
|
748
|
-
buddyAgentState
|
|
959
|
+
mediaType,
|
|
960
|
+
buddyAgentState,
|
|
749
961
|
buddyAgentCount: resp.data.agentList.length,
|
|
750
962
|
},
|
|
751
963
|
['operational']
|
|
@@ -765,8 +977,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
765
977
|
METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_FAILED,
|
|
766
978
|
{
|
|
767
979
|
...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(failureResp),
|
|
768
|
-
mediaType
|
|
769
|
-
buddyAgentState
|
|
980
|
+
mediaType,
|
|
981
|
+
buddyAgentState,
|
|
770
982
|
},
|
|
771
983
|
['operational']
|
|
772
984
|
);
|
|
@@ -808,21 +1020,36 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
808
1020
|
webRtcEnabled: this.agentConfig.webRtcEnabled,
|
|
809
1021
|
autoWrapup: this.agentConfig.wrapUpData?.wrapUpProps?.autoWrapup ?? false,
|
|
810
1022
|
aiFeature: this.agentConfig.aiFeature,
|
|
1023
|
+
consultTransfer: {
|
|
1024
|
+
allowConsultToQueue: this.agentConfig.allowConsultToQueue,
|
|
1025
|
+
accessQueue: this.agentConfig.accessQueue,
|
|
1026
|
+
accessEntryPoint: this.agentConfig.accessEntryPoint,
|
|
1027
|
+
accessBuddyTeam: this.agentConfig.accessBuddyTeam,
|
|
1028
|
+
},
|
|
1029
|
+
enableWxBetterTogether: this.isWxBetterTogetherEnabled(),
|
|
1030
|
+
getWxAppUsersubPublished: () => this.webexCrossClientService.isAnswerCallsStateActive(),
|
|
811
1031
|
};
|
|
812
1032
|
this.taskManager.setConfigFlags(configFlags);
|
|
813
1033
|
// TODO: Make profile a singleton to make it available throughout app/sdk so we dont need to inject info everywhere
|
|
814
1034
|
this.taskManager.setWrapupData(this.agentConfig.wrapUpData);
|
|
815
1035
|
this.taskManager.setAgentId(this.agentConfig.agentId);
|
|
1036
|
+
this.taskManager.setAgentName(this.agentConfig.agentName);
|
|
816
1037
|
this.taskManager.setWebRtcEnabled(this.agentConfig.webRtcEnabled);
|
|
817
1038
|
this.apiAIAssistant.setAIFeatureFlags(this.agentConfig.aiFeature);
|
|
1039
|
+
this.wellbeingBreakIdleCode = undefined;
|
|
1040
|
+
this.updateWellnessSession();
|
|
818
1041
|
|
|
819
1042
|
/**
|
|
820
1043
|
* RTD websocket currently supports realtime transcripts and suggested responses.
|
|
821
1044
|
* Extend this condition when additional AI RTD features are introduced.
|
|
1045
|
+
* Wellness break notifications also arrive on this websocket.
|
|
822
1046
|
*/
|
|
823
1047
|
if (
|
|
824
1048
|
this.agentConfig.aiFeature?.realtimeTranscripts?.enable ||
|
|
825
|
-
this.agentConfig.aiFeature?.suggestedResponses?.enable
|
|
1049
|
+
this.agentConfig.aiFeature?.suggestedResponses?.enable ||
|
|
1050
|
+
this.agentConfig.aiFeature?.generatedSummaries?.wrapUpSummariesEnabled === true ||
|
|
1051
|
+
this.agentConfig.aiFeature?.generatedSummaries?.consultTransferSummariesEnabled === true ||
|
|
1052
|
+
this.agentConfig.isWellnessBreakEnabled
|
|
826
1053
|
) {
|
|
827
1054
|
LoggerProxy.info('Connecting to RTD websocket', {
|
|
828
1055
|
module: CC_FILE,
|
|
@@ -887,6 +1114,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
887
1114
|
|
|
888
1115
|
return this.agentConfig;
|
|
889
1116
|
} catch (error) {
|
|
1117
|
+
this.updateWellnessSession();
|
|
890
1118
|
LoggerProxy.error(`Error during register: ${error}`, {
|
|
891
1119
|
module: CC_FILE,
|
|
892
1120
|
method: METHODS.CONNECT_WEBSOCKET,
|
|
@@ -958,14 +1186,15 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
958
1186
|
}
|
|
959
1187
|
}
|
|
960
1188
|
|
|
1189
|
+
const deviceId = this.getDeviceId(data.loginOption, data.dialNumber);
|
|
961
1190
|
const loginResponse = await this.services.agent.stationLogin({
|
|
962
1191
|
data: {
|
|
963
|
-
|
|
964
|
-
|
|
1192
|
+
// BROWSER DN must be webrtc-{agentId} so VPOP/RTMS do not treat a bare UUID as PSTN.
|
|
1193
|
+
dialNumber: data.loginOption === LoginOption.BROWSER ? deviceId : data.dialNumber,
|
|
965
1194
|
teamId: data.teamId,
|
|
966
1195
|
deviceType: data.loginOption,
|
|
967
1196
|
isExtension: data.loginOption === LoginOption.EXTENSION,
|
|
968
|
-
deviceId
|
|
1197
|
+
deviceId,
|
|
969
1198
|
roles: [AGENT],
|
|
970
1199
|
teamName: EMPTY_STRING,
|
|
971
1200
|
siteId: EMPTY_STRING,
|
|
@@ -996,6 +1225,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
996
1225
|
|
|
997
1226
|
const resp = await loginResponse;
|
|
998
1227
|
const {channelsMap, ...loginData} = resp.data;
|
|
1228
|
+
this.updateWellnessSession(resp.data.agentSessionId);
|
|
999
1229
|
this.agentConfig.currentTeamId = resp.data.teamId;
|
|
1000
1230
|
const response = {
|
|
1001
1231
|
...loginData,
|
|
@@ -1009,6 +1239,16 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1009
1239
|
};
|
|
1010
1240
|
|
|
1011
1241
|
this.webCallingService.setLoginOption(data.loginOption);
|
|
1242
|
+
if (this.agentConfig) {
|
|
1243
|
+
this.agentConfig.deviceType = data.loginOption;
|
|
1244
|
+
if (
|
|
1245
|
+
data.loginOption === LoginOption.AGENT_DN ||
|
|
1246
|
+
data.loginOption === LoginOption.EXTENSION
|
|
1247
|
+
) {
|
|
1248
|
+
this.agentConfig.defaultDn = data.dialNumber;
|
|
1249
|
+
this.agentConfig.dn = data.dialNumber;
|
|
1250
|
+
}
|
|
1251
|
+
}
|
|
1012
1252
|
this.metricsManager.trackEvent(
|
|
1013
1253
|
METRIC_EVENT_NAMES.STATION_LOGIN_SUCCESS,
|
|
1014
1254
|
{
|
|
@@ -1030,6 +1270,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1030
1270
|
}
|
|
1031
1271
|
);
|
|
1032
1272
|
|
|
1273
|
+
await this.ensureWxAppPostStationLogin();
|
|
1274
|
+
|
|
1033
1275
|
return response;
|
|
1034
1276
|
} catch (error) {
|
|
1035
1277
|
const failure = error.details as Failure;
|
|
@@ -1098,6 +1340,9 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1098
1340
|
this.webCallingService.deregisterWebCallingLine();
|
|
1099
1341
|
}
|
|
1100
1342
|
|
|
1343
|
+
await this.teardownWxAppLocalState();
|
|
1344
|
+
this.updateWellnessSession();
|
|
1345
|
+
|
|
1101
1346
|
LoggerProxy.log(`Agent station logout completed successfully`, {
|
|
1102
1347
|
module: CC_FILE,
|
|
1103
1348
|
method: METHODS.STATION_LOGOUT,
|
|
@@ -1198,7 +1443,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1198
1443
|
{
|
|
1199
1444
|
...MetricsManager.getCommonTrackingFieldForAQMResponse(agentStatusResponse),
|
|
1200
1445
|
requestedState: data.state,
|
|
1201
|
-
teamId: this.agentConfig?.teams[0]?.
|
|
1446
|
+
teamId: this.agentConfig?.teams[0]?.id ?? EMPTY_STRING,
|
|
1202
1447
|
status: agentStatusResponse.data?.status,
|
|
1203
1448
|
subStatus: agentStatusResponse.data?.subStatus,
|
|
1204
1449
|
auxCodeId: data.auxCodeId,
|
|
@@ -1234,6 +1479,77 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1234
1479
|
}
|
|
1235
1480
|
}
|
|
1236
1481
|
|
|
1482
|
+
/**
|
|
1483
|
+
* Returns the system-managed `WellbeingBreak` idle code for the current registration.
|
|
1484
|
+
* The value is fetched outside Desktop Profile filtering and cached until deregistration.
|
|
1485
|
+
* @returns The normalized system idle-code entity
|
|
1486
|
+
* @throws Structured Contact Center error when wellness is disabled or the code is unavailable
|
|
1487
|
+
* @example
|
|
1488
|
+
* const idleCode = await webex.cc.getWellbeingBreakIdleCode();
|
|
1489
|
+
* @public
|
|
1490
|
+
*/
|
|
1491
|
+
public async getWellbeingBreakIdleCode(): Promise<Entity> {
|
|
1492
|
+
const method = METHODS.GET_WELLBEING_BREAK_IDLE_CODE;
|
|
1493
|
+
try {
|
|
1494
|
+
if (!this.agentConfig?.isWellnessBreakEnabled) {
|
|
1495
|
+
const validationError = new Error('WELLNESS_BREAK_NOT_ENABLED') as GenericError;
|
|
1496
|
+
validationError.details = {
|
|
1497
|
+
type: 'SDK_VALIDATION_ERROR',
|
|
1498
|
+
orgId: this.$webex.credentials.getOrgId(),
|
|
1499
|
+
trackingId: EMPTY_STRING,
|
|
1500
|
+
data: {reason: 'WELLNESS_BREAK_NOT_ENABLED'},
|
|
1501
|
+
};
|
|
1502
|
+
throw validationError;
|
|
1503
|
+
}
|
|
1504
|
+
|
|
1505
|
+
if (this.wellbeingBreakIdleCode) {
|
|
1506
|
+
return this.wellbeingBreakIdleCode;
|
|
1507
|
+
}
|
|
1508
|
+
|
|
1509
|
+
this.metricsManager.timeEvent([
|
|
1510
|
+
METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS,
|
|
1511
|
+
METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED,
|
|
1512
|
+
]);
|
|
1513
|
+
const registrationGeneration = this.wellnessRegistrationGeneration;
|
|
1514
|
+
const orgId = this.$webex.credentials.getOrgId();
|
|
1515
|
+
const idleCode = await this.services.config.getWellbeingBreakIdleCode(orgId);
|
|
1516
|
+
|
|
1517
|
+
if (
|
|
1518
|
+
registrationGeneration !== this.wellnessRegistrationGeneration ||
|
|
1519
|
+
orgId !== this.$webex.credentials.getOrgId() ||
|
|
1520
|
+
!this.agentConfig?.isWellnessBreakEnabled
|
|
1521
|
+
) {
|
|
1522
|
+
const staleRegistrationError = new Error(
|
|
1523
|
+
'WELLNESS_BREAK_REGISTRATION_CHANGED'
|
|
1524
|
+
) as GenericError;
|
|
1525
|
+
staleRegistrationError.details = {
|
|
1526
|
+
type: 'SDK_VALIDATION_ERROR',
|
|
1527
|
+
orgId,
|
|
1528
|
+
trackingId: EMPTY_STRING,
|
|
1529
|
+
data: {reason: 'WELLNESS_BREAK_REGISTRATION_CHANGED'},
|
|
1530
|
+
};
|
|
1531
|
+
throw staleRegistrationError;
|
|
1532
|
+
}
|
|
1533
|
+
|
|
1534
|
+
this.wellbeingBreakIdleCode = idleCode;
|
|
1535
|
+
this.metricsManager.trackEvent(
|
|
1536
|
+
METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS,
|
|
1537
|
+
{},
|
|
1538
|
+
['operational']
|
|
1539
|
+
);
|
|
1540
|
+
|
|
1541
|
+
return idleCode;
|
|
1542
|
+
} catch (error) {
|
|
1543
|
+
this.metricsManager.trackEvent(
|
|
1544
|
+
METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED,
|
|
1545
|
+
{reason: error instanceof Error ? error.message : UNKNOWN_ERROR},
|
|
1546
|
+
['operational']
|
|
1547
|
+
);
|
|
1548
|
+
const {error: detailedError} = getErrorDetails(error, method, CC_FILE);
|
|
1549
|
+
throw detailedError;
|
|
1550
|
+
}
|
|
1551
|
+
}
|
|
1552
|
+
|
|
1237
1553
|
/**
|
|
1238
1554
|
* Processes incoming websocket messages and emits corresponding events
|
|
1239
1555
|
* Handles various event types including agent state changes, login events,
|
|
@@ -1243,8 +1559,14 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1243
1559
|
*/
|
|
1244
1560
|
private handleWebsocketMessage = (event: string) => {
|
|
1245
1561
|
const eventData = JSON.parse(event);
|
|
1246
|
-
// Re-emit all the events related to agent except keep-alives
|
|
1247
|
-
|
|
1562
|
+
// Re-emit all the events related to agent except keep-alives. Only event names present in
|
|
1563
|
+
// the typed CC_EVENTS allow-list are emitted; unknown/server-injected types are ignored.
|
|
1564
|
+
if (
|
|
1565
|
+
!eventData.keepalive &&
|
|
1566
|
+
eventData.data &&
|
|
1567
|
+
eventData.data.type &&
|
|
1568
|
+
CC_EVENT_ALLOW_LIST.has(eventData.data.type)
|
|
1569
|
+
) {
|
|
1248
1570
|
// @ts-ignore
|
|
1249
1571
|
this.emit(eventData.data.type, eventData.data);
|
|
1250
1572
|
}
|
|
@@ -1272,8 +1594,19 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1272
1594
|
]);
|
|
1273
1595
|
}
|
|
1274
1596
|
|
|
1597
|
+
if (this.handleWellnessBreakWebsocketPayload(eventData)) {
|
|
1598
|
+
return;
|
|
1599
|
+
}
|
|
1600
|
+
|
|
1275
1601
|
switch (eventData.type) {
|
|
1276
1602
|
case CC_EVENTS.AGENT_MULTI_LOGIN:
|
|
1603
|
+
if (
|
|
1604
|
+
eventData.data?.type === 'AgentMultiLoginCloseSession' &&
|
|
1605
|
+
(!eventData.data.agentSessionId ||
|
|
1606
|
+
eventData.data.agentSessionId === this.currentAgentSessionId)
|
|
1607
|
+
) {
|
|
1608
|
+
this.updateWellnessSession();
|
|
1609
|
+
}
|
|
1277
1610
|
// @ts-ignore
|
|
1278
1611
|
this.emit(AGENT_EVENTS.AGENT_MULTI_LOGIN, eventData.data);
|
|
1279
1612
|
break;
|
|
@@ -1292,6 +1625,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1292
1625
|
switch (eventData.data.type) {
|
|
1293
1626
|
case CC_EVENTS.AGENT_STATION_LOGIN_SUCCESS: {
|
|
1294
1627
|
const {channelsMap, ...loginData} = eventData.data;
|
|
1628
|
+
this.updateWellnessSession(loginData.agentSessionId);
|
|
1295
1629
|
const stationLoginData = {
|
|
1296
1630
|
...loginData,
|
|
1297
1631
|
mmProfile: {
|
|
@@ -1307,23 +1641,23 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1307
1641
|
this.emit(AGENT_EVENTS.AGENT_STATION_LOGIN_SUCCESS, stationLoginData);
|
|
1308
1642
|
break;
|
|
1309
1643
|
}
|
|
1310
|
-
case CC_EVENTS.AGENT_RELOGIN_SUCCESS:
|
|
1311
|
-
{
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
}
|
|
1644
|
+
case CC_EVENTS.AGENT_RELOGIN_SUCCESS: {
|
|
1645
|
+
const {channelsMap, ...loginData} = eventData.data;
|
|
1646
|
+
this.updateWellnessSession(loginData.agentSessionId);
|
|
1647
|
+
const stationReLoginData = {
|
|
1648
|
+
...loginData,
|
|
1649
|
+
mmProfile: {
|
|
1650
|
+
chat: channelsMap.chat?.length,
|
|
1651
|
+
email: channelsMap.email?.length,
|
|
1652
|
+
social: channelsMap.social?.length,
|
|
1653
|
+
telephony: channelsMap.telephony?.length,
|
|
1654
|
+
},
|
|
1655
|
+
notifsTrackingId: eventData.trackingId,
|
|
1656
|
+
};
|
|
1657
|
+
// @ts-ignore
|
|
1658
|
+
this.emit(AGENT_EVENTS.AGENT_RELOGIN_SUCCESS, stationReLoginData);
|
|
1326
1659
|
break;
|
|
1660
|
+
}
|
|
1327
1661
|
case CC_EVENTS.AGENT_STATE_CHANGE_SUCCESS:
|
|
1328
1662
|
// @ts-ignore
|
|
1329
1663
|
this.emit(AGENT_EVENTS.AGENT_STATE_CHANGE_SUCCESS, eventData.data);
|
|
@@ -1337,6 +1671,12 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1337
1671
|
this.emit(AGENT_EVENTS.AGENT_STATION_LOGIN_FAILED, eventData.data);
|
|
1338
1672
|
break;
|
|
1339
1673
|
case CC_EVENTS.AGENT_LOGOUT_SUCCESS:
|
|
1674
|
+
if (
|
|
1675
|
+
!eventData.data.agentSessionId ||
|
|
1676
|
+
eventData.data.agentSessionId === this.currentAgentSessionId
|
|
1677
|
+
) {
|
|
1678
|
+
this.updateWellnessSession();
|
|
1679
|
+
}
|
|
1340
1680
|
// @ts-ignore
|
|
1341
1681
|
this.emit(AGENT_EVENTS.AGENT_LOGOUT_SUCCESS, eventData.data);
|
|
1342
1682
|
break;
|
|
@@ -1377,6 +1717,593 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1377
1717
|
}
|
|
1378
1718
|
}
|
|
1379
1719
|
|
|
1720
|
+
/**
|
|
1721
|
+
* Whether wxApp thick-client answer is enabled for this SDK instance.
|
|
1722
|
+
* @public
|
|
1723
|
+
*/
|
|
1724
|
+
public isWxBetterTogetherEnabled(): boolean {
|
|
1725
|
+
return this.$config?.enableWxBetterTogether === true;
|
|
1726
|
+
}
|
|
1727
|
+
|
|
1728
|
+
/**
|
|
1729
|
+
* Current station login option (Extension, Dial Number, or Browser/Desktop).
|
|
1730
|
+
* Prefer webCallingService — updated on every stationLogin before wxApp hooks run.
|
|
1731
|
+
* @private
|
|
1732
|
+
*/
|
|
1733
|
+
private getCurrentStationLoginOption(): LoginOption | undefined {
|
|
1734
|
+
return this.webCallingService?.loginOption ?? this.agentConfig?.deviceType;
|
|
1735
|
+
}
|
|
1736
|
+
|
|
1737
|
+
/**
|
|
1738
|
+
* wxApp thick-client answer is supported for Extension and Dial Number station login only —
|
|
1739
|
+
* not Browser/Desktop (WebRTC) login.
|
|
1740
|
+
* @private
|
|
1741
|
+
*/
|
|
1742
|
+
private assertWxAppStationLoginSupportedForEnable(): void {
|
|
1743
|
+
const loginOption = this.getCurrentStationLoginOption();
|
|
1744
|
+
if (loginOption !== LoginOption.EXTENSION && loginOption !== LoginOption.AGENT_DN) {
|
|
1745
|
+
throw new Error(
|
|
1746
|
+
'setManageWebexCallingInWxcc requires EXTENSION or AGENT_DN station login. Complete station login before enabling.'
|
|
1747
|
+
);
|
|
1748
|
+
}
|
|
1749
|
+
}
|
|
1750
|
+
|
|
1751
|
+
/**
|
|
1752
|
+
* Clears runtime wxApp config after logout/deregister so stale flags do not apply on relogin.
|
|
1753
|
+
* @private
|
|
1754
|
+
*/
|
|
1755
|
+
private resetEnableWxBetterTogetherConfig(): void {
|
|
1756
|
+
if (this.$config) {
|
|
1757
|
+
this.$config.enableWxBetterTogether = false;
|
|
1758
|
+
}
|
|
1759
|
+
this.taskManager.applyEnableWxBetterTogether(false);
|
|
1760
|
+
}
|
|
1761
|
+
|
|
1762
|
+
/**
|
|
1763
|
+
* Runtime enable/disable for wxApp Better Together (toast suppression + Mercury mute sync).
|
|
1764
|
+
*
|
|
1765
|
+
* **Phase 1 (WXCC-6026 / MMT): NOT part of the public host contract.**
|
|
1766
|
+
* Hosts must set `webexConfig.cc.enableWxBetterTogether` before `webex.init()` / `cc.register()`.
|
|
1767
|
+
* To change the flag after the SDK is initialized, re-init the SDK with the updated config.
|
|
1768
|
+
*
|
|
1769
|
+
* **Supported public read API:** {@link isWxBetterTogetherEnabled}.
|
|
1770
|
+
* **Supported telephony API:** unified `task.accept()`, `task.decline()`, `task.toggleMute()`,
|
|
1771
|
+
* `task.transmitDtmf()` — SDK routes wxApp calls internally when the init flag is active.
|
|
1772
|
+
*
|
|
1773
|
+
* **Production lifecycle does not call this method.** Station login, silent relogin, logout,
|
|
1774
|
+
* and deregister use {@link ensureWxAppPostStationLogin} and {@link teardownWxAppLocalState}
|
|
1775
|
+
* (usersub publish + Mercury subscribe/unsubscribe based on the init flag).
|
|
1776
|
+
*
|
|
1777
|
+
* This setter remains as a **private implementation** for Phase 2 runtime toggle and unit tests.
|
|
1778
|
+
* It updates `$config.enableWxBetterTogether`, TaskManager flags, cross-client usersub
|
|
1779
|
+
* (`answer-calls-on-wxcc`), and Mercury mute sync; rolls back config on publish/connect failure.
|
|
1780
|
+
*
|
|
1781
|
+
* @param enabled - `true` to enable wxApp answer + usersub suppression; `false` to disable and tear down.
|
|
1782
|
+
* @throws When enabling without login, on unsupported BROWSER station login, or when usersub/Mercury init fails.
|
|
1783
|
+
* @internal
|
|
1784
|
+
* @see enableWxBetterTogether (CCPluginConfig init flag)
|
|
1785
|
+
* @see ensureWxAppPostStationLogin
|
|
1786
|
+
* @see teardownWxAppLocalState
|
|
1787
|
+
*/
|
|
1788
|
+
private async setManageWebexCallingInWxcc(enabled: boolean): Promise<void> {
|
|
1789
|
+
if (enabled && !this.$webex.internal.device?.userId) {
|
|
1790
|
+
throw new Error('Cannot publish answer-calls-on-wxcc: user is not logged in');
|
|
1791
|
+
}
|
|
1792
|
+
|
|
1793
|
+
if (enabled) {
|
|
1794
|
+
this.assertWxAppStationLoginSupportedForEnable();
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1797
|
+
const previousEnabled = this.isWxBetterTogetherEnabled();
|
|
1798
|
+
|
|
1799
|
+
if (this.$config) {
|
|
1800
|
+
this.$config.enableWxBetterTogether = enabled;
|
|
1801
|
+
}
|
|
1802
|
+
|
|
1803
|
+
this.taskManager.applyEnableWxBetterTogether(enabled);
|
|
1804
|
+
|
|
1805
|
+
let publishedEnable = false;
|
|
1806
|
+
|
|
1807
|
+
try {
|
|
1808
|
+
if (enabled) {
|
|
1809
|
+
await this.ensureWxAppMercuryAndSubscribe();
|
|
1810
|
+
await this.publishAnswerOnWebexCrossClientState(true);
|
|
1811
|
+
publishedEnable = true;
|
|
1812
|
+
this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
|
|
1813
|
+
this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
|
|
1814
|
+
} else {
|
|
1815
|
+
await this.publishAnswerOnWebexCrossClientState(false);
|
|
1816
|
+
this.wxAppTelephonyMercurySync.unsubscribe();
|
|
1817
|
+
await this.releaseWxAppMercuryResources();
|
|
1818
|
+
}
|
|
1819
|
+
} catch (error) {
|
|
1820
|
+
if (publishedEnable) {
|
|
1821
|
+
await this.revertWxAppCrossClientPublish();
|
|
1822
|
+
} else if (enabled) {
|
|
1823
|
+
this.wxAppTelephonyMercurySync.unsubscribe();
|
|
1824
|
+
await this.releaseWxAppMercuryResources();
|
|
1825
|
+
}
|
|
1826
|
+
|
|
1827
|
+
if (this.$config) {
|
|
1828
|
+
this.$config.enableWxBetterTogether = previousEnabled;
|
|
1829
|
+
}
|
|
1830
|
+
this.taskManager.applyEnableWxBetterTogether(previousEnabled);
|
|
1831
|
+
throw error;
|
|
1832
|
+
}
|
|
1833
|
+
}
|
|
1834
|
+
|
|
1835
|
+
private getWxAppTelephonyTaskType(): 'Voice' | 'WebRTC' | 'unknown' {
|
|
1836
|
+
const loginOption = this.getCurrentStationLoginOption();
|
|
1837
|
+
|
|
1838
|
+
if (loginOption === LoginOption.BROWSER) {
|
|
1839
|
+
return 'WebRTC';
|
|
1840
|
+
}
|
|
1841
|
+
|
|
1842
|
+
if (loginOption === LoginOption.EXTENSION || loginOption === LoginOption.AGENT_DN) {
|
|
1843
|
+
return 'Voice';
|
|
1844
|
+
}
|
|
1845
|
+
|
|
1846
|
+
return 'unknown';
|
|
1847
|
+
}
|
|
1848
|
+
|
|
1849
|
+
private async ensureWxAppPostStationLogin(): Promise<void> {
|
|
1850
|
+
const loginOption = this.getCurrentStationLoginOption();
|
|
1851
|
+
const flagEnabled = this.isWxBetterTogetherEnabled();
|
|
1852
|
+
const telephonyTaskType = this.getWxAppTelephonyTaskType();
|
|
1853
|
+
|
|
1854
|
+
if (loginOption === LoginOption.BROWSER) {
|
|
1855
|
+
if (flagEnabled) {
|
|
1856
|
+
logWxAppSessionReadiness({
|
|
1857
|
+
enableWxBetterTogether: true,
|
|
1858
|
+
loginOption,
|
|
1859
|
+
wxAppHooksApplied: false,
|
|
1860
|
+
usersubPublished: false,
|
|
1861
|
+
mercurySubscribed: false,
|
|
1862
|
+
telephonyTaskType,
|
|
1863
|
+
skipReason: 'unsupported_browser_login',
|
|
1864
|
+
});
|
|
1865
|
+
|
|
1866
|
+
this.metricsManager.trackEvent(
|
|
1867
|
+
METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED,
|
|
1868
|
+
{
|
|
1869
|
+
loginOption,
|
|
1870
|
+
enableWxBetterTogether: true,
|
|
1871
|
+
skipReason: 'unsupported_browser_login',
|
|
1872
|
+
},
|
|
1873
|
+
['operational', 'behavioral']
|
|
1874
|
+
);
|
|
1875
|
+
}
|
|
1876
|
+
|
|
1877
|
+
return;
|
|
1878
|
+
}
|
|
1879
|
+
|
|
1880
|
+
let publishedEnable = false;
|
|
1881
|
+
let wxAppInitStage: 'mercury' | 'publish' = 'mercury';
|
|
1882
|
+
|
|
1883
|
+
try {
|
|
1884
|
+
if (flagEnabled) {
|
|
1885
|
+
this.metricsManager.timeEvent([
|
|
1886
|
+
METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS,
|
|
1887
|
+
METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED,
|
|
1888
|
+
]);
|
|
1889
|
+
|
|
1890
|
+
await this.ensureWxAppMercuryAndSubscribe();
|
|
1891
|
+
wxAppInitStage = 'publish';
|
|
1892
|
+
await this.publishAnswerOnWebexCrossClientState(true);
|
|
1893
|
+
publishedEnable = true;
|
|
1894
|
+
this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
|
|
1895
|
+
this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
|
|
1896
|
+
|
|
1897
|
+
const mercurySubscribed = this.wxAppTelephonyMercurySync.isSubscribed();
|
|
1898
|
+
const usersubPublished = this.webexCrossClientService.isAnswerCallsStateActive();
|
|
1899
|
+
|
|
1900
|
+
logWxAppSessionReadiness({
|
|
1901
|
+
enableWxBetterTogether: true,
|
|
1902
|
+
loginOption,
|
|
1903
|
+
wxAppHooksApplied: true,
|
|
1904
|
+
usersubPublished,
|
|
1905
|
+
mercurySubscribed,
|
|
1906
|
+
telephonyTaskType,
|
|
1907
|
+
});
|
|
1908
|
+
|
|
1909
|
+
const sessionInitReady = mercurySubscribed && usersubPublished;
|
|
1910
|
+
|
|
1911
|
+
if (sessionInitReady) {
|
|
1912
|
+
this.metricsManager.trackEvent(
|
|
1913
|
+
METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS,
|
|
1914
|
+
{
|
|
1915
|
+
loginOption,
|
|
1916
|
+
enableWxBetterTogether: true,
|
|
1917
|
+
usersubPublished,
|
|
1918
|
+
mercurySubscribed,
|
|
1919
|
+
telephonyTaskType,
|
|
1920
|
+
},
|
|
1921
|
+
['operational', 'behavioral']
|
|
1922
|
+
);
|
|
1923
|
+
} else {
|
|
1924
|
+
this.metricsManager.trackEvent(
|
|
1925
|
+
METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED,
|
|
1926
|
+
{
|
|
1927
|
+
loginOption,
|
|
1928
|
+
enableWxBetterTogether: true,
|
|
1929
|
+
usersubPublished,
|
|
1930
|
+
mercurySubscribed,
|
|
1931
|
+
telephonyTaskType,
|
|
1932
|
+
skipReason: !usersubPublished ? 'usersub_not_published' : 'mercury_not_subscribed',
|
|
1933
|
+
},
|
|
1934
|
+
['operational', 'behavioral']
|
|
1935
|
+
);
|
|
1936
|
+
}
|
|
1937
|
+
} else {
|
|
1938
|
+
await this.ensureWxAppDeviceRegistered();
|
|
1939
|
+
await this.publishAnswerOnWebexCrossClientState(false, {force: true});
|
|
1940
|
+
this.webexCrossClientService.teardown();
|
|
1941
|
+
this.wxAppTelephonyMercurySync.unsubscribe();
|
|
1942
|
+
await this.releaseWxAppMercuryResources();
|
|
1943
|
+
|
|
1944
|
+
logWxAppSessionReadiness({
|
|
1945
|
+
enableWxBetterTogether: false,
|
|
1946
|
+
loginOption,
|
|
1947
|
+
wxAppHooksApplied: true,
|
|
1948
|
+
usersubPublished: false,
|
|
1949
|
+
mercurySubscribed: false,
|
|
1950
|
+
telephonyTaskType,
|
|
1951
|
+
skipReason: 'flag_disabled',
|
|
1952
|
+
});
|
|
1953
|
+
|
|
1954
|
+
this.metricsManager.trackEvent(
|
|
1955
|
+
METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED,
|
|
1956
|
+
{loginOption, enableWxBetterTogether: false, skipReason: 'flag_disabled'},
|
|
1957
|
+
['operational', 'behavioral']
|
|
1958
|
+
);
|
|
1959
|
+
}
|
|
1960
|
+
} catch (error) {
|
|
1961
|
+
LoggerProxy.error(`Failed to initialize wxApp post-station-login: ${error}`, {
|
|
1962
|
+
module: CC_FILE,
|
|
1963
|
+
method: METHODS.STATION_LOGIN,
|
|
1964
|
+
});
|
|
1965
|
+
|
|
1966
|
+
if (flagEnabled) {
|
|
1967
|
+
const sessionInitFailureReason =
|
|
1968
|
+
wxAppInitStage === 'mercury' ? 'mercury_subscribe_failed' : 'publish_failed';
|
|
1969
|
+
|
|
1970
|
+
this.metricsManager.trackEvent(
|
|
1971
|
+
METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED,
|
|
1972
|
+
{
|
|
1973
|
+
loginOption,
|
|
1974
|
+
enableWxBetterTogether: true,
|
|
1975
|
+
usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
|
|
1976
|
+
mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
|
|
1977
|
+
telephonyTaskType,
|
|
1978
|
+
skipReason: sessionInitFailureReason,
|
|
1979
|
+
error: error instanceof Error ? error.toString() : String(error),
|
|
1980
|
+
},
|
|
1981
|
+
['operational', 'behavioral']
|
|
1982
|
+
);
|
|
1983
|
+
|
|
1984
|
+
logWxAppSessionReadiness({
|
|
1985
|
+
enableWxBetterTogether: true,
|
|
1986
|
+
loginOption,
|
|
1987
|
+
wxAppHooksApplied: false,
|
|
1988
|
+
usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
|
|
1989
|
+
mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
|
|
1990
|
+
telephonyTaskType,
|
|
1991
|
+
skipReason: sessionInitFailureReason,
|
|
1992
|
+
});
|
|
1993
|
+
|
|
1994
|
+
if (publishedEnable) {
|
|
1995
|
+
await this.revertWxAppCrossClientPublish();
|
|
1996
|
+
} else {
|
|
1997
|
+
this.wxAppTelephonyMercurySync.unsubscribe();
|
|
1998
|
+
await this.releaseWxAppMercuryResources();
|
|
1999
|
+
}
|
|
2000
|
+
this.resetEnableWxBetterTogetherConfig();
|
|
2001
|
+
} else {
|
|
2002
|
+
this.scheduleForcedFalsePublishRetry();
|
|
2003
|
+
}
|
|
2004
|
+
}
|
|
2005
|
+
}
|
|
2006
|
+
|
|
2007
|
+
private clearWxAppFalsePublishRetryTimer(): void {
|
|
2008
|
+
if (this.wxAppFalsePublishRetryTimer) {
|
|
2009
|
+
clearTimeout(this.wxAppFalsePublishRetryTimer);
|
|
2010
|
+
this.wxAppFalsePublishRetryTimer = undefined;
|
|
2011
|
+
}
|
|
2012
|
+
}
|
|
2013
|
+
|
|
2014
|
+
private scheduleForcedFalsePublishRetry(retryAttempt = 0): void {
|
|
2015
|
+
this.scheduleFalsePublishRetry(retryAttempt, {requireDisabled: true});
|
|
2016
|
+
}
|
|
2017
|
+
|
|
2018
|
+
/**
|
|
2019
|
+
* Retries compensating false publish after rollback failure, regardless of enabled flag.
|
|
2020
|
+
* @private
|
|
2021
|
+
*/
|
|
2022
|
+
private scheduleCompensatingFalsePublishRetry(retryAttempt = 0): void {
|
|
2023
|
+
this.scheduleFalsePublishRetry(retryAttempt);
|
|
2024
|
+
}
|
|
2025
|
+
|
|
2026
|
+
private scheduleFalsePublishRetry(
|
|
2027
|
+
retryAttempt = 0,
|
|
2028
|
+
options: {requireDisabled?: boolean} = {}
|
|
2029
|
+
): void {
|
|
2030
|
+
if (retryAttempt >= ContactCenter.WXAPP_FALSE_PUBLISH_MAX_RETRIES) {
|
|
2031
|
+
return;
|
|
2032
|
+
}
|
|
2033
|
+
|
|
2034
|
+
if (options?.requireDisabled && this.isWxBetterTogetherEnabled()) {
|
|
2035
|
+
return;
|
|
2036
|
+
}
|
|
2037
|
+
|
|
2038
|
+
this.clearWxAppFalsePublishRetryTimer();
|
|
2039
|
+
|
|
2040
|
+
this.wxAppFalsePublishRetryTimer = setTimeout(async () => {
|
|
2041
|
+
this.wxAppFalsePublishRetryTimer = undefined;
|
|
2042
|
+
|
|
2043
|
+
if (options?.requireDisabled && this.isWxBetterTogetherEnabled()) {
|
|
2044
|
+
return;
|
|
2045
|
+
}
|
|
2046
|
+
|
|
2047
|
+
if (
|
|
2048
|
+
!options?.requireDisabled &&
|
|
2049
|
+
this.isWxBetterTogetherEnabled() &&
|
|
2050
|
+
this.webexCrossClientService.isAnswerCallsStateActive()
|
|
2051
|
+
) {
|
|
2052
|
+
return;
|
|
2053
|
+
}
|
|
2054
|
+
|
|
2055
|
+
try {
|
|
2056
|
+
await this.ensureWxAppDeviceRegistered();
|
|
2057
|
+
await this.publishAnswerOnWebexCrossClientState(false, {force: true});
|
|
2058
|
+
this.webexCrossClientService.teardown();
|
|
2059
|
+
this.wxAppTelephonyMercurySync.unsubscribe();
|
|
2060
|
+
await this.releaseWxAppMercuryResources();
|
|
2061
|
+
} catch (retryError) {
|
|
2062
|
+
LoggerProxy.error(
|
|
2063
|
+
`Failed to retry forced answer-calls-on-wxcc false publish: ${retryError}`,
|
|
2064
|
+
{
|
|
2065
|
+
module: CC_FILE,
|
|
2066
|
+
method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
|
|
2067
|
+
}
|
|
2068
|
+
);
|
|
2069
|
+
this.scheduleFalsePublishRetry(retryAttempt + 1, options);
|
|
2070
|
+
}
|
|
2071
|
+
}, ContactCenter.WXAPP_FALSE_PUBLISH_RETRY_DELAY_MS);
|
|
2072
|
+
}
|
|
2073
|
+
|
|
2074
|
+
/**
|
|
2075
|
+
* Best-effort rollback when usersub true was published but wxApp setup did not complete.
|
|
2076
|
+
* @private
|
|
2077
|
+
*/
|
|
2078
|
+
private async revertWxAppCrossClientPublish(): Promise<void> {
|
|
2079
|
+
try {
|
|
2080
|
+
await this.publishAnswerOnWebexCrossClientState(false, {force: true});
|
|
2081
|
+
} catch (error) {
|
|
2082
|
+
LoggerProxy.error(
|
|
2083
|
+
`Failed to publish compensating answer-calls-on-wxcc false during wxApp rollback: ${error}`,
|
|
2084
|
+
{
|
|
2085
|
+
module: CC_FILE,
|
|
2086
|
+
method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
|
|
2087
|
+
}
|
|
2088
|
+
);
|
|
2089
|
+
this.scheduleCompensatingFalsePublishRetry();
|
|
2090
|
+
}
|
|
2091
|
+
|
|
2092
|
+
this.webexCrossClientService.teardown();
|
|
2093
|
+
this.wxAppTelephonyMercurySync.unsubscribe();
|
|
2094
|
+
await this.releaseWxAppMercuryResources();
|
|
2095
|
+
}
|
|
2096
|
+
|
|
2097
|
+
private async ensureWxAppDeviceRegistered(): Promise<void> {
|
|
2098
|
+
const device = this.$webex.internal.device;
|
|
2099
|
+
|
|
2100
|
+
if (device && !device.registered && device.register) {
|
|
2101
|
+
await device.register();
|
|
2102
|
+
this.wxAppDeviceRegisteredByCc = true;
|
|
2103
|
+
LoggerProxy.log('WxApp: device registered for cross-client publish', {
|
|
2104
|
+
module: CC_FILE,
|
|
2105
|
+
method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
|
|
2106
|
+
});
|
|
2107
|
+
}
|
|
2108
|
+
}
|
|
2109
|
+
|
|
2110
|
+
private async ensureWxAppMercuryConnected(): Promise<void> {
|
|
2111
|
+
const mercury = this.$webex.internal.mercury;
|
|
2112
|
+
|
|
2113
|
+
await this.ensureWxAppDeviceRegistered();
|
|
2114
|
+
|
|
2115
|
+
if (mercury && !mercury.connected) {
|
|
2116
|
+
await mercury.connect();
|
|
2117
|
+
this.wxAppMercuryConnectedByCc = true;
|
|
2118
|
+
LoggerProxy.log('WxApp mute sync: mercury connected', {
|
|
2119
|
+
module: CC_FILE,
|
|
2120
|
+
method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
|
|
2121
|
+
});
|
|
2122
|
+
}
|
|
2123
|
+
}
|
|
2124
|
+
|
|
2125
|
+
/**
|
|
2126
|
+
* Disconnects Mercury and unregisters the device when wxApp mute sync opened them.
|
|
2127
|
+
* @private
|
|
2128
|
+
*/
|
|
2129
|
+
private async releaseWxAppMercuryResources(): Promise<void> {
|
|
2130
|
+
const mercury = this.$webex.internal.mercury;
|
|
2131
|
+
const device = this.$webex.internal.device;
|
|
2132
|
+
|
|
2133
|
+
if (this.wxAppMercuryConnectedByCc && mercury?.connected) {
|
|
2134
|
+
try {
|
|
2135
|
+
await mercury.disconnect();
|
|
2136
|
+
this.wxAppMercuryConnectedByCc = false;
|
|
2137
|
+
LoggerProxy.log('WxApp mute sync: mercury disconnected', {
|
|
2138
|
+
module: CC_FILE,
|
|
2139
|
+
method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
|
|
2140
|
+
});
|
|
2141
|
+
} catch (error) {
|
|
2142
|
+
LoggerProxy.error(`Failed to disconnect wxApp Mercury: ${error}`, {
|
|
2143
|
+
module: CC_FILE,
|
|
2144
|
+
method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
|
|
2145
|
+
});
|
|
2146
|
+
}
|
|
2147
|
+
}
|
|
2148
|
+
|
|
2149
|
+
if (this.wxAppDeviceRegisteredByCc && device?.registered && device.unregister) {
|
|
2150
|
+
try {
|
|
2151
|
+
// @ts-ignore
|
|
2152
|
+
await device.unregister();
|
|
2153
|
+
this.wxAppDeviceRegisteredByCc = false;
|
|
2154
|
+
LoggerProxy.log('WxApp mute sync: device unregistered', {
|
|
2155
|
+
module: CC_FILE,
|
|
2156
|
+
method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
|
|
2157
|
+
});
|
|
2158
|
+
} catch (error) {
|
|
2159
|
+
LoggerProxy.error(`Failed to unregister wxApp device: ${error}`, {
|
|
2160
|
+
module: CC_FILE,
|
|
2161
|
+
method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
|
|
2162
|
+
});
|
|
2163
|
+
}
|
|
2164
|
+
} else if (this.wxAppDeviceRegisteredByCc) {
|
|
2165
|
+
this.wxAppDeviceRegisteredByCc = false;
|
|
2166
|
+
}
|
|
2167
|
+
}
|
|
2168
|
+
|
|
2169
|
+
/**
|
|
2170
|
+
* Clears wxApp runtime state and feature-owned resources. Publish failures are logged;
|
|
2171
|
+
* optional rethrow for deregister when callers need to surface usersub errors.
|
|
2172
|
+
* @private
|
|
2173
|
+
*/
|
|
2174
|
+
private async teardownWxAppLocalState(options?: {
|
|
2175
|
+
rethrowPublishError?: boolean;
|
|
2176
|
+
clearInitFlag?: boolean;
|
|
2177
|
+
}): Promise<{publishError?: unknown}> {
|
|
2178
|
+
this.clearWxAppFalsePublishRetryTimer();
|
|
2179
|
+
let publishError: unknown;
|
|
2180
|
+
|
|
2181
|
+
try {
|
|
2182
|
+
const shouldForceFalsePublish =
|
|
2183
|
+
this.isWxBetterTogetherEnabled() || this.webexCrossClientService.isAnswerCallsStateActive();
|
|
2184
|
+
|
|
2185
|
+
await this.publishAnswerOnWebexCrossClientState(false, {
|
|
2186
|
+
force: shouldForceFalsePublish,
|
|
2187
|
+
});
|
|
2188
|
+
} catch (error) {
|
|
2189
|
+
publishError = error;
|
|
2190
|
+
LoggerProxy.error(
|
|
2191
|
+
`Failed to publish answer-calls-on-wxcc false during wxApp teardown: ${error}`,
|
|
2192
|
+
{
|
|
2193
|
+
module: CC_FILE,
|
|
2194
|
+
method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
|
|
2195
|
+
}
|
|
2196
|
+
);
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2199
|
+
this.webexCrossClientService.teardown();
|
|
2200
|
+
this.wxAppTelephonyMercurySync.unsubscribe();
|
|
2201
|
+
await this.releaseWxAppMercuryResources();
|
|
2202
|
+
|
|
2203
|
+
if (options?.clearInitFlag) {
|
|
2204
|
+
this.resetEnableWxBetterTogetherConfig();
|
|
2205
|
+
}
|
|
2206
|
+
|
|
2207
|
+
if (publishError) {
|
|
2208
|
+
this.scheduleCompensatingFalsePublishRetry();
|
|
2209
|
+
}
|
|
2210
|
+
|
|
2211
|
+
if (options?.rethrowPublishError && publishError) {
|
|
2212
|
+
throw publishError;
|
|
2213
|
+
}
|
|
2214
|
+
|
|
2215
|
+
return {publishError: publishError ?? undefined};
|
|
2216
|
+
}
|
|
2217
|
+
|
|
2218
|
+
private async ensureWxAppMercuryAndSubscribe(): Promise<void> {
|
|
2219
|
+
if (!this.isWxBetterTogetherEnabled()) {
|
|
2220
|
+
return;
|
|
2221
|
+
}
|
|
2222
|
+
|
|
2223
|
+
if (this.getCurrentStationLoginOption() === LoginOption.BROWSER) {
|
|
2224
|
+
return;
|
|
2225
|
+
}
|
|
2226
|
+
|
|
2227
|
+
const agentId = this.agentConfig?.agentId;
|
|
2228
|
+
if (!agentId) {
|
|
2229
|
+
LoggerProxy.error('Cannot subscribe wxApp mute sync: agentId unavailable', {
|
|
2230
|
+
module: CC_FILE,
|
|
2231
|
+
method: METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY,
|
|
2232
|
+
});
|
|
2233
|
+
|
|
2234
|
+
this.metricsManager.trackEvent(
|
|
2235
|
+
METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED,
|
|
2236
|
+
{error: 'agentId unavailable', mercurySubscribed: false},
|
|
2237
|
+
['operational', 'behavioral']
|
|
2238
|
+
);
|
|
2239
|
+
|
|
2240
|
+
return;
|
|
2241
|
+
}
|
|
2242
|
+
|
|
2243
|
+
try {
|
|
2244
|
+
await this.ensureWxAppMercuryConnected();
|
|
2245
|
+
this.wxAppTelephonyMercurySync.subscribe(agentId, (callId, muted) => {
|
|
2246
|
+
this.taskManager.applyWxAppMuteStateFromSync(callId, muted);
|
|
2247
|
+
});
|
|
2248
|
+
} catch (error) {
|
|
2249
|
+
LoggerProxy.error(`Failed to ensure wxApp Mercury mute sync: ${error}`, {
|
|
2250
|
+
module: CC_FILE,
|
|
2251
|
+
method: METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY,
|
|
2252
|
+
});
|
|
2253
|
+
this.metricsManager.trackEvent(
|
|
2254
|
+
METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED,
|
|
2255
|
+
{
|
|
2256
|
+
error: error instanceof Error ? error.toString() : String(error),
|
|
2257
|
+
mercurySubscribed: false,
|
|
2258
|
+
},
|
|
2259
|
+
['operational', 'behavioral']
|
|
2260
|
+
);
|
|
2261
|
+
this.wxAppTelephonyMercurySync.unsubscribe();
|
|
2262
|
+
await this.releaseWxAppMercuryResources();
|
|
2263
|
+
throw error;
|
|
2264
|
+
}
|
|
2265
|
+
}
|
|
2266
|
+
|
|
2267
|
+
private async publishAnswerOnWebexCrossClientState(
|
|
2268
|
+
enable: boolean,
|
|
2269
|
+
options?: {force?: boolean}
|
|
2270
|
+
): Promise<void> {
|
|
2271
|
+
if (enable && !this.isWxBetterTogetherEnabled()) {
|
|
2272
|
+
return;
|
|
2273
|
+
}
|
|
2274
|
+
|
|
2275
|
+
if (!enable && !options?.force && !this.webexCrossClientService.isAnswerCallsStateActive()) {
|
|
2276
|
+
return;
|
|
2277
|
+
}
|
|
2278
|
+
|
|
2279
|
+
const userId = this.$webex.internal.device?.userId;
|
|
2280
|
+
if (!userId) {
|
|
2281
|
+
if (enable && this.isWxBetterTogetherEnabled()) {
|
|
2282
|
+
this.metricsManager.trackEvent(
|
|
2283
|
+
METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED,
|
|
2284
|
+
{
|
|
2285
|
+
enableWxBetterTogether: true,
|
|
2286
|
+
usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
|
|
2287
|
+
skipReason: 'user_id_unavailable',
|
|
2288
|
+
error: 'User ID is unavailable for cross-client publish',
|
|
2289
|
+
},
|
|
2290
|
+
['operational', 'behavioral']
|
|
2291
|
+
);
|
|
2292
|
+
}
|
|
2293
|
+
|
|
2294
|
+
return;
|
|
2295
|
+
}
|
|
2296
|
+
|
|
2297
|
+
await this.webexCrossClientService.setManageWebexCallingInWxcc(enable, {
|
|
2298
|
+
userId,
|
|
2299
|
+
trackPublishMetrics: true,
|
|
2300
|
+
});
|
|
2301
|
+
|
|
2302
|
+
if (enable) {
|
|
2303
|
+
this.clearWxAppFalsePublishRetryTimer();
|
|
2304
|
+
}
|
|
2305
|
+
}
|
|
2306
|
+
|
|
1380
2307
|
/**
|
|
1381
2308
|
* Initializes event listeners for the Contact Center service
|
|
1382
2309
|
* Sets up handlers for connection state changes and other core events
|
|
@@ -1436,6 +2363,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1436
2363
|
|
|
1437
2364
|
try {
|
|
1438
2365
|
const reLoginResponse = await this.services.agent.reload();
|
|
2366
|
+
this.updateWellnessSession(reLoginResponse.data.agentSessionId);
|
|
2367
|
+
|
|
1439
2368
|
const {
|
|
1440
2369
|
agentId,
|
|
1441
2370
|
lastStateChangeReason,
|
|
@@ -1481,6 +2410,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
1481
2410
|
this.agentConfig.lastStateAuxCodeId = auxCodeId;
|
|
1482
2411
|
this.agentConfig.isAgentLoggedIn = true;
|
|
1483
2412
|
|
|
2413
|
+
await this.ensureWxAppPostStationLogin();
|
|
2414
|
+
|
|
1484
2415
|
LoggerProxy.log(
|
|
1485
2416
|
`Silent relogin process completed successfully with login Option: ${reLoginResponse.data.deviceType} teamId: ${reLoginResponse.data.teamId}`,
|
|
1486
2417
|
{
|
|
@@ -2199,8 +3130,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
2199
3130
|
}
|
|
2200
3131
|
|
|
2201
3132
|
/**
|
|
2202
|
-
* Returns paginated entry points
|
|
2203
|
-
*
|
|
3133
|
+
* Returns paginated entry points using the EntryPoint service defaults.
|
|
3134
|
+
* Existing request parameters can override those defaults.
|
|
2204
3135
|
* @public
|
|
2205
3136
|
*/
|
|
2206
3137
|
public async getEntryPoints(
|
|
@@ -2210,8 +3141,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
|
|
|
2210
3141
|
}
|
|
2211
3142
|
|
|
2212
3143
|
/**
|
|
2213
|
-
* Returns paginated contact service queues
|
|
2214
|
-
*
|
|
3144
|
+
* Returns paginated contact service queues using the Queue service defaults.
|
|
3145
|
+
* Existing request parameters can override those defaults.
|
|
2215
3146
|
* @public
|
|
2216
3147
|
*/
|
|
2217
3148
|
public async getQueues(
|