@webex/contact-center 3.12.0-webex-services-ready.4 → 3.13.0-next.1

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.
Files changed (250) hide show
  1. package/.sdd/manifest.json +24 -13
  2. package/ai-docs/ARCHITECTURE.md +1 -1
  3. package/ai-docs/CONTRACTS.md +21 -3
  4. package/ai-docs/SECURITY.md +1 -1
  5. package/ai-docs/SERVICE_STATE.md +4 -0
  6. package/ai-docs/contact-center-spec.md +53 -6
  7. package/ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md +362 -0
  8. package/ai-docs/features/contact-owner-change-refactor.md +78 -0
  9. package/dist/cc.js +816 -26
  10. package/dist/cc.js.map +1 -1
  11. package/dist/config.js +7 -0
  12. package/dist/config.js.map +1 -1
  13. package/dist/constants.js +29 -2
  14. package/dist/constants.js.map +1 -1
  15. package/dist/index.js +66 -12
  16. package/dist/index.js.map +1 -1
  17. package/dist/metrics/MetricsManager.js +16 -0
  18. package/dist/metrics/MetricsManager.js.map +1 -1
  19. package/dist/metrics/behavioral-events.js +110 -0
  20. package/dist/metrics/behavioral-events.js.map +1 -1
  21. package/dist/metrics/constants.js +33 -0
  22. package/dist/metrics/constants.js.map +1 -1
  23. package/dist/services/AddressBook.js +18 -15
  24. package/dist/services/AddressBook.js.map +1 -1
  25. package/dist/services/AnswerCallOnWebexService.js +202 -0
  26. package/dist/services/AnswerCallOnWebexService.js.map +1 -0
  27. package/dist/services/ApiAiAssistant.js +221 -11
  28. package/dist/services/ApiAiAssistant.js.map +1 -1
  29. package/dist/services/EntryPoint.js +46 -68
  30. package/dist/services/EntryPoint.js.map +1 -1
  31. package/dist/services/Queue.js +27 -22
  32. package/dist/services/Queue.js.map +1 -1
  33. package/dist/services/WebCallingService.js +287 -37
  34. package/dist/services/WebCallingService.js.map +1 -1
  35. package/dist/services/WebexCrossClientService.js +225 -0
  36. package/dist/services/WebexCrossClientService.js.map +1 -0
  37. package/dist/services/WxAppTelephonyMercurySync.js +111 -0
  38. package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
  39. package/dist/services/config/Util.js +46 -46
  40. package/dist/services/config/Util.js.map +1 -1
  41. package/dist/services/config/constants.js +34 -77
  42. package/dist/services/config/constants.js.map +1 -1
  43. package/dist/services/config/index.js +100 -226
  44. package/dist/services/config/index.js.map +1 -1
  45. package/dist/services/config/types.js +55 -35
  46. package/dist/services/config/types.js.map +1 -1
  47. package/dist/services/constants.js +11 -1
  48. package/dist/services/constants.js.map +1 -1
  49. package/dist/services/core/Err.js.map +1 -1
  50. package/dist/services/core/Utils.js +25 -1
  51. package/dist/services/core/Utils.js.map +1 -1
  52. package/dist/services/core/WebexRequest.js +6 -2
  53. package/dist/services/core/WebexRequest.js.map +1 -1
  54. package/dist/services/core/aqm-reqs.js +17 -11
  55. package/dist/services/core/aqm-reqs.js.map +1 -1
  56. package/dist/services/core/constants.js +9 -1
  57. package/dist/services/core/constants.js.map +1 -1
  58. package/dist/services/core/types.js.map +1 -1
  59. package/dist/services/core/websocket/WebSocketManager.js +17 -1
  60. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  61. package/dist/services/task/Task.js +275 -8
  62. package/dist/services/task/Task.js.map +1 -1
  63. package/dist/services/task/TaskFactory.js +11 -6
  64. package/dist/services/task/TaskFactory.js.map +1 -1
  65. package/dist/services/task/TaskManager.js +590 -42
  66. package/dist/services/task/TaskManager.js.map +1 -1
  67. package/dist/services/task/TaskUtils.js +11 -1
  68. package/dist/services/task/TaskUtils.js.map +1 -1
  69. package/dist/services/task/WebexCallingUtils.js +70 -0
  70. package/dist/services/task/WebexCallingUtils.js.map +1 -0
  71. package/dist/services/task/constants.js +14 -2
  72. package/dist/services/task/constants.js.map +1 -1
  73. package/dist/services/task/contact.js +29 -0
  74. package/dist/services/task/contact.js.map +1 -1
  75. package/dist/services/task/digital/Digital.js +4 -3
  76. package/dist/services/task/digital/Digital.js.map +1 -1
  77. package/dist/services/task/state-machine/TaskStateMachine.js +162 -53
  78. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -1
  79. package/dist/services/task/state-machine/actions.js +6 -1
  80. package/dist/services/task/state-machine/actions.js.map +1 -1
  81. package/dist/services/task/state-machine/guards.js +7 -10
  82. package/dist/services/task/state-machine/guards.js.map +1 -1
  83. package/dist/services/task/state-machine/types.js.map +1 -1
  84. package/dist/services/task/state-machine/uiControlsComputer.js +118 -18
  85. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -1
  86. package/dist/services/task/types.js +47 -1
  87. package/dist/services/task/types.js.map +1 -1
  88. package/dist/services/task/voice/Voice.js +477 -17
  89. package/dist/services/task/voice/Voice.js.map +1 -1
  90. package/dist/services/task/voice/WebRTC.js +6 -3
  91. package/dist/services/task/voice/WebRTC.js.map +1 -1
  92. package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
  93. package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
  94. package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
  95. package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
  96. package/dist/services/wxAppDiagnosticLogging.js +159 -0
  97. package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
  98. package/dist/services/wxAppTelephonyUtils.js +19 -0
  99. package/dist/services/wxAppTelephonyUtils.js.map +1 -0
  100. package/dist/types/cc.d.ts +127 -9
  101. package/dist/types/config.d.ts +7 -0
  102. package/dist/types/constants.d.ts +23 -0
  103. package/dist/types/index.d.ts +38 -17
  104. package/dist/types/metrics/MetricsManager.d.ts +6 -0
  105. package/dist/types/metrics/constants.d.ts +31 -0
  106. package/dist/types/services/AddressBook.d.ts +2 -1
  107. package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
  108. package/dist/types/services/ApiAiAssistant.d.ts +48 -4
  109. package/dist/types/services/EntryPoint.d.ts +7 -5
  110. package/dist/types/services/Queue.d.ts +5 -3
  111. package/dist/types/services/WebexCrossClientService.d.ts +32 -0
  112. package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
  113. package/dist/types/services/config/Util.d.ts +4 -8
  114. package/dist/types/services/config/constants.d.ts +28 -76
  115. package/dist/types/services/config/index.d.ts +16 -64
  116. package/dist/types/services/config/types.d.ts +150 -173
  117. package/dist/types/services/constants.d.ts +9 -0
  118. package/dist/types/services/core/Err.d.ts +2 -0
  119. package/dist/types/services/core/Utils.d.ts +10 -0
  120. package/dist/types/services/core/WebexRequest.d.ts +1 -0
  121. package/dist/types/services/core/constants.d.ts +7 -0
  122. package/dist/types/services/core/types.d.ts +2 -0
  123. package/dist/types/services/task/Task.d.ts +34 -5
  124. package/dist/types/services/task/TaskFactory.d.ts +4 -2
  125. package/dist/types/services/task/TaskUtils.d.ts +6 -0
  126. package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
  127. package/dist/types/services/task/constants.d.ts +12 -0
  128. package/dist/types/services/task/contact.d.ts +4 -0
  129. package/dist/types/services/task/digital/Digital.d.ts +4 -3
  130. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +304 -56
  131. package/dist/types/services/task/state-machine/guards.d.ts +6 -5
  132. package/dist/types/services/task/state-machine/types.d.ts +9 -1
  133. package/dist/types/services/task/types.d.ts +192 -5
  134. package/dist/types/services/task/voice/Voice.d.ts +68 -11
  135. package/dist/types/services/task/voice/WebRTC.d.ts +5 -4
  136. package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
  137. package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
  138. package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
  139. package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
  140. package/dist/types/types.d.ts +125 -13
  141. package/dist/types/utils/PageCache.d.ts +20 -3
  142. package/dist/types.js +90 -8
  143. package/dist/types.js.map +1 -1
  144. package/dist/utils/PageCache.js +19 -5
  145. package/dist/utils/PageCache.js.map +1 -1
  146. package/dist/webex.js +9 -1
  147. package/dist/webex.js.map +1 -1
  148. package/package.json +10 -9
  149. package/src/cc.ts +1047 -48
  150. package/src/config.ts +7 -0
  151. package/src/constants.ts +36 -0
  152. package/src/index.ts +49 -11
  153. package/src/metrics/MetricsManager.ts +16 -0
  154. package/src/metrics/ai-docs/metrics-spec.md +138 -21
  155. package/src/metrics/behavioral-events.ts +112 -0
  156. package/src/metrics/constants.ts +36 -0
  157. package/src/services/AddressBook.ts +17 -6
  158. package/src/services/AnswerCallOnWebexService.ts +239 -0
  159. package/src/services/ApiAiAssistant.ts +297 -13
  160. package/src/services/EntryPoint.ts +59 -60
  161. package/src/services/Queue.ts +29 -12
  162. package/src/services/WebCallingService.ts +362 -40
  163. package/src/services/WebexCrossClientService.ts +298 -0
  164. package/src/services/WxAppTelephonyMercurySync.ts +142 -0
  165. package/src/services/agent/ai-docs/AGENTS.md +1 -1
  166. package/src/services/agent/ai-docs/agent-spec.md +1 -0
  167. package/src/services/ai-docs/AGENTS.md +11 -11
  168. package/src/services/ai-docs/services-spec.md +25 -5
  169. package/src/services/config/Util.ts +52 -82
  170. package/src/services/config/ai-docs/AGENTS.md +35 -40
  171. package/src/services/config/ai-docs/ARCHITECTURE.md +90 -103
  172. package/src/services/config/ai-docs/config-spec.md +132 -132
  173. package/src/services/config/constants.ts +39 -85
  174. package/src/services/config/index.ts +116 -277
  175. package/src/services/config/types.ts +145 -195
  176. package/src/services/constants.ts +10 -0
  177. package/src/services/core/Err.ts +1 -0
  178. package/src/services/core/Utils.ts +28 -0
  179. package/src/services/core/WebexRequest.ts +3 -1
  180. package/src/services/core/ai-docs/core-spec.md +25 -11
  181. package/src/services/core/aqm-reqs.ts +18 -12
  182. package/src/services/core/constants.ts +8 -0
  183. package/src/services/core/types.ts +33 -1
  184. package/src/services/core/websocket/WebSocketManager.ts +26 -2
  185. package/src/services/task/Task.ts +386 -12
  186. package/src/services/task/TaskFactory.ts +33 -6
  187. package/src/services/task/TaskManager.ts +857 -41
  188. package/src/services/task/TaskUtils.ts +13 -0
  189. package/src/services/task/WebexCallingUtils.ts +136 -0
  190. package/src/services/task/ai-docs/ARCHITECTURE.md +1 -0
  191. package/src/services/task/ai-docs/task-spec.md +190 -8
  192. package/src/services/task/constants.ts +13 -0
  193. package/src/services/task/contact.ts +30 -0
  194. package/src/services/task/digital/Digital.ts +11 -4
  195. package/src/services/task/state-machine/TaskStateMachine.ts +235 -81
  196. package/src/services/task/state-machine/actions.ts +5 -2
  197. package/src/services/task/state-machine/ai-docs/AGENTS.md +6 -4
  198. package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +35 -16
  199. package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +103 -33
  200. package/src/services/task/state-machine/guards.ts +7 -10
  201. package/src/services/task/state-machine/types.ts +16 -1
  202. package/src/services/task/state-machine/uiControlsComputer.ts +206 -32
  203. package/src/services/task/types.ts +269 -4
  204. package/src/services/task/voice/Voice.ts +625 -17
  205. package/src/services/task/voice/WebRTC.ts +11 -4
  206. package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
  207. package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
  208. package/src/services/wxAppDiagnosticLogging.ts +286 -0
  209. package/src/services/wxAppTelephonyUtils.ts +14 -0
  210. package/src/types.ts +159 -13
  211. package/src/utils/AGENTS.md +21 -10
  212. package/src/utils/PageCache.ts +38 -5
  213. package/src/utils/ai-docs/utils-spec.md +21 -11
  214. package/src/webex.js +8 -0
  215. package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
  216. package/test/unit/spec/cc.ts +3595 -120
  217. package/test/unit/spec/index.ts +891 -0
  218. package/test/unit/spec/metrics/MetricsManager.ts +25 -0
  219. package/test/unit/spec/metrics/behavioral-events.ts +60 -0
  220. package/test/unit/spec/services/AddressBook.ts +37 -6
  221. package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
  222. package/test/unit/spec/services/ApiAiAssistant.ts +269 -8
  223. package/test/unit/spec/services/EntryPoint.ts +87 -40
  224. package/test/unit/spec/services/Queue.ts +123 -12
  225. package/test/unit/spec/services/WebCallingService.ts +483 -54
  226. package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
  227. package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
  228. package/test/unit/spec/services/config/Util.ts +501 -0
  229. package/test/unit/spec/services/config/index.ts +313 -543
  230. package/test/unit/spec/services/core/Utils.ts +22 -0
  231. package/test/unit/spec/services/core/WebexRequest.ts +8 -7
  232. package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
  233. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +64 -14
  234. package/test/unit/spec/services/task/Task.ts +2257 -11
  235. package/test/unit/spec/services/task/TaskFactory.ts +56 -2
  236. package/test/unit/spec/services/task/TaskManager.ts +5559 -1493
  237. package/test/unit/spec/services/task/TaskUtils.ts +72 -0
  238. package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
  239. package/test/unit/spec/services/task/contact.ts +33 -0
  240. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +1501 -92
  241. package/test/unit/spec/services/task/state-machine/guards.ts +210 -8
  242. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +445 -7
  243. package/test/unit/spec/services/task/voice/Voice.ts +1710 -4
  244. package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
  245. package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
  246. package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
  247. package/test/unit/spec/wellnessSampleUtils.ts +288 -0
  248. package/typedoc.md +1 -1
  249. package/umd/contact-center.min.js +2 -2
  250. package/umd/contact-center.min.js.map +1 -1
package/src/cc.ts CHANGED
@@ -26,6 +26,11 @@ import {
26
26
  UpdateDeviceTypeResponse,
27
27
  GenericError,
28
28
  ConfigFlags,
29
+ WellnessBreakEvent,
30
+ WellnessBreakNotificationAction,
31
+ WELLNESS_BREAK_NOTIFICATION_ACTIONS,
32
+ VoiceConnectionState,
33
+ VOICE_CONNECTION_ERROR,
29
34
  } from './types';
30
35
  import {
31
36
  READY,
@@ -38,6 +43,8 @@ import {
38
43
  UNKNOWN_ERROR,
39
44
  MERCURY_DISCONNECTED_SUCCESS,
40
45
  METHODS,
46
+ WELLNESS_BREAK_HANDLER,
47
+ DEFAULT_VOICE_CONNECTION_STATE,
41
48
  } from './constants';
42
49
  import {AGENT_STATE_AVAILABLE, AGENT_STATE_AVAILABLE_ID} from './services/config/constants';
43
50
  import {AGENT, RTD_SUBSCRIBE_API, SUBSCRIBE_API, WEB_RTC_PREFIX} from './services/constants';
@@ -45,17 +52,23 @@ import Services from './services';
45
52
  import WebexRequest from './services/core/WebexRequest';
46
53
  import LoggerProxy from './logger-proxy';
47
54
  import {StateChange, Logout, StateChangeSuccess, AGENT_EVENTS} from './services/agent/types';
48
- import {getErrorDetails, isValidDialNumber} from './services/core/Utils';
55
+ import {getErrorDetails, isRecord, isValidDialNumber} from './services/core/Utils';
49
56
  import {
50
57
  Profile,
51
58
  WelcomeEvent,
52
59
  CC_EVENTS,
60
+ VOICE_CONNECTION_EVENTS,
53
61
  OutdialAniEntriesResponse,
54
62
  OutdialAniParams,
63
+ Entity,
55
64
  } from './services/config/types';
56
65
  import {ConnectionLostDetails} from './services/core/websocket/types';
57
66
  import TaskManager from './services/task/TaskManager';
58
67
  import WebCallingService from './services/WebCallingService';
68
+ import AnswerCallOnWebexService from './services/AnswerCallOnWebexService';
69
+ import WebexCrossClientService from './services/WebexCrossClientService';
70
+ import WxAppTelephonyMercurySync from './services/WxAppTelephonyMercurySync';
71
+ import {logWxAppSessionReadiness} from './services/wxAppDiagnosticLogging';
59
72
  import {
60
73
  ITask,
61
74
  TASK_EVENTS,
@@ -78,6 +91,13 @@ import type {
78
91
  ContactServiceQueueSearchParams,
79
92
  } from './types';
80
93
 
94
+ /**
95
+ * Typed allow-list of server-controlled websocket event names this SDK re-emits verbatim.
96
+ * Guards against emitting an arbitrary/unknown `data.type` supplied by the websocket payload.
97
+ * @ignore
98
+ */
99
+ const CC_EVENT_ALLOW_LIST = new Set<string>(Object.values(CC_EVENTS));
100
+
81
101
  /**
82
102
  * The main Contact Center plugin class that enables integration with Webex Contact Center.
83
103
  *
@@ -161,7 +181,7 @@ import type {
161
181
  *
162
182
  * // Login with browser-based calling
163
183
  * await cc.stationLogin({
164
- * teamId: profile.teams[0].teamId,
184
+ * teamId: profile.teams[0].id,
165
185
  * loginOption: 'BROWSER'
166
186
  * });
167
187
  *
@@ -232,6 +252,34 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
232
252
  */
233
253
  private webCallingService: WebCallingService;
234
254
 
255
+ /**
256
+ * REST telephony for wxApp thick-client answer (WXCC-6026)
257
+ * @private
258
+ */
259
+ private answerCallOnWebexService: AnswerCallOnWebexService;
260
+
261
+ /**
262
+ * usersub cross-client state for Webex App toast suppression
263
+ * @private
264
+ */
265
+ private webexCrossClientService: WebexCrossClientService;
266
+
267
+ /**
268
+ * Mercury telephony mute sync for wxApp thick-client answer
269
+ * @private
270
+ */
271
+ private wxAppTelephonyMercurySync: WxAppTelephonyMercurySync;
272
+
273
+ /** True when wxApp mute sync opened Mercury (Extension/DN-only profiles). */
274
+ private wxAppMercuryConnectedByCc = false;
275
+
276
+ /** True when wxApp mute sync registered the Webex device. */
277
+ private wxAppDeviceRegisteredByCc = false;
278
+
279
+ private static readonly WXAPP_FALSE_PUBLISH_RETRY_DELAY_MS = 30_000;
280
+ private static readonly WXAPP_FALSE_PUBLISH_MAX_RETRIES = 3;
281
+ private wxAppFalsePublishRetryTimer?: ReturnType<typeof setTimeout>;
282
+
235
283
  /**
236
284
  * Core service managers for Contact Center operations
237
285
  * Includes agent, connection, and configuration services
@@ -264,6 +312,19 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
264
312
  */
265
313
  private metricsManager: MetricsManager;
266
314
 
315
+ /** Current login/relogin session used for agent-scoped wellness validation. */
316
+ private currentAgentSessionId?: string;
317
+
318
+ /** Registered-session cache for the system WellbeingBreak idle code. */
319
+ private wellbeingBreakIdleCode?: Entity;
320
+
321
+ /** Registration generation that owns the wellness idle-code cache and in-flight lookups. */
322
+ private wellnessRegistrationGeneration = 0;
323
+
324
+ private updateWellnessSession(agentSessionId?: string): void {
325
+ this.currentAgentSessionId = agentSessionId;
326
+ }
327
+
267
328
  /**
268
329
  * API instance for managing Webex Contact Center entry points
269
330
  * Provides functionality to fetch entry points with caching support
@@ -405,7 +466,18 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
405
466
  });
406
467
 
407
468
  this.webCallingService = new WebCallingService(this.$webex);
408
- this.apiAIAssistant = new ApiAIAssistant(this.$webex);
469
+ this.webCallingService.on(
470
+ VOICE_CONNECTION_EVENTS.STATE_CHANGE,
471
+ this.handleVoiceConnectionStateChange
472
+ );
473
+ this.answerCallOnWebexService = new AnswerCallOnWebexService(this.$webex);
474
+ this.webexCrossClientService = new WebexCrossClientService(this.$webex);
475
+ this.wxAppTelephonyMercurySync = new WxAppTelephonyMercurySync(this.$webex);
476
+ this.apiAIAssistant = new ApiAIAssistant(this.$webex, () => ({
477
+ isWellnessBreakEnabled: this.agentConfig?.isWellnessBreakEnabled === true,
478
+ agentId: this.agentConfig?.agentId,
479
+ agentSessionId: this.currentAgentSessionId,
480
+ }));
409
481
  this.metricsManager = MetricsManager.getInstance({webex: this.$webex});
410
482
  this.taskManager = TaskManager.getTaskManager(
411
483
  this.apiAIAssistant,
@@ -414,6 +486,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
414
486
  this.services.webSocketManager,
415
487
  this.services.rtdWebSocketManager
416
488
  );
489
+ this.taskManager.setAnswerCallOnWebexService(this.answerCallOnWebexService);
417
490
  this.incomingTaskListener();
418
491
 
419
492
  // Initialize API instances
@@ -436,6 +509,12 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
436
509
  this.trigger(TASK_EVENTS.TASK_INCOMING, task);
437
510
  };
438
511
 
512
+ private handleVoiceConnectionStateChange = (state: VoiceConnectionState): void => {
513
+ // WebexPlugin exposes `trigger` at runtime, though it is missing from its TypeScript types.
514
+ // @ts-ignore
515
+ this.trigger(VOICE_CONNECTION_EVENTS.STATE_CHANGE, state);
516
+ };
517
+
439
518
  /**
440
519
  * Handles task hydration events for updating task data
441
520
  * @private
@@ -476,7 +555,126 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
476
555
  this.trigger(TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, task);
477
556
  };
478
557
 
558
+ private trackInvalidWellnessEvent(reason: string): void {
559
+ this.metricsManager.trackEvent(
560
+ METRIC_EVENT_NAMES.AI_ASSISTANT_WELLNESS_EVENT_INVALID,
561
+ {reason},
562
+ ['operational']
563
+ );
564
+ }
565
+
566
+ private normalizeWellnessBreakEvent(payload: Record<string, unknown>): WellnessBreakEvent | null {
567
+ if (this.agentConfig?.isWellnessBreakEnabled !== true) {
568
+ this.trackInvalidWellnessEvent('wellness_disabled');
569
+
570
+ return null;
571
+ }
572
+
573
+ const notificationData = isRecord(payload.data) ? payload.data : null;
574
+ const notificationDetails =
575
+ notificationData && isRecord(notificationData.notifDetails)
576
+ ? notificationData.notifDetails
577
+ : null;
578
+ const sessionData =
579
+ notificationData && isRecord(notificationData.data) ? notificationData.data : null;
580
+ const actionEvent = notificationDetails?.actionEvent;
581
+
582
+ if (
583
+ payload.type !== WELLNESS_BREAK_HANDLER ||
584
+ notificationData?.notifType !== WELLNESS_BREAK_HANDLER ||
585
+ typeof actionEvent !== 'string'
586
+ ) {
587
+ this.trackInvalidWellnessEvent('malformed_wellness_event');
588
+
589
+ return null;
590
+ }
591
+
592
+ if (
593
+ !Object.values(WELLNESS_BREAK_NOTIFICATION_ACTIONS).includes(
594
+ actionEvent as WellnessBreakNotificationAction
595
+ )
596
+ ) {
597
+ this.trackInvalidWellnessEvent('unknown_wellness_action');
598
+
599
+ return null;
600
+ }
601
+
602
+ const agentId = notificationData.agentId;
603
+ const eventOrgId = notificationData.orgId;
604
+ const sessionOrgId = sessionData?.orgId;
605
+ const envelopeOrgId = payload.orgId;
606
+ const agentSessionId = sessionData?.agentSessionId;
607
+ const currentOrgId = this.$webex.credentials.getOrgId();
608
+
609
+ if (
610
+ typeof agentId !== 'string' ||
611
+ typeof eventOrgId !== 'string' ||
612
+ typeof sessionOrgId !== 'string' ||
613
+ typeof envelopeOrgId !== 'string' ||
614
+ typeof agentSessionId !== 'string' ||
615
+ !agentId ||
616
+ !eventOrgId ||
617
+ !sessionOrgId ||
618
+ !envelopeOrgId ||
619
+ !agentSessionId
620
+ ) {
621
+ this.trackInvalidWellnessEvent('missing_wellness_identity');
622
+
623
+ return null;
624
+ }
625
+
626
+ if (
627
+ agentId !== this.agentConfig?.agentId ||
628
+ eventOrgId !== currentOrgId ||
629
+ sessionOrgId !== currentOrgId ||
630
+ envelopeOrgId !== currentOrgId
631
+ ) {
632
+ this.trackInvalidWellnessEvent('mismatched_wellness_identity');
633
+
634
+ return null;
635
+ }
636
+
637
+ const interactionValue = sessionData.interactionId ?? sessionData.InteractionId;
638
+ const actionText = notificationDetails.actionText;
639
+ const trackingId = payload.trackingId;
640
+
641
+ return {
642
+ agentId,
643
+ orgId: currentOrgId,
644
+ agentSessionId,
645
+ actionEvent: actionEvent as WellnessBreakNotificationAction,
646
+ ...(typeof actionText === 'string' ? {actionText} : {}),
647
+ ...(typeof interactionValue === 'string' ? {interactionId: interactionValue} : {}),
648
+ ...(typeof trackingId === 'string' ? {trackingId} : {}),
649
+ };
650
+ }
651
+
652
+ private handleWellnessBreakWebsocketPayload(payload: Record<string, unknown>): boolean {
653
+ if (payload.type !== WELLNESS_BREAK_HANDLER) {
654
+ return false;
655
+ }
656
+
657
+ const wellnessEvent = this.normalizeWellnessBreakEvent(payload);
658
+ if (wellnessEvent) {
659
+ // @ts-ignore - WebexPlugin emit is available at runtime but absent from its declaration.
660
+ this.emit(CC_EVENTS.WELLNESS_BREAK, wellnessEvent);
661
+ }
662
+
663
+ return true;
664
+ }
665
+
479
666
  private handleRTDWebsocketMessage = (event: string) => {
667
+ let payload: unknown;
668
+ try {
669
+ payload = JSON.parse(event);
670
+ } catch {
671
+ // TaskManager retains its existing malformed RTD message handling.
672
+ }
673
+
674
+ if (isRecord(payload) && this.handleWellnessBreakWebsocketPayload(payload)) {
675
+ return;
676
+ }
677
+
480
678
  this.taskManager.handleRealtimeWebsocketEvent(event);
481
679
  };
482
680
 
@@ -524,15 +722,17 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
524
722
  *
525
723
  * console.log('Agent ID:', profile.agentId);
526
724
  * console.log('Default DN:', profile.defaultDn);
527
- * console.log('Teams:', profile.teams.map(t => t.teamId));
725
+ * console.log('Teams:', profile.teams.map(t => t.id));
528
726
  * console.log('WebRTC Enabled:', profile.webRtcEnabled);
529
727
  * console.log('Supported Login Options:', profile.loginVoiceOptions);
530
728
  *
531
729
  * // Now you can proceed with station login, state changes, etc.
532
- * await cc.stationLogin({ teamId: profile.teams[0].teamId, loginOption: 'BROWSER' });
730
+ * await cc.stationLogin({ teamId: profile.teams[0].id, loginOption: 'BROWSER' });
533
731
  * ```
534
732
  */
535
733
  public async register(): Promise<Profile> {
734
+ this.wellnessRegistrationGeneration += 1;
735
+ this.wellbeingBreakIdleCode = undefined;
536
736
  LoggerProxy.log('Starting CC SDK registration', {
537
737
  module: CC_FILE,
538
738
  method: METHODS.REGISTER,
@@ -562,7 +762,12 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
562
762
  method: METHODS.REGISTER,
563
763
  });
564
764
 
565
- return resp;
765
+ // Registration can silently restore a station session without emitting a
766
+ // relogin event. Project the active session for consumers that must
767
+ // recover session-scoped state after a page refresh.
768
+ return resp.isAgentLoggedIn && this.currentAgentSessionId
769
+ ? {...resp, agentSessionId: this.currentAgentSessionId}
770
+ : resp;
566
771
  } catch (error) {
567
772
  this.metricsManager.trackEvent(
568
773
  METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_FAILED,
@@ -615,12 +820,16 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
615
820
 
616
821
  */
617
822
  public async deregister(): Promise<void> {
823
+ this.wellnessRegistrationGeneration += 1;
824
+ this.wellbeingBreakIdleCode = undefined;
825
+ this.updateWellnessSession();
618
826
  try {
619
827
  this.metricsManager.timeEvent([
620
828
  METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_SUCCESS,
621
829
  METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_FAIL,
622
830
  ]);
623
831
 
832
+ this.taskManager.clearAISummaryState();
624
833
  this.taskManager.off(TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
625
834
  this.taskManager.off(TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
626
835
  this.taskManager.off(TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this.handleTaskMultiLoginHydrate);
@@ -634,6 +843,10 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
634
843
  this.services.rtdWebSocketManager.off('message', this.handleRTDWebsocketMessage);
635
844
  this.services.connectionService.off('connectionLost', this.handleConnectionLost);
636
845
 
846
+ const {publishError: wxAppPublishError} = await this.teardownWxAppLocalState({
847
+ clearInitFlag: true,
848
+ });
849
+
637
850
  if (
638
851
  this.agentConfig.webRtcEnabled &&
639
852
  this.agentConfig.loginVoiceOptions.includes(LoginOption.BROWSER)
@@ -663,7 +876,13 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
663
876
  }
664
877
 
665
878
  // Clear any cached agent configuration
879
+ this.wellbeingBreakIdleCode = undefined;
666
880
  this.agentConfig = null;
881
+ this.updateWellnessSession();
882
+
883
+ if (wxAppPublishError) {
884
+ throw wxAppPublishError;
885
+ }
667
886
 
668
887
  LoggerProxy.log('Deregistered successfully', {
669
888
  module: CC_FILE,
@@ -727,6 +946,9 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
727
946
  * ```
728
947
  */
729
948
  public async getBuddyAgents(data: BuddyAgents): Promise<BuddyAgentsResponse> {
949
+ const {action, state, mediaType = 'telephony'} = data;
950
+ const buddyAgentState = state ?? (action === 'Transfer' ? AGENT_STATE_AVAILABLE : undefined);
951
+
730
952
  LoggerProxy.info('Fetching buddy agents', {
731
953
  module: CC_FILE,
732
954
  method: METHODS.GET_BUDDY_AGENTS,
@@ -737,15 +959,19 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
737
959
  METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_FAILED,
738
960
  ]);
739
961
  const resp = await this.services.agent.buddyAgents({
740
- data: {agentProfileId: this.agentConfig.agentProfileID, ...data},
962
+ data: {
963
+ agentProfileId: this.agentConfig.agentProfileID,
964
+ mediaType,
965
+ ...(buddyAgentState ? {state: buddyAgentState} : {}),
966
+ },
741
967
  });
742
968
 
743
969
  this.metricsManager.trackEvent(
744
970
  METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_SUCCESS,
745
971
  {
746
972
  ...MetricsManager.getCommonTrackingFieldForAQMResponse(resp),
747
- mediaType: data.mediaType,
748
- buddyAgentState: data.state,
973
+ mediaType,
974
+ buddyAgentState,
749
975
  buddyAgentCount: resp.data.agentList.length,
750
976
  },
751
977
  ['operational']
@@ -765,8 +991,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
765
991
  METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_FAILED,
766
992
  {
767
993
  ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(failureResp),
768
- mediaType: data.mediaType,
769
- buddyAgentState: data.state,
994
+ mediaType,
995
+ buddyAgentState,
770
996
  },
771
997
  ['operational']
772
998
  );
@@ -808,21 +1034,36 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
808
1034
  webRtcEnabled: this.agentConfig.webRtcEnabled,
809
1035
  autoWrapup: this.agentConfig.wrapUpData?.wrapUpProps?.autoWrapup ?? false,
810
1036
  aiFeature: this.agentConfig.aiFeature,
1037
+ consultTransfer: {
1038
+ allowConsultToQueue: this.agentConfig.allowConsultToQueue,
1039
+ accessQueue: this.agentConfig.accessQueue,
1040
+ accessEntryPoint: this.agentConfig.accessEntryPoint,
1041
+ accessBuddyTeam: this.agentConfig.accessBuddyTeam,
1042
+ },
1043
+ enableWxBetterTogether: this.isWxBetterTogetherEnabled(),
1044
+ getWxAppUsersubPublished: () => this.webexCrossClientService.isAnswerCallsStateActive(),
811
1045
  };
812
1046
  this.taskManager.setConfigFlags(configFlags);
813
1047
  // TODO: Make profile a singleton to make it available throughout app/sdk so we dont need to inject info everywhere
814
1048
  this.taskManager.setWrapupData(this.agentConfig.wrapUpData);
815
1049
  this.taskManager.setAgentId(this.agentConfig.agentId);
1050
+ this.taskManager.setAgentName(this.agentConfig.agentName);
816
1051
  this.taskManager.setWebRtcEnabled(this.agentConfig.webRtcEnabled);
817
1052
  this.apiAIAssistant.setAIFeatureFlags(this.agentConfig.aiFeature);
1053
+ this.wellbeingBreakIdleCode = undefined;
1054
+ this.updateWellnessSession();
818
1055
 
819
1056
  /**
820
1057
  * RTD websocket currently supports realtime transcripts and suggested responses.
821
1058
  * Extend this condition when additional AI RTD features are introduced.
1059
+ * Wellness break notifications also arrive on this websocket.
822
1060
  */
823
1061
  if (
824
1062
  this.agentConfig.aiFeature?.realtimeTranscripts?.enable ||
825
- this.agentConfig.aiFeature?.suggestedResponses?.enable
1063
+ this.agentConfig.aiFeature?.suggestedResponses?.enable ||
1064
+ this.agentConfig.aiFeature?.generatedSummaries?.wrapUpSummariesEnabled === true ||
1065
+ this.agentConfig.aiFeature?.generatedSummaries?.consultTransferSummariesEnabled === true ||
1066
+ this.agentConfig.isWellnessBreakEnabled
826
1067
  ) {
827
1068
  LoggerProxy.info('Connecting to RTD websocket', {
828
1069
  module: CC_FILE,
@@ -850,9 +1091,9 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
850
1091
  }
851
1092
 
852
1093
  if (
853
- this.agentConfig.webRtcEnabled &&
854
- this.agentConfig.loginVoiceOptions.includes(LoginOption.BROWSER) &&
855
- !this.isWebRTCRegistrationDisabled()
1094
+ this.agentConfig.loginVoiceOptions.some((loginOption) =>
1095
+ this.isBrowserVoiceRequired(loginOption)
1096
+ )
856
1097
  ) {
857
1098
  try {
858
1099
  await this.$webex.internal.mercury.connect();
@@ -887,6 +1128,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
887
1128
 
888
1129
  return this.agentConfig;
889
1130
  } catch (error) {
1131
+ this.updateWellnessSession();
890
1132
  LoggerProxy.error(`Error during register: ${error}`, {
891
1133
  module: CC_FILE,
892
1134
  method: METHODS.CONNECT_WEBSOCKET,
@@ -958,14 +1200,15 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
958
1200
  }
959
1201
  }
960
1202
 
1203
+ const deviceId = this.getDeviceId(data.loginOption, data.dialNumber);
961
1204
  const loginResponse = await this.services.agent.stationLogin({
962
1205
  data: {
963
- dialNumber:
964
- data.loginOption === LoginOption.BROWSER ? this.agentConfig.agentId : data.dialNumber,
1206
+ // BROWSER DN must be webrtc-{agentId} so VPOP/RTMS do not treat a bare UUID as PSTN.
1207
+ dialNumber: data.loginOption === LoginOption.BROWSER ? deviceId : data.dialNumber,
965
1208
  teamId: data.teamId,
966
1209
  deviceType: data.loginOption,
967
1210
  isExtension: data.loginOption === LoginOption.EXTENSION,
968
- deviceId: this.getDeviceId(data.loginOption, data.dialNumber),
1211
+ deviceId,
969
1212
  roles: [AGENT],
970
1213
  teamName: EMPTY_STRING,
971
1214
  siteId: EMPTY_STRING,
@@ -974,11 +1217,10 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
974
1217
  },
975
1218
  });
976
1219
 
977
- if (
978
- this.agentConfig.webRtcEnabled &&
979
- data.loginOption === LoginOption.BROWSER &&
980
- !this.isWebRTCRegistrationDisabled()
981
- ) {
1220
+ this.webCallingService.setLoginOption(data.loginOption);
1221
+ this.webCallingService.setBrowserVoiceRequired(this.isBrowserVoiceRequired(data.loginOption));
1222
+
1223
+ if (this.isBrowserVoiceRequired(data.loginOption)) {
982
1224
  await this.webCallingService.registerWebCallingLine();
983
1225
  } else if (
984
1226
  this.agentConfig.webRtcEnabled &&
@@ -996,6 +1238,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
996
1238
 
997
1239
  const resp = await loginResponse;
998
1240
  const {channelsMap, ...loginData} = resp.data;
1241
+ this.updateWellnessSession(resp.data.agentSessionId);
999
1242
  this.agentConfig.currentTeamId = resp.data.teamId;
1000
1243
  const response = {
1001
1244
  ...loginData,
@@ -1008,7 +1251,16 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1008
1251
  notifsTrackingId: resp.trackingId,
1009
1252
  };
1010
1253
 
1011
- this.webCallingService.setLoginOption(data.loginOption);
1254
+ if (this.agentConfig) {
1255
+ this.agentConfig.deviceType = data.loginOption;
1256
+ if (
1257
+ data.loginOption === LoginOption.AGENT_DN ||
1258
+ data.loginOption === LoginOption.EXTENSION
1259
+ ) {
1260
+ this.agentConfig.defaultDn = data.dialNumber;
1261
+ this.agentConfig.dn = data.dialNumber;
1262
+ }
1263
+ }
1012
1264
  this.metricsManager.trackEvent(
1013
1265
  METRIC_EVENT_NAMES.STATION_LOGIN_SUCCESS,
1014
1266
  {
@@ -1030,6 +1282,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1030
1282
  }
1031
1283
  );
1032
1284
 
1285
+ await this.ensureWxAppPostStationLogin();
1286
+
1033
1287
  return response;
1034
1288
  } catch (error) {
1035
1289
  const failure = error.details as Failure;
@@ -1095,9 +1349,12 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1095
1349
  );
1096
1350
 
1097
1351
  if (this.webCallingService) {
1098
- this.webCallingService.deregisterWebCallingLine();
1352
+ await this.webCallingService.deregisterWebCallingLine();
1099
1353
  }
1100
1354
 
1355
+ await this.teardownWxAppLocalState();
1356
+ this.updateWellnessSession();
1357
+
1101
1358
  LoggerProxy.log(`Agent station logout completed successfully`, {
1102
1359
  module: CC_FILE,
1103
1360
  method: METHODS.STATION_LOGOUT,
@@ -1189,6 +1446,20 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1189
1446
  METRIC_EVENT_NAMES.AGENT_STATE_CHANGE_SUCCESS,
1190
1447
  METRIC_EVENT_NAMES.AGENT_STATE_CHANGE_FAILED,
1191
1448
  ]);
1449
+ if (
1450
+ data.state === AGENT_STATE_AVAILABLE &&
1451
+ this.webCallingService?.isBrowserVoiceRequired() &&
1452
+ !this.webCallingService.isVoiceReady()
1453
+ ) {
1454
+ const error = new Error(VOICE_CONNECTION_ERROR.NOT_READY) as GenericError;
1455
+ error.details = {
1456
+ type: 'SDK_VALIDATION_ERROR',
1457
+ orgId: this.$webex.credentials.getOrgId(),
1458
+ trackingId: EMPTY_STRING,
1459
+ data: {reason: VOICE_CONNECTION_ERROR.NOT_READY},
1460
+ };
1461
+ throw error;
1462
+ }
1192
1463
  const agentStatusResponse = await this.services.agent.stateChange({
1193
1464
  data: {...data, agentId: data.agentId || this.agentConfig.agentId},
1194
1465
  });
@@ -1198,7 +1469,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1198
1469
  {
1199
1470
  ...MetricsManager.getCommonTrackingFieldForAQMResponse(agentStatusResponse),
1200
1471
  requestedState: data.state,
1201
- teamId: this.agentConfig?.teams[0]?.teamId ?? EMPTY_STRING,
1472
+ teamId: this.agentConfig?.teams[0]?.id ?? EMPTY_STRING,
1202
1473
  status: agentStatusResponse.data?.status,
1203
1474
  subStatus: agentStatusResponse.data?.subStatus,
1204
1475
  auxCodeId: data.auxCodeId,
@@ -1234,6 +1505,98 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1234
1505
  }
1235
1506
  }
1236
1507
 
1508
+ /**
1509
+ * Returns the system-managed `WellbeingBreak` idle code for the current registration.
1510
+ * The value is fetched outside Desktop Profile filtering and cached until deregistration.
1511
+ * @returns The normalized system idle-code entity
1512
+ * @throws Structured Contact Center error when wellness is disabled or the code is unavailable
1513
+ * @example
1514
+ * const idleCode = await webex.cc.getWellbeingBreakIdleCode();
1515
+ * @public
1516
+ */
1517
+ public async getWellbeingBreakIdleCode(): Promise<Entity> {
1518
+ const method = METHODS.GET_WELLBEING_BREAK_IDLE_CODE;
1519
+ try {
1520
+ if (!this.agentConfig?.isWellnessBreakEnabled) {
1521
+ const validationError = new Error('WELLNESS_BREAK_NOT_ENABLED') as GenericError;
1522
+ validationError.details = {
1523
+ type: 'SDK_VALIDATION_ERROR',
1524
+ orgId: this.$webex.credentials.getOrgId(),
1525
+ trackingId: EMPTY_STRING,
1526
+ data: {reason: 'WELLNESS_BREAK_NOT_ENABLED'},
1527
+ };
1528
+ throw validationError;
1529
+ }
1530
+
1531
+ if (this.wellbeingBreakIdleCode) {
1532
+ return this.wellbeingBreakIdleCode;
1533
+ }
1534
+
1535
+ this.metricsManager.timeEvent([
1536
+ METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS,
1537
+ METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED,
1538
+ ]);
1539
+ const registrationGeneration = this.wellnessRegistrationGeneration;
1540
+ const orgId = this.$webex.credentials.getOrgId();
1541
+ const idleCode = await this.services.config.getWellbeingBreakIdleCode(orgId);
1542
+
1543
+ if (
1544
+ registrationGeneration !== this.wellnessRegistrationGeneration ||
1545
+ orgId !== this.$webex.credentials.getOrgId() ||
1546
+ !this.agentConfig?.isWellnessBreakEnabled
1547
+ ) {
1548
+ const staleRegistrationError = new Error(
1549
+ 'WELLNESS_BREAK_REGISTRATION_CHANGED'
1550
+ ) as GenericError;
1551
+ staleRegistrationError.details = {
1552
+ type: 'SDK_VALIDATION_ERROR',
1553
+ orgId,
1554
+ trackingId: EMPTY_STRING,
1555
+ data: {reason: 'WELLNESS_BREAK_REGISTRATION_CHANGED'},
1556
+ };
1557
+ throw staleRegistrationError;
1558
+ }
1559
+
1560
+ this.wellbeingBreakIdleCode = idleCode;
1561
+ this.metricsManager.trackEvent(
1562
+ METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS,
1563
+ {},
1564
+ ['operational']
1565
+ );
1566
+
1567
+ return idleCode;
1568
+ } catch (error) {
1569
+ this.metricsManager.trackEvent(
1570
+ METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED,
1571
+ {reason: error instanceof Error ? error.message : UNKNOWN_ERROR},
1572
+ ['operational']
1573
+ );
1574
+ const {error: detailedError} = getErrorDetails(error, method, CC_FILE);
1575
+ throw detailedError;
1576
+ }
1577
+ }
1578
+
1579
+ /**
1580
+ * Returns the current browser voice connection state.
1581
+ * Subscribe to `voice:connectionStateChange` to receive updates. The snapshot keeps line
1582
+ * registration separate from Mobius socket connectivity and does not represent the Contact
1583
+ * Center WebSocket connection.
1584
+ *
1585
+ * @returns {VoiceConnectionState} Current browser voice status and underlying connection states
1586
+ * @fires voice:connectionStateChange When browser voice availability changes
1587
+ * @public
1588
+ * @example
1589
+ * ```typescript
1590
+ * cc.on('voice:connectionStateChange', onVoiceStateChange);
1591
+ * const state = cc.getVoiceConnectionState();
1592
+ * ```
1593
+ */
1594
+ public getVoiceConnectionState(): VoiceConnectionState {
1595
+ const state = this.webCallingService?.getVoiceConnectionState();
1596
+
1597
+ return state ?? {...DEFAULT_VOICE_CONNECTION_STATE};
1598
+ }
1599
+
1237
1600
  /**
1238
1601
  * Processes incoming websocket messages and emits corresponding events
1239
1602
  * Handles various event types including agent state changes, login events,
@@ -1243,8 +1606,14 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1243
1606
  */
1244
1607
  private handleWebsocketMessage = (event: string) => {
1245
1608
  const eventData = JSON.parse(event);
1246
- // Re-emit all the events related to agent except keep-alives
1247
- if (!eventData.keepalive && eventData.data && eventData.data.type) {
1609
+ // Re-emit all the events related to agent except keep-alives. Only event names present in
1610
+ // the typed CC_EVENTS allow-list are emitted; unknown/server-injected types are ignored.
1611
+ if (
1612
+ !eventData.keepalive &&
1613
+ eventData.data &&
1614
+ eventData.data.type &&
1615
+ CC_EVENT_ALLOW_LIST.has(eventData.data.type)
1616
+ ) {
1248
1617
  // @ts-ignore
1249
1618
  this.emit(eventData.data.type, eventData.data);
1250
1619
  }
@@ -1272,8 +1641,19 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1272
1641
  ]);
1273
1642
  }
1274
1643
 
1644
+ if (this.handleWellnessBreakWebsocketPayload(eventData)) {
1645
+ return;
1646
+ }
1647
+
1275
1648
  switch (eventData.type) {
1276
1649
  case CC_EVENTS.AGENT_MULTI_LOGIN:
1650
+ if (
1651
+ eventData.data?.type === 'AgentMultiLoginCloseSession' &&
1652
+ (!eventData.data.agentSessionId ||
1653
+ eventData.data.agentSessionId === this.currentAgentSessionId)
1654
+ ) {
1655
+ this.updateWellnessSession();
1656
+ }
1277
1657
  // @ts-ignore
1278
1658
  this.emit(AGENT_EVENTS.AGENT_MULTI_LOGIN, eventData.data);
1279
1659
  break;
@@ -1292,6 +1672,13 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1292
1672
  switch (eventData.data.type) {
1293
1673
  case CC_EVENTS.AGENT_STATION_LOGIN_SUCCESS: {
1294
1674
  const {channelsMap, ...loginData} = eventData.data;
1675
+ this.updateWellnessSession(loginData.agentSessionId);
1676
+ if (
1677
+ loginData.deviceType === LoginOption.EXTENSION ||
1678
+ loginData.deviceType === LoginOption.AGENT_DN
1679
+ ) {
1680
+ this.webCallingService.setBrowserVoiceRequired(false);
1681
+ }
1295
1682
  const stationLoginData = {
1296
1683
  ...loginData,
1297
1684
  mmProfile: {
@@ -1307,23 +1694,23 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1307
1694
  this.emit(AGENT_EVENTS.AGENT_STATION_LOGIN_SUCCESS, stationLoginData);
1308
1695
  break;
1309
1696
  }
1310
- case CC_EVENTS.AGENT_RELOGIN_SUCCESS:
1311
- {
1312
- const {channelsMap, ...loginData} = eventData.data;
1313
- const stationReLoginData = {
1314
- ...loginData,
1315
- mmProfile: {
1316
- chat: channelsMap.chat?.length,
1317
- email: channelsMap.email?.length,
1318
- social: channelsMap.social?.length,
1319
- telephony: channelsMap.telephony?.length,
1320
- },
1321
- notifsTrackingId: eventData.trackingId,
1322
- };
1323
- // @ts-ignore
1324
- this.emit(AGENT_EVENTS.AGENT_RELOGIN_SUCCESS, stationReLoginData);
1325
- }
1697
+ case CC_EVENTS.AGENT_RELOGIN_SUCCESS: {
1698
+ const {channelsMap, ...loginData} = eventData.data;
1699
+ this.updateWellnessSession(loginData.agentSessionId);
1700
+ const stationReLoginData = {
1701
+ ...loginData,
1702
+ mmProfile: {
1703
+ chat: channelsMap.chat?.length,
1704
+ email: channelsMap.email?.length,
1705
+ social: channelsMap.social?.length,
1706
+ telephony: channelsMap.telephony?.length,
1707
+ },
1708
+ notifsTrackingId: eventData.trackingId,
1709
+ };
1710
+ // @ts-ignore
1711
+ this.emit(AGENT_EVENTS.AGENT_RELOGIN_SUCCESS, stationReLoginData);
1326
1712
  break;
1713
+ }
1327
1714
  case CC_EVENTS.AGENT_STATE_CHANGE_SUCCESS:
1328
1715
  // @ts-ignore
1329
1716
  this.emit(AGENT_EVENTS.AGENT_STATE_CHANGE_SUCCESS, eventData.data);
@@ -1337,6 +1724,12 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1337
1724
  this.emit(AGENT_EVENTS.AGENT_STATION_LOGIN_FAILED, eventData.data);
1338
1725
  break;
1339
1726
  case CC_EVENTS.AGENT_LOGOUT_SUCCESS:
1727
+ if (
1728
+ !eventData.data.agentSessionId ||
1729
+ eventData.data.agentSessionId === this.currentAgentSessionId
1730
+ ) {
1731
+ this.updateWellnessSession();
1732
+ }
1340
1733
  // @ts-ignore
1341
1734
  this.emit(AGENT_EVENTS.AGENT_LOGOUT_SUCCESS, eventData.data);
1342
1735
  break;
@@ -1362,6 +1755,20 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1362
1755
  return this.$config?.disableWebRTCRegistration === true;
1363
1756
  }
1364
1757
 
1758
+ /**
1759
+ * Determines whether this local login should register a browser voice line.
1760
+ * @param {LoginOption} loginOption Login device selected for this station login
1761
+ * @returns {boolean} True when browser WebRTC registration is enabled
1762
+ * @private
1763
+ */
1764
+ private isBrowserVoiceRequired(loginOption: LoginOption): boolean {
1765
+ return (
1766
+ loginOption === LoginOption.BROWSER &&
1767
+ this.agentConfig?.webRtcEnabled === true &&
1768
+ !this.isWebRTCRegistrationDisabled()
1769
+ );
1770
+ }
1771
+
1365
1772
  /**
1366
1773
  * Validates contact-center plugin configuration before service initialization
1367
1774
  * @private
@@ -1377,6 +1784,593 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1377
1784
  }
1378
1785
  }
1379
1786
 
1787
+ /**
1788
+ * Whether wxApp thick-client answer is enabled for this SDK instance.
1789
+ * @public
1790
+ */
1791
+ public isWxBetterTogetherEnabled(): boolean {
1792
+ return this.$config?.enableWxBetterTogether === true;
1793
+ }
1794
+
1795
+ /**
1796
+ * Current station login option (Extension, Dial Number, or Browser/Desktop).
1797
+ * Prefer webCallingService — updated on every stationLogin before wxApp hooks run.
1798
+ * @private
1799
+ */
1800
+ private getCurrentStationLoginOption(): LoginOption | undefined {
1801
+ return this.webCallingService?.loginOption ?? this.agentConfig?.deviceType;
1802
+ }
1803
+
1804
+ /**
1805
+ * wxApp thick-client answer is supported for Extension and Dial Number station login only —
1806
+ * not Browser/Desktop (WebRTC) login.
1807
+ * @private
1808
+ */
1809
+ private assertWxAppStationLoginSupportedForEnable(): void {
1810
+ const loginOption = this.getCurrentStationLoginOption();
1811
+ if (loginOption !== LoginOption.EXTENSION && loginOption !== LoginOption.AGENT_DN) {
1812
+ throw new Error(
1813
+ 'setManageWebexCallingInWxcc requires EXTENSION or AGENT_DN station login. Complete station login before enabling.'
1814
+ );
1815
+ }
1816
+ }
1817
+
1818
+ /**
1819
+ * Clears runtime wxApp config after logout/deregister so stale flags do not apply on relogin.
1820
+ * @private
1821
+ */
1822
+ private resetEnableWxBetterTogetherConfig(): void {
1823
+ if (this.$config) {
1824
+ this.$config.enableWxBetterTogether = false;
1825
+ }
1826
+ this.taskManager.applyEnableWxBetterTogether(false);
1827
+ }
1828
+
1829
+ /**
1830
+ * Runtime enable/disable for wxApp Better Together (toast suppression + Mercury mute sync).
1831
+ *
1832
+ * **Phase 1 (WXCC-6026 / MMT): NOT part of the public host contract.**
1833
+ * Hosts must set `webexConfig.cc.enableWxBetterTogether` before `webex.init()` / `cc.register()`.
1834
+ * To change the flag after the SDK is initialized, re-init the SDK with the updated config.
1835
+ *
1836
+ * **Supported public read API:** {@link isWxBetterTogetherEnabled}.
1837
+ * **Supported telephony API:** unified `task.accept()`, `task.decline()`, `task.toggleMute()`,
1838
+ * `task.transmitDtmf()` — SDK routes wxApp calls internally when the init flag is active.
1839
+ *
1840
+ * **Production lifecycle does not call this method.** Station login, silent relogin, logout,
1841
+ * and deregister use {@link ensureWxAppPostStationLogin} and {@link teardownWxAppLocalState}
1842
+ * (usersub publish + Mercury subscribe/unsubscribe based on the init flag).
1843
+ *
1844
+ * This setter remains as a **private implementation** for Phase 2 runtime toggle and unit tests.
1845
+ * It updates `$config.enableWxBetterTogether`, TaskManager flags, cross-client usersub
1846
+ * (`answer-calls-on-wxcc`), and Mercury mute sync; rolls back config on publish/connect failure.
1847
+ *
1848
+ * @param enabled - `true` to enable wxApp answer + usersub suppression; `false` to disable and tear down.
1849
+ * @throws When enabling without login, on unsupported BROWSER station login, or when usersub/Mercury init fails.
1850
+ * @internal
1851
+ * @see enableWxBetterTogether (CCPluginConfig init flag)
1852
+ * @see ensureWxAppPostStationLogin
1853
+ * @see teardownWxAppLocalState
1854
+ */
1855
+ private async setManageWebexCallingInWxcc(enabled: boolean): Promise<void> {
1856
+ if (enabled && !this.$webex.internal.device?.userId) {
1857
+ throw new Error('Cannot publish answer-calls-on-wxcc: user is not logged in');
1858
+ }
1859
+
1860
+ if (enabled) {
1861
+ this.assertWxAppStationLoginSupportedForEnable();
1862
+ }
1863
+
1864
+ const previousEnabled = this.isWxBetterTogetherEnabled();
1865
+
1866
+ if (this.$config) {
1867
+ this.$config.enableWxBetterTogether = enabled;
1868
+ }
1869
+
1870
+ this.taskManager.applyEnableWxBetterTogether(enabled);
1871
+
1872
+ let publishedEnable = false;
1873
+
1874
+ try {
1875
+ if (enabled) {
1876
+ await this.ensureWxAppMercuryAndSubscribe();
1877
+ await this.publishAnswerOnWebexCrossClientState(true);
1878
+ publishedEnable = true;
1879
+ this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
1880
+ this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
1881
+ } else {
1882
+ await this.publishAnswerOnWebexCrossClientState(false);
1883
+ this.wxAppTelephonyMercurySync.unsubscribe();
1884
+ await this.releaseWxAppMercuryResources();
1885
+ }
1886
+ } catch (error) {
1887
+ if (publishedEnable) {
1888
+ await this.revertWxAppCrossClientPublish();
1889
+ } else if (enabled) {
1890
+ this.wxAppTelephonyMercurySync.unsubscribe();
1891
+ await this.releaseWxAppMercuryResources();
1892
+ }
1893
+
1894
+ if (this.$config) {
1895
+ this.$config.enableWxBetterTogether = previousEnabled;
1896
+ }
1897
+ this.taskManager.applyEnableWxBetterTogether(previousEnabled);
1898
+ throw error;
1899
+ }
1900
+ }
1901
+
1902
+ private getWxAppTelephonyTaskType(): 'Voice' | 'WebRTC' | 'unknown' {
1903
+ const loginOption = this.getCurrentStationLoginOption();
1904
+
1905
+ if (loginOption === LoginOption.BROWSER) {
1906
+ return 'WebRTC';
1907
+ }
1908
+
1909
+ if (loginOption === LoginOption.EXTENSION || loginOption === LoginOption.AGENT_DN) {
1910
+ return 'Voice';
1911
+ }
1912
+
1913
+ return 'unknown';
1914
+ }
1915
+
1916
+ private async ensureWxAppPostStationLogin(): Promise<void> {
1917
+ const loginOption = this.getCurrentStationLoginOption();
1918
+ const flagEnabled = this.isWxBetterTogetherEnabled();
1919
+ const telephonyTaskType = this.getWxAppTelephonyTaskType();
1920
+
1921
+ if (loginOption === LoginOption.BROWSER) {
1922
+ if (flagEnabled) {
1923
+ logWxAppSessionReadiness({
1924
+ enableWxBetterTogether: true,
1925
+ loginOption,
1926
+ wxAppHooksApplied: false,
1927
+ usersubPublished: false,
1928
+ mercurySubscribed: false,
1929
+ telephonyTaskType,
1930
+ skipReason: 'unsupported_browser_login',
1931
+ });
1932
+
1933
+ this.metricsManager.trackEvent(
1934
+ METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED,
1935
+ {
1936
+ loginOption,
1937
+ enableWxBetterTogether: true,
1938
+ skipReason: 'unsupported_browser_login',
1939
+ },
1940
+ ['operational', 'behavioral']
1941
+ );
1942
+ }
1943
+
1944
+ return;
1945
+ }
1946
+
1947
+ let publishedEnable = false;
1948
+ let wxAppInitStage: 'mercury' | 'publish' = 'mercury';
1949
+
1950
+ try {
1951
+ if (flagEnabled) {
1952
+ this.metricsManager.timeEvent([
1953
+ METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS,
1954
+ METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED,
1955
+ ]);
1956
+
1957
+ await this.ensureWxAppMercuryAndSubscribe();
1958
+ wxAppInitStage = 'publish';
1959
+ await this.publishAnswerOnWebexCrossClientState(true);
1960
+ publishedEnable = true;
1961
+ this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
1962
+ this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
1963
+
1964
+ const mercurySubscribed = this.wxAppTelephonyMercurySync.isSubscribed();
1965
+ const usersubPublished = this.webexCrossClientService.isAnswerCallsStateActive();
1966
+
1967
+ logWxAppSessionReadiness({
1968
+ enableWxBetterTogether: true,
1969
+ loginOption,
1970
+ wxAppHooksApplied: true,
1971
+ usersubPublished,
1972
+ mercurySubscribed,
1973
+ telephonyTaskType,
1974
+ });
1975
+
1976
+ const sessionInitReady = mercurySubscribed && usersubPublished;
1977
+
1978
+ if (sessionInitReady) {
1979
+ this.metricsManager.trackEvent(
1980
+ METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS,
1981
+ {
1982
+ loginOption,
1983
+ enableWxBetterTogether: true,
1984
+ usersubPublished,
1985
+ mercurySubscribed,
1986
+ telephonyTaskType,
1987
+ },
1988
+ ['operational', 'behavioral']
1989
+ );
1990
+ } else {
1991
+ this.metricsManager.trackEvent(
1992
+ METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED,
1993
+ {
1994
+ loginOption,
1995
+ enableWxBetterTogether: true,
1996
+ usersubPublished,
1997
+ mercurySubscribed,
1998
+ telephonyTaskType,
1999
+ skipReason: !usersubPublished ? 'usersub_not_published' : 'mercury_not_subscribed',
2000
+ },
2001
+ ['operational', 'behavioral']
2002
+ );
2003
+ }
2004
+ } else {
2005
+ await this.ensureWxAppDeviceRegistered();
2006
+ await this.publishAnswerOnWebexCrossClientState(false, {force: true});
2007
+ this.webexCrossClientService.teardown();
2008
+ this.wxAppTelephonyMercurySync.unsubscribe();
2009
+ await this.releaseWxAppMercuryResources();
2010
+
2011
+ logWxAppSessionReadiness({
2012
+ enableWxBetterTogether: false,
2013
+ loginOption,
2014
+ wxAppHooksApplied: true,
2015
+ usersubPublished: false,
2016
+ mercurySubscribed: false,
2017
+ telephonyTaskType,
2018
+ skipReason: 'flag_disabled',
2019
+ });
2020
+
2021
+ this.metricsManager.trackEvent(
2022
+ METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED,
2023
+ {loginOption, enableWxBetterTogether: false, skipReason: 'flag_disabled'},
2024
+ ['operational', 'behavioral']
2025
+ );
2026
+ }
2027
+ } catch (error) {
2028
+ LoggerProxy.error(`Failed to initialize wxApp post-station-login: ${error}`, {
2029
+ module: CC_FILE,
2030
+ method: METHODS.STATION_LOGIN,
2031
+ });
2032
+
2033
+ if (flagEnabled) {
2034
+ const sessionInitFailureReason =
2035
+ wxAppInitStage === 'mercury' ? 'mercury_subscribe_failed' : 'publish_failed';
2036
+
2037
+ this.metricsManager.trackEvent(
2038
+ METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED,
2039
+ {
2040
+ loginOption,
2041
+ enableWxBetterTogether: true,
2042
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
2043
+ mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
2044
+ telephonyTaskType,
2045
+ skipReason: sessionInitFailureReason,
2046
+ error: error instanceof Error ? error.toString() : String(error),
2047
+ },
2048
+ ['operational', 'behavioral']
2049
+ );
2050
+
2051
+ logWxAppSessionReadiness({
2052
+ enableWxBetterTogether: true,
2053
+ loginOption,
2054
+ wxAppHooksApplied: false,
2055
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
2056
+ mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
2057
+ telephonyTaskType,
2058
+ skipReason: sessionInitFailureReason,
2059
+ });
2060
+
2061
+ if (publishedEnable) {
2062
+ await this.revertWxAppCrossClientPublish();
2063
+ } else {
2064
+ this.wxAppTelephonyMercurySync.unsubscribe();
2065
+ await this.releaseWxAppMercuryResources();
2066
+ }
2067
+ this.resetEnableWxBetterTogetherConfig();
2068
+ } else {
2069
+ this.scheduleForcedFalsePublishRetry();
2070
+ }
2071
+ }
2072
+ }
2073
+
2074
+ private clearWxAppFalsePublishRetryTimer(): void {
2075
+ if (this.wxAppFalsePublishRetryTimer) {
2076
+ clearTimeout(this.wxAppFalsePublishRetryTimer);
2077
+ this.wxAppFalsePublishRetryTimer = undefined;
2078
+ }
2079
+ }
2080
+
2081
+ private scheduleForcedFalsePublishRetry(retryAttempt = 0): void {
2082
+ this.scheduleFalsePublishRetry(retryAttempt, {requireDisabled: true});
2083
+ }
2084
+
2085
+ /**
2086
+ * Retries compensating false publish after rollback failure, regardless of enabled flag.
2087
+ * @private
2088
+ */
2089
+ private scheduleCompensatingFalsePublishRetry(retryAttempt = 0): void {
2090
+ this.scheduleFalsePublishRetry(retryAttempt);
2091
+ }
2092
+
2093
+ private scheduleFalsePublishRetry(
2094
+ retryAttempt = 0,
2095
+ options: {requireDisabled?: boolean} = {}
2096
+ ): void {
2097
+ if (retryAttempt >= ContactCenter.WXAPP_FALSE_PUBLISH_MAX_RETRIES) {
2098
+ return;
2099
+ }
2100
+
2101
+ if (options?.requireDisabled && this.isWxBetterTogetherEnabled()) {
2102
+ return;
2103
+ }
2104
+
2105
+ this.clearWxAppFalsePublishRetryTimer();
2106
+
2107
+ this.wxAppFalsePublishRetryTimer = setTimeout(async () => {
2108
+ this.wxAppFalsePublishRetryTimer = undefined;
2109
+
2110
+ if (options?.requireDisabled && this.isWxBetterTogetherEnabled()) {
2111
+ return;
2112
+ }
2113
+
2114
+ if (
2115
+ !options?.requireDisabled &&
2116
+ this.isWxBetterTogetherEnabled() &&
2117
+ this.webexCrossClientService.isAnswerCallsStateActive()
2118
+ ) {
2119
+ return;
2120
+ }
2121
+
2122
+ try {
2123
+ await this.ensureWxAppDeviceRegistered();
2124
+ await this.publishAnswerOnWebexCrossClientState(false, {force: true});
2125
+ this.webexCrossClientService.teardown();
2126
+ this.wxAppTelephonyMercurySync.unsubscribe();
2127
+ await this.releaseWxAppMercuryResources();
2128
+ } catch (retryError) {
2129
+ LoggerProxy.error(
2130
+ `Failed to retry forced answer-calls-on-wxcc false publish: ${retryError}`,
2131
+ {
2132
+ module: CC_FILE,
2133
+ method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
2134
+ }
2135
+ );
2136
+ this.scheduleFalsePublishRetry(retryAttempt + 1, options);
2137
+ }
2138
+ }, ContactCenter.WXAPP_FALSE_PUBLISH_RETRY_DELAY_MS);
2139
+ }
2140
+
2141
+ /**
2142
+ * Best-effort rollback when usersub true was published but wxApp setup did not complete.
2143
+ * @private
2144
+ */
2145
+ private async revertWxAppCrossClientPublish(): Promise<void> {
2146
+ try {
2147
+ await this.publishAnswerOnWebexCrossClientState(false, {force: true});
2148
+ } catch (error) {
2149
+ LoggerProxy.error(
2150
+ `Failed to publish compensating answer-calls-on-wxcc false during wxApp rollback: ${error}`,
2151
+ {
2152
+ module: CC_FILE,
2153
+ method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
2154
+ }
2155
+ );
2156
+ this.scheduleCompensatingFalsePublishRetry();
2157
+ }
2158
+
2159
+ this.webexCrossClientService.teardown();
2160
+ this.wxAppTelephonyMercurySync.unsubscribe();
2161
+ await this.releaseWxAppMercuryResources();
2162
+ }
2163
+
2164
+ private async ensureWxAppDeviceRegistered(): Promise<void> {
2165
+ const device = this.$webex.internal.device;
2166
+
2167
+ if (device && !device.registered && device.register) {
2168
+ await device.register();
2169
+ this.wxAppDeviceRegisteredByCc = true;
2170
+ LoggerProxy.log('WxApp: device registered for cross-client publish', {
2171
+ module: CC_FILE,
2172
+ method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
2173
+ });
2174
+ }
2175
+ }
2176
+
2177
+ private async ensureWxAppMercuryConnected(): Promise<void> {
2178
+ const mercury = this.$webex.internal.mercury;
2179
+
2180
+ await this.ensureWxAppDeviceRegistered();
2181
+
2182
+ if (mercury && !mercury.connected) {
2183
+ await mercury.connect();
2184
+ this.wxAppMercuryConnectedByCc = true;
2185
+ LoggerProxy.log('WxApp mute sync: mercury connected', {
2186
+ module: CC_FILE,
2187
+ method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
2188
+ });
2189
+ }
2190
+ }
2191
+
2192
+ /**
2193
+ * Disconnects Mercury and unregisters the device when wxApp mute sync opened them.
2194
+ * @private
2195
+ */
2196
+ private async releaseWxAppMercuryResources(): Promise<void> {
2197
+ const mercury = this.$webex.internal.mercury;
2198
+ const device = this.$webex.internal.device;
2199
+
2200
+ if (this.wxAppMercuryConnectedByCc && mercury?.connected) {
2201
+ try {
2202
+ await mercury.disconnect();
2203
+ this.wxAppMercuryConnectedByCc = false;
2204
+ LoggerProxy.log('WxApp mute sync: mercury disconnected', {
2205
+ module: CC_FILE,
2206
+ method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
2207
+ });
2208
+ } catch (error) {
2209
+ LoggerProxy.error(`Failed to disconnect wxApp Mercury: ${error}`, {
2210
+ module: CC_FILE,
2211
+ method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
2212
+ });
2213
+ }
2214
+ }
2215
+
2216
+ if (this.wxAppDeviceRegisteredByCc && device?.registered && device.unregister) {
2217
+ try {
2218
+ // @ts-ignore
2219
+ await device.unregister();
2220
+ this.wxAppDeviceRegisteredByCc = false;
2221
+ LoggerProxy.log('WxApp mute sync: device unregistered', {
2222
+ module: CC_FILE,
2223
+ method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
2224
+ });
2225
+ } catch (error) {
2226
+ LoggerProxy.error(`Failed to unregister wxApp device: ${error}`, {
2227
+ module: CC_FILE,
2228
+ method: METHODS.ENSURE_WXAPP_MERCURY_CONNECTED,
2229
+ });
2230
+ }
2231
+ } else if (this.wxAppDeviceRegisteredByCc) {
2232
+ this.wxAppDeviceRegisteredByCc = false;
2233
+ }
2234
+ }
2235
+
2236
+ /**
2237
+ * Clears wxApp runtime state and feature-owned resources. Publish failures are logged;
2238
+ * optional rethrow for deregister when callers need to surface usersub errors.
2239
+ * @private
2240
+ */
2241
+ private async teardownWxAppLocalState(options?: {
2242
+ rethrowPublishError?: boolean;
2243
+ clearInitFlag?: boolean;
2244
+ }): Promise<{publishError?: unknown}> {
2245
+ this.clearWxAppFalsePublishRetryTimer();
2246
+ let publishError: unknown;
2247
+
2248
+ try {
2249
+ const shouldForceFalsePublish =
2250
+ this.isWxBetterTogetherEnabled() || this.webexCrossClientService.isAnswerCallsStateActive();
2251
+
2252
+ await this.publishAnswerOnWebexCrossClientState(false, {
2253
+ force: shouldForceFalsePublish,
2254
+ });
2255
+ } catch (error) {
2256
+ publishError = error;
2257
+ LoggerProxy.error(
2258
+ `Failed to publish answer-calls-on-wxcc false during wxApp teardown: ${error}`,
2259
+ {
2260
+ module: CC_FILE,
2261
+ method: METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC,
2262
+ }
2263
+ );
2264
+ }
2265
+
2266
+ this.webexCrossClientService.teardown();
2267
+ this.wxAppTelephonyMercurySync.unsubscribe();
2268
+ await this.releaseWxAppMercuryResources();
2269
+
2270
+ if (options?.clearInitFlag) {
2271
+ this.resetEnableWxBetterTogetherConfig();
2272
+ }
2273
+
2274
+ if (publishError) {
2275
+ this.scheduleCompensatingFalsePublishRetry();
2276
+ }
2277
+
2278
+ if (options?.rethrowPublishError && publishError) {
2279
+ throw publishError;
2280
+ }
2281
+
2282
+ return {publishError: publishError ?? undefined};
2283
+ }
2284
+
2285
+ private async ensureWxAppMercuryAndSubscribe(): Promise<void> {
2286
+ if (!this.isWxBetterTogetherEnabled()) {
2287
+ return;
2288
+ }
2289
+
2290
+ if (this.getCurrentStationLoginOption() === LoginOption.BROWSER) {
2291
+ return;
2292
+ }
2293
+
2294
+ const agentId = this.agentConfig?.agentId;
2295
+ if (!agentId) {
2296
+ LoggerProxy.error('Cannot subscribe wxApp mute sync: agentId unavailable', {
2297
+ module: CC_FILE,
2298
+ method: METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY,
2299
+ });
2300
+
2301
+ this.metricsManager.trackEvent(
2302
+ METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED,
2303
+ {error: 'agentId unavailable', mercurySubscribed: false},
2304
+ ['operational', 'behavioral']
2305
+ );
2306
+
2307
+ return;
2308
+ }
2309
+
2310
+ try {
2311
+ await this.ensureWxAppMercuryConnected();
2312
+ this.wxAppTelephonyMercurySync.subscribe(agentId, (callId, muted) => {
2313
+ this.taskManager.applyWxAppMuteStateFromSync(callId, muted);
2314
+ });
2315
+ } catch (error) {
2316
+ LoggerProxy.error(`Failed to ensure wxApp Mercury mute sync: ${error}`, {
2317
+ module: CC_FILE,
2318
+ method: METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY,
2319
+ });
2320
+ this.metricsManager.trackEvent(
2321
+ METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED,
2322
+ {
2323
+ error: error instanceof Error ? error.toString() : String(error),
2324
+ mercurySubscribed: false,
2325
+ },
2326
+ ['operational', 'behavioral']
2327
+ );
2328
+ this.wxAppTelephonyMercurySync.unsubscribe();
2329
+ await this.releaseWxAppMercuryResources();
2330
+ throw error;
2331
+ }
2332
+ }
2333
+
2334
+ private async publishAnswerOnWebexCrossClientState(
2335
+ enable: boolean,
2336
+ options?: {force?: boolean}
2337
+ ): Promise<void> {
2338
+ if (enable && !this.isWxBetterTogetherEnabled()) {
2339
+ return;
2340
+ }
2341
+
2342
+ if (!enable && !options?.force && !this.webexCrossClientService.isAnswerCallsStateActive()) {
2343
+ return;
2344
+ }
2345
+
2346
+ const userId = this.$webex.internal.device?.userId;
2347
+ if (!userId) {
2348
+ if (enable && this.isWxBetterTogetherEnabled()) {
2349
+ this.metricsManager.trackEvent(
2350
+ METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED,
2351
+ {
2352
+ enableWxBetterTogether: true,
2353
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
2354
+ skipReason: 'user_id_unavailable',
2355
+ error: 'User ID is unavailable for cross-client publish',
2356
+ },
2357
+ ['operational', 'behavioral']
2358
+ );
2359
+ }
2360
+
2361
+ return;
2362
+ }
2363
+
2364
+ await this.webexCrossClientService.setManageWebexCallingInWxcc(enable, {
2365
+ userId,
2366
+ trackPublishMetrics: true,
2367
+ });
2368
+
2369
+ if (enable) {
2370
+ this.clearWxAppFalsePublishRetryTimer();
2371
+ }
2372
+ }
2373
+
1380
2374
  /**
1381
2375
  * Initializes event listeners for the Contact Center service
1382
2376
  * Sets up handlers for connection state changes and other core events
@@ -1436,6 +2430,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1436
2430
 
1437
2431
  try {
1438
2432
  const reLoginResponse = await this.services.agent.reload();
2433
+ this.updateWellnessSession(reLoginResponse.data.agentSessionId);
2434
+
1439
2435
  const {
1440
2436
  agentId,
1441
2437
  lastStateChangeReason,
@@ -1481,6 +2477,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1481
2477
  this.agentConfig.lastStateAuxCodeId = auxCodeId;
1482
2478
  this.agentConfig.isAgentLoggedIn = true;
1483
2479
 
2480
+ await this.ensureWxAppPostStationLogin();
2481
+
1484
2482
  LoggerProxy.log(
1485
2483
  `Silent relogin process completed successfully with login Option: ${reLoginResponse.data.deviceType} teamId: ${reLoginResponse.data.teamId}`,
1486
2484
  {
@@ -1517,6 +2515,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
1517
2515
  */
1518
2516
  private async handleDeviceType(deviceType: LoginOption, dn: string): Promise<void> {
1519
2517
  this.webCallingService.setLoginOption(deviceType);
2518
+ this.webCallingService.setBrowserVoiceRequired(this.isBrowserVoiceRequired(deviceType));
1520
2519
  this.agentConfig.deviceType = deviceType;
1521
2520
  switch (deviceType) {
1522
2521
  case LoginOption.BROWSER:
@@ -2199,8 +3198,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
2199
3198
  }
2200
3199
 
2201
3200
  /**
2202
- * Returns paginated entry points for the organization.
2203
- * Thin wrapper around internal EntryPoint instance.
3201
+ * Returns paginated entry points using the EntryPoint service defaults.
3202
+ * Existing request parameters can override those defaults.
2204
3203
  * @public
2205
3204
  */
2206
3205
  public async getEntryPoints(
@@ -2210,8 +3209,8 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
2210
3209
  }
2211
3210
 
2212
3211
  /**
2213
- * Returns paginated contact service queues for the organization.
2214
- * Thin wrapper around internal Queue instance.
3212
+ * Returns paginated contact service queues using the Queue service defaults.
3213
+ * Existing request parameters can override those defaults.
2215
3214
  * @public
2216
3215
  */
2217
3216
  public async getQueues(