@webex/contact-center 3.12.0 → 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 (337) hide show
  1. package/.sdd/manifest.json +887 -0
  2. package/AGENTS.md +94 -0
  3. package/ai-docs/ARCHITECTURE.md +168 -0
  4. package/ai-docs/CONTRACTS.md +64 -0
  5. package/ai-docs/GETTING_STARTED.md +168 -0
  6. package/ai-docs/GLOSSARY.md +43 -0
  7. package/ai-docs/README.md +138 -0
  8. package/ai-docs/REVIEW_CHECKLIST.md +41 -0
  9. package/ai-docs/RULES.md +444 -0
  10. package/ai-docs/SECURITY.md +52 -0
  11. package/ai-docs/SERVICE_STATE.md +52 -0
  12. package/ai-docs/SPEC_INDEX.md +65 -0
  13. package/ai-docs/adr/0001-spec-source-policy.md +55 -0
  14. package/ai-docs/adr/README.md +8 -0
  15. package/ai-docs/adr/_adr-template.md +31 -0
  16. package/ai-docs/contact-center-spec.md +388 -0
  17. package/ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md +362 -0
  18. package/ai-docs/features/contact-owner-change-refactor.md +78 -0
  19. package/ai-docs/features/generated-spec-conformance-fidelity-remediation/spec/feature-spec.md +117 -0
  20. package/ai-docs/features/residual-warning-coverage-completion/spec/feature-spec.md +203 -0
  21. package/ai-docs/features/validator-code-fidelity-drift-fix/spec/feature-spec.md +315 -0
  22. package/ai-docs/patterns/event-driven-patterns.md +485 -0
  23. package/ai-docs/patterns/testing-patterns.md +480 -0
  24. package/ai-docs/patterns/typescript-patterns.md +365 -0
  25. package/ai-docs/templates/README.md +102 -0
  26. package/ai-docs/templates/documentation/create-agents-md.md +240 -0
  27. package/ai-docs/templates/documentation/create-architecture-md.md +295 -0
  28. package/ai-docs/templates/existing-service/bug-fix.md +254 -0
  29. package/ai-docs/templates/existing-service/feature-enhancement.md +450 -0
  30. package/ai-docs/templates/new-method/00-master.md +80 -0
  31. package/ai-docs/templates/new-method/01-requirements.md +232 -0
  32. package/ai-docs/templates/new-method/02-implementation.md +295 -0
  33. package/ai-docs/templates/new-method/03-tests.md +201 -0
  34. package/ai-docs/templates/new-method/04-validation.md +141 -0
  35. package/ai-docs/templates/new-service/00-master.md +109 -0
  36. package/ai-docs/templates/new-service/01-pre-questions.md +159 -0
  37. package/ai-docs/templates/new-service/02-code-generation.md +346 -0
  38. package/ai-docs/templates/new-service/03-integration.md +178 -0
  39. package/ai-docs/templates/new-service/04-test-generation.md +205 -0
  40. package/ai-docs/templates/new-service/05-validation.md +145 -0
  41. package/dist/cc.js +1102 -47
  42. package/dist/cc.js.map +1 -1
  43. package/dist/config.js +13 -0
  44. package/dist/config.js.map +1 -1
  45. package/dist/constants.js +46 -3
  46. package/dist/constants.js.map +1 -1
  47. package/dist/index.js +86 -17
  48. package/dist/index.js.map +1 -1
  49. package/dist/metrics/MetricsManager.js +16 -0
  50. package/dist/metrics/MetricsManager.js.map +1 -1
  51. package/dist/metrics/behavioral-events.js +211 -0
  52. package/dist/metrics/behavioral-events.js.map +1 -1
  53. package/dist/metrics/constants.js +58 -4
  54. package/dist/metrics/constants.js.map +1 -1
  55. package/dist/services/AddressBook.js +18 -15
  56. package/dist/services/AddressBook.js.map +1 -1
  57. package/dist/services/AnswerCallOnWebexService.js +202 -0
  58. package/dist/services/AnswerCallOnWebexService.js.map +1 -0
  59. package/dist/services/ApiAiAssistant.js +369 -14
  60. package/dist/services/ApiAiAssistant.js.map +1 -1
  61. package/dist/services/EntryPoint.js +46 -68
  62. package/dist/services/EntryPoint.js.map +1 -1
  63. package/dist/services/Queue.js +27 -22
  64. package/dist/services/Queue.js.map +1 -1
  65. package/dist/services/UserPreference.js +427 -0
  66. package/dist/services/UserPreference.js.map +1 -0
  67. package/dist/services/WebCallingService.js +287 -37
  68. package/dist/services/WebCallingService.js.map +1 -1
  69. package/dist/services/WebexCrossClientService.js +225 -0
  70. package/dist/services/WebexCrossClientService.js.map +1 -0
  71. package/dist/services/WxAppTelephonyMercurySync.js +111 -0
  72. package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
  73. package/dist/services/config/Util.js +48 -48
  74. package/dist/services/config/Util.js.map +1 -1
  75. package/dist/services/config/constants.js +57 -79
  76. package/dist/services/config/constants.js.map +1 -1
  77. package/dist/services/config/index.js +100 -226
  78. package/dist/services/config/index.js.map +1 -1
  79. package/dist/services/config/types.js +100 -40
  80. package/dist/services/config/types.js.map +1 -1
  81. package/dist/services/constants.js +19 -1
  82. package/dist/services/constants.js.map +1 -1
  83. package/dist/services/core/Err.js.map +1 -1
  84. package/dist/services/core/Utils.js +131 -32
  85. package/dist/services/core/Utils.js.map +1 -1
  86. package/dist/services/core/WebexRequest.js +6 -2
  87. package/dist/services/core/WebexRequest.js.map +1 -1
  88. package/dist/services/core/aqm-reqs.js +17 -11
  89. package/dist/services/core/aqm-reqs.js.map +1 -1
  90. package/dist/services/core/constants.js +9 -1
  91. package/dist/services/core/constants.js.map +1 -1
  92. package/dist/services/core/types.js.map +1 -1
  93. package/dist/services/core/websocket/WebSocketManager.js +26 -6
  94. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  95. package/dist/services/core/websocket/connection-service.js +3 -1
  96. package/dist/services/core/websocket/connection-service.js.map +1 -1
  97. package/dist/services/core/websocket/types.js.map +1 -1
  98. package/dist/services/index.js +6 -0
  99. package/dist/services/index.js.map +1 -1
  100. package/dist/services/task/Task.js +955 -0
  101. package/dist/services/task/Task.js.map +1 -0
  102. package/dist/services/task/TaskFactory.js +50 -0
  103. package/dist/services/task/TaskFactory.js.map +1 -0
  104. package/dist/services/task/TaskManager.js +1275 -504
  105. package/dist/services/task/TaskManager.js.map +1 -1
  106. package/dist/services/task/TaskUtils.js +221 -27
  107. package/dist/services/task/TaskUtils.js.map +1 -1
  108. package/dist/services/task/WebexCallingUtils.js +70 -0
  109. package/dist/services/task/WebexCallingUtils.js.map +1 -0
  110. package/dist/services/task/constants.js +22 -2
  111. package/dist/services/task/constants.js.map +1 -1
  112. package/dist/services/task/contact.js +29 -0
  113. package/dist/services/task/contact.js.map +1 -1
  114. package/dist/services/task/dialer.js +78 -0
  115. package/dist/services/task/dialer.js.map +1 -1
  116. package/dist/services/task/digital/Digital.js +78 -0
  117. package/dist/services/task/digital/Digital.js.map +1 -0
  118. package/dist/services/task/state-machine/TaskStateMachine.js +982 -0
  119. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -0
  120. package/dist/services/task/state-machine/actions.js +572 -0
  121. package/dist/services/task/state-machine/actions.js.map +1 -0
  122. package/dist/services/task/state-machine/constants.js +161 -0
  123. package/dist/services/task/state-machine/constants.js.map +1 -0
  124. package/dist/services/task/state-machine/guards.js +379 -0
  125. package/dist/services/task/state-machine/guards.js.map +1 -0
  126. package/dist/services/task/state-machine/index.js +53 -0
  127. package/dist/services/task/state-machine/index.js.map +1 -0
  128. package/dist/services/task/state-machine/types.js +54 -0
  129. package/dist/services/task/state-machine/types.js.map +1 -0
  130. package/dist/services/task/state-machine/uiControlsComputer.js +703 -0
  131. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -0
  132. package/dist/services/task/taskDataNormalizer.js +99 -0
  133. package/dist/services/task/taskDataNormalizer.js.map +1 -0
  134. package/dist/services/task/types.js +259 -5
  135. package/dist/services/task/types.js.map +1 -1
  136. package/dist/services/task/voice/Voice.js +1504 -0
  137. package/dist/services/task/voice/Voice.js.map +1 -0
  138. package/dist/services/task/voice/WebRTC.js +152 -0
  139. package/dist/services/task/voice/WebRTC.js.map +1 -0
  140. package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
  141. package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
  142. package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
  143. package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
  144. package/dist/services/wxAppDiagnosticLogging.js +159 -0
  145. package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
  146. package/dist/services/wxAppTelephonyUtils.js +19 -0
  147. package/dist/services/wxAppTelephonyUtils.js.map +1 -0
  148. package/dist/types/cc.d.ts +222 -10
  149. package/dist/types/config.d.ts +13 -0
  150. package/dist/types/constants.d.ts +40 -1
  151. package/dist/types/index.d.ts +58 -22
  152. package/dist/types/metrics/MetricsManager.d.ts +6 -0
  153. package/dist/types/metrics/constants.d.ts +52 -1
  154. package/dist/types/services/AddressBook.d.ts +2 -1
  155. package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
  156. package/dist/types/services/ApiAiAssistant.d.ts +67 -5
  157. package/dist/types/services/EntryPoint.d.ts +7 -5
  158. package/dist/types/services/Queue.d.ts +5 -3
  159. package/dist/types/services/UserPreference.d.ts +118 -0
  160. package/dist/types/services/WebexCrossClientService.d.ts +32 -0
  161. package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
  162. package/dist/types/services/config/Util.d.ts +4 -8
  163. package/dist/types/services/config/constants.d.ts +49 -76
  164. package/dist/types/services/config/index.d.ts +16 -64
  165. package/dist/types/services/config/types.d.ts +252 -114
  166. package/dist/types/services/constants.d.ts +16 -0
  167. package/dist/types/services/core/Err.d.ts +6 -0
  168. package/dist/types/services/core/Utils.d.ts +43 -13
  169. package/dist/types/services/core/WebexRequest.d.ts +1 -0
  170. package/dist/types/services/core/constants.d.ts +7 -0
  171. package/dist/types/services/core/types.d.ts +2 -0
  172. package/dist/types/services/core/websocket/WebSocketManager.d.ts +2 -0
  173. package/dist/types/services/core/websocket/types.d.ts +1 -1
  174. package/dist/types/services/index.d.ts +2 -0
  175. package/dist/types/services/task/Task.d.ts +186 -0
  176. package/dist/types/services/task/TaskFactory.d.ts +14 -0
  177. package/dist/types/services/task/TaskUtils.d.ts +54 -2
  178. package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
  179. package/dist/types/services/task/constants.d.ts +20 -0
  180. package/dist/types/services/task/contact.d.ts +4 -0
  181. package/dist/types/services/task/dialer.d.ts +30 -0
  182. package/dist/types/services/task/digital/Digital.d.ts +23 -0
  183. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +1442 -0
  184. package/dist/types/services/task/state-machine/actions.d.ts +10 -0
  185. package/dist/types/services/task/state-machine/constants.d.ts +107 -0
  186. package/dist/types/services/task/state-machine/guards.d.ts +103 -0
  187. package/dist/types/services/task/state-machine/index.d.ts +13 -0
  188. package/dist/types/services/task/state-machine/types.d.ts +277 -0
  189. package/dist/types/services/task/state-machine/uiControlsComputer.d.ts +9 -0
  190. package/dist/types/services/task/taskDataNormalizer.d.ts +10 -0
  191. package/dist/types/services/task/types.d.ts +790 -66
  192. package/dist/types/services/task/voice/Voice.d.ts +241 -0
  193. package/dist/types/services/task/voice/WebRTC.d.ts +54 -0
  194. package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
  195. package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
  196. package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
  197. package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
  198. package/dist/types/types.d.ts +258 -11
  199. package/dist/types/utils/PageCache.d.ts +20 -3
  200. package/dist/types/webex.d.ts +1 -0
  201. package/dist/types.js +204 -6
  202. package/dist/types.js.map +1 -1
  203. package/dist/utils/PageCache.js +19 -5
  204. package/dist/utils/PageCache.js.map +1 -1
  205. package/dist/webex.js +22 -2
  206. package/dist/webex.js.map +1 -1
  207. package/package.json +16 -12
  208. package/src/cc.ts +1439 -105
  209. package/src/config.ts +13 -0
  210. package/src/constants.ts +53 -1
  211. package/src/index.ts +72 -16
  212. package/src/metrics/MetricsManager.ts +16 -0
  213. package/src/metrics/ai-docs/AGENTS.md +350 -0
  214. package/src/metrics/ai-docs/ARCHITECTURE.md +338 -0
  215. package/src/metrics/ai-docs/metrics-spec.md +971 -0
  216. package/src/metrics/behavioral-events.ts +218 -0
  217. package/src/metrics/constants.ts +63 -4
  218. package/src/services/AddressBook.ts +17 -6
  219. package/src/services/AnswerCallOnWebexService.ts +239 -0
  220. package/src/services/ApiAiAssistant.ts +494 -15
  221. package/src/services/EntryPoint.ts +59 -60
  222. package/src/services/Queue.ts +29 -12
  223. package/src/services/UserPreference.ts +509 -0
  224. package/src/services/WebCallingService.ts +362 -40
  225. package/src/services/WebexCrossClientService.ts +298 -0
  226. package/src/services/WxAppTelephonyMercurySync.ts +142 -0
  227. package/src/services/agent/ai-docs/AGENTS.md +240 -0
  228. package/src/services/agent/ai-docs/ARCHITECTURE.md +304 -0
  229. package/src/services/agent/ai-docs/agent-spec.md +505 -0
  230. package/src/services/ai-docs/AGENTS.md +386 -0
  231. package/src/services/ai-docs/services-spec.md +512 -0
  232. package/src/services/config/Util.ts +54 -84
  233. package/src/services/config/ai-docs/AGENTS.md +250 -0
  234. package/src/services/config/ai-docs/ARCHITECTURE.md +413 -0
  235. package/src/services/config/ai-docs/config-spec.md +669 -0
  236. package/src/services/config/constants.ts +64 -86
  237. package/src/services/config/index.ts +116 -277
  238. package/src/services/config/types.ts +238 -125
  239. package/src/services/constants.ts +18 -0
  240. package/src/services/core/Err.ts +3 -0
  241. package/src/services/core/Utils.ts +151 -37
  242. package/src/services/core/WebexRequest.ts +3 -1
  243. package/src/services/core/ai-docs/AGENTS.md +381 -0
  244. package/src/services/core/ai-docs/ARCHITECTURE.md +698 -0
  245. package/src/services/core/ai-docs/core-spec.md +797 -0
  246. package/src/services/core/aqm-reqs.ts +18 -12
  247. package/src/services/core/constants.ts +8 -0
  248. package/src/services/core/types.ts +33 -1
  249. package/src/services/core/websocket/WebSocketManager.ts +37 -8
  250. package/src/services/core/websocket/connection-service.ts +5 -1
  251. package/src/services/core/websocket/types.ts +1 -1
  252. package/src/services/index.ts +4 -0
  253. package/src/services/task/Task.ts +1211 -0
  254. package/src/services/task/TaskFactory.ts +82 -0
  255. package/src/services/task/TaskManager.ts +1551 -584
  256. package/src/services/task/TaskUtils.ts +316 -25
  257. package/src/services/task/WebexCallingUtils.ts +136 -0
  258. package/src/services/task/ai-docs/AGENTS.md +457 -0
  259. package/src/services/task/ai-docs/ARCHITECTURE.md +595 -0
  260. package/src/services/task/ai-docs/task-spec.md +1501 -0
  261. package/src/services/task/constants.ts +21 -0
  262. package/src/services/task/contact.ts +30 -0
  263. package/src/services/task/dialer.ts +80 -0
  264. package/src/services/task/digital/Digital.ts +102 -0
  265. package/src/services/task/state-machine/TaskStateMachine.ts +1320 -0
  266. package/src/services/task/state-machine/actions.ts +741 -0
  267. package/src/services/task/state-machine/ai-docs/AGENTS.md +460 -0
  268. package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +1156 -0
  269. package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +2247 -0
  270. package/src/services/task/state-machine/constants.ts +172 -0
  271. package/src/services/task/state-machine/guards.ts +442 -0
  272. package/src/services/task/state-machine/index.ts +28 -0
  273. package/src/services/task/state-machine/types.ts +258 -0
  274. package/src/services/task/state-machine/uiControlsComputer.ts +1135 -0
  275. package/src/services/task/taskDataNormalizer.ts +137 -0
  276. package/src/services/task/types.ts +974 -70
  277. package/src/services/task/voice/Voice.ts +1878 -0
  278. package/src/services/task/voice/WebRTC.ts +194 -0
  279. package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
  280. package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
  281. package/src/services/wxAppDiagnosticLogging.ts +286 -0
  282. package/src/services/wxAppTelephonyUtils.ts +14 -0
  283. package/src/types.ts +323 -13
  284. package/src/utils/AGENTS.md +289 -0
  285. package/src/utils/PageCache.ts +38 -5
  286. package/src/utils/ai-docs/utils-spec.md +391 -0
  287. package/src/webex.js +10 -0
  288. package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
  289. package/test/unit/spec/cc.ts +4046 -181
  290. package/test/unit/spec/index.ts +891 -0
  291. package/test/unit/spec/logger-proxy.ts +70 -0
  292. package/test/unit/spec/metrics/MetricsManager.ts +25 -0
  293. package/test/unit/spec/metrics/behavioral-events.ts +60 -0
  294. package/test/unit/spec/services/AddressBook.ts +37 -6
  295. package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
  296. package/test/unit/spec/services/ApiAiAssistant.ts +442 -23
  297. package/test/unit/spec/services/EntryPoint.ts +87 -40
  298. package/test/unit/spec/services/Queue.ts +123 -12
  299. package/test/unit/spec/services/UserPreference.ts +401 -0
  300. package/test/unit/spec/services/WebCallingService.ts +484 -49
  301. package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
  302. package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
  303. package/test/unit/spec/services/config/Util.ts +501 -0
  304. package/test/unit/spec/services/config/index.ts +318 -548
  305. package/test/unit/spec/services/core/Utils.ts +447 -8
  306. package/test/unit/spec/services/core/WebexRequest.ts +8 -7
  307. package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
  308. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +132 -56
  309. package/test/unit/spec/services/core/websocket/connection-service.ts +3 -1
  310. package/test/unit/spec/services/task/AutoWrapup.ts +63 -0
  311. package/test/unit/spec/services/task/Task.ts +2723 -0
  312. package/test/unit/spec/services/task/TaskFactory.ts +116 -0
  313. package/test/unit/spec/services/task/TaskManager.ts +4800 -1586
  314. package/test/unit/spec/services/task/TaskUtils.ts +307 -0
  315. package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
  316. package/test/unit/spec/services/task/contact.ts +33 -0
  317. package/test/unit/spec/services/task/dialer.ts +190 -0
  318. package/test/unit/spec/services/task/digital/Digital.ts +105 -0
  319. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +4060 -0
  320. package/test/unit/spec/services/task/state-machine/guards.ts +839 -0
  321. package/test/unit/spec/services/task/state-machine/types.ts +18 -0
  322. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +3101 -0
  323. package/test/unit/spec/services/task/taskTestUtils.ts +87 -0
  324. package/test/unit/spec/services/task/voice/Voice.ts +2355 -0
  325. package/test/unit/spec/services/task/voice/WebRTC.ts +235 -0
  326. package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
  327. package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
  328. package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
  329. package/test/unit/spec/wellnessSampleUtils.ts +288 -0
  330. package/typedoc.md +1 -1
  331. package/umd/contact-center.min.js +2 -2
  332. package/umd/contact-center.min.js.map +1 -1
  333. package/dist/services/task/index.js +0 -1525
  334. package/dist/services/task/index.js.map +0 -1
  335. package/dist/types/services/task/index.d.ts +0 -650
  336. package/src/services/task/index.ts +0 -1801
  337. package/test/unit/spec/services/task/index.ts +0 -2184
package/dist/cc.js CHANGED
@@ -19,6 +19,10 @@ var _Utils = require("./services/core/Utils");
19
19
  var _types3 = require("./services/config/types");
20
20
  var _TaskManager = _interopRequireDefault(require("./services/task/TaskManager"));
21
21
  var _WebCallingService = _interopRequireDefault(require("./services/WebCallingService"));
22
+ var _AnswerCallOnWebexService = _interopRequireDefault(require("./services/AnswerCallOnWebexService"));
23
+ var _WebexCrossClientService = _interopRequireDefault(require("./services/WebexCrossClientService"));
24
+ var _WxAppTelephonyMercurySync = _interopRequireDefault(require("./services/WxAppTelephonyMercurySync"));
25
+ var _wxAppDiagnosticLogging = require("./services/wxAppDiagnosticLogging");
22
26
  var _types4 = require("./services/task/types");
23
27
  var _MetricsManager = _interopRequireDefault(require("./metrics/MetricsManager"));
24
28
  var _constants4 = require("./metrics/constants");
@@ -26,6 +30,7 @@ var _EntryPoint = require("./services/EntryPoint");
26
30
  var _AddressBook = require("./services/AddressBook");
27
31
  var _Queue = require("./services/Queue");
28
32
  var _ApiAiAssistant = require("./services/ApiAiAssistant");
33
+ var _UserPreference = require("./services/UserPreference");
29
34
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
30
35
  /**
31
36
  * @module CCPlugin
@@ -35,6 +40,13 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
35
40
  * with Webex Contact Center features through the WebexSDK.
36
41
  */
37
42
 
43
+ /**
44
+ * Typed allow-list of server-controlled websocket event names this SDK re-emits verbatim.
45
+ * Guards against emitting an arbitrary/unknown `data.type` supplied by the websocket payload.
46
+ * @ignore
47
+ */
48
+ const CC_EVENT_ALLOW_LIST = new Set(Object.values(_types3.CC_EVENTS));
49
+
38
50
  /**
39
51
  * The main Contact Center plugin class that enables integration with Webex Contact Center.
40
52
  *
@@ -118,7 +130,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
118
130
  *
119
131
  * // Login with browser-based calling
120
132
  * await cc.stationLogin({
121
- * teamId: profile.teams[0].teamId,
133
+ * teamId: profile.teams[0].id,
122
134
  * loginOption: 'BROWSER'
123
135
  * });
124
136
  *
@@ -184,6 +196,29 @@ class ContactCenter extends _webexCore.WebexPlugin {
184
196
  * @private
185
197
  */
186
198
 
199
+ /**
200
+ * REST telephony for wxApp thick-client answer (WXCC-6026)
201
+ * @private
202
+ */
203
+
204
+ /**
205
+ * usersub cross-client state for Webex App toast suppression
206
+ * @private
207
+ */
208
+
209
+ /**
210
+ * Mercury telephony mute sync for wxApp thick-client answer
211
+ * @private
212
+ */
213
+
214
+ /** True when wxApp mute sync opened Mercury (Extension/DN-only profiles). */
215
+ wxAppMercuryConnectedByCc = false;
216
+
217
+ /** True when wxApp mute sync registered the Webex device. */
218
+ wxAppDeviceRegisteredByCc = false;
219
+ static WXAPP_FALSE_PUBLISH_RETRY_DELAY_MS = 30_000;
220
+ static WXAPP_FALSE_PUBLISH_MAX_RETRIES = 3;
221
+
187
222
  /**
188
223
  * Core service managers for Contact Center operations
189
224
  * Includes agent, connection, and configuration services
@@ -212,6 +247,16 @@ class ContactCenter extends _webexCore.WebexPlugin {
212
247
  * @private
213
248
  */
214
249
 
250
+ /** Current login/relogin session used for agent-scoped wellness validation. */
251
+
252
+ /** Registered-session cache for the system WellbeingBreak idle code. */
253
+
254
+ /** Registration generation that owns the wellness idle-code cache and in-flight lookups. */
255
+ wellnessRegistrationGeneration = 0;
256
+ updateWellnessSession(agentSessionId) {
257
+ this.currentAgentSessionId = agentSessionId;
258
+ }
259
+
215
260
  /**
216
261
  * API instance for managing Webex Contact Center entry points
217
262
  * Provides functionality to fetch entry points with caching support
@@ -274,6 +319,36 @@ class ContactCenter extends _webexCore.WebexPlugin {
274
319
  * ```
275
320
  */
276
321
 
322
+ /**
323
+ * API instance for managing Webex Contact Center user preferences
324
+ * Provides functionality to get, create, update, and delete user preferences
325
+ * @type {UserPreference}
326
+ * @public
327
+ * @example
328
+ * ```typescript
329
+ * const cc = webex.cc;
330
+ * await cc.register();
331
+ * await cc.stationLogin({ teamId: 'team123', loginOption: 'BROWSER' });
332
+ *
333
+ * // Get user preferences for current user
334
+ * const preferences = await cc.userPreference.getUserPreference();
335
+ *
336
+ * // Create new user preferences
337
+ * const newPrefs = await cc.userPreference.createUserPreference({
338
+ * userId: 'user123',
339
+ * preferences: { e911Reminder: true }
340
+ * });
341
+ *
342
+ * // Update user preferences
343
+ * const updatedPrefs = await cc.userPreference.updateUserPreference('user123', {
344
+ * preferences: { e911Reminder: false }
345
+ * });
346
+ *
347
+ * // Delete user preferences
348
+ * await cc.userPreference.deleteUserPreference('user123');
349
+ * ```
350
+ */
351
+
277
352
  /**
278
353
  * API instance for AI Assistant operations such as transcript controls.
279
354
  * @type {ApiAIAssistant}
@@ -301,6 +376,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
301
376
  this.$webex.once(_constants.READY, () => {
302
377
  // @ts-ignore
303
378
  this.$config = this.config;
379
+ this.validatePluginConfig();
304
380
 
305
381
  /**
306
382
  * This is used for handling the async requests by sending webex.request and wait for corresponding websocket event.
@@ -312,13 +388,21 @@ class ContactCenter extends _webexCore.WebexPlugin {
312
388
  webex: this.$webex,
313
389
  connectionConfig: this.getConnectionConfig()
314
390
  });
315
- this.services.webSocketManager.on('message', this.handleWebsocketMessage);
316
391
  this.webCallingService = new _WebCallingService.default(this.$webex);
317
- this.apiAIAssistant = new _ApiAiAssistant.ApiAIAssistant(this.$webex);
392
+ this.webCallingService.on(_types3.VOICE_CONNECTION_EVENTS.STATE_CHANGE, this.handleVoiceConnectionStateChange);
393
+ this.answerCallOnWebexService = new _AnswerCallOnWebexService.default(this.$webex);
394
+ this.webexCrossClientService = new _WebexCrossClientService.default(this.$webex);
395
+ this.wxAppTelephonyMercurySync = new _WxAppTelephonyMercurySync.default(this.$webex);
396
+ this.apiAIAssistant = new _ApiAiAssistant.ApiAIAssistant(this.$webex, () => ({
397
+ isWellnessBreakEnabled: this.agentConfig?.isWellnessBreakEnabled === true,
398
+ agentId: this.agentConfig?.agentId,
399
+ agentSessionId: this.currentAgentSessionId
400
+ }));
318
401
  this.metricsManager = _MetricsManager.default.getInstance({
319
402
  webex: this.$webex
320
403
  });
321
- this.taskManager = _TaskManager.default.getTaskManager(this.apiAIAssistant, this.services.contact, this.webCallingService, this.services.webSocketManager);
404
+ this.taskManager = _TaskManager.default.getTaskManager(this.apiAIAssistant, this.services.contact, this.webCallingService, this.services.webSocketManager, this.services.rtdWebSocketManager);
405
+ this.taskManager.setAnswerCallOnWebexService(this.answerCallOnWebexService);
322
406
  this.incomingTaskListener();
323
407
 
324
408
  // Initialize API instances
@@ -326,6 +410,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
326
410
  this.entryPoint = new _EntryPoint.EntryPoint(this.$webex);
327
411
  this.addressBook = new _AddressBook.AddressBook(this.$webex, () => this.agentConfig?.addressBookId);
328
412
  this.queue = new _Queue.Queue(this.$webex);
413
+ this.userPreference = new _UserPreference.UserPreference(this.$webex, () => this.agentConfig?.agentId);
329
414
  _loggerProxy.default.initialize(this.$webex.logger);
330
415
  });
331
416
  }
@@ -339,6 +424,11 @@ class ContactCenter extends _webexCore.WebexPlugin {
339
424
  // @ts-ignore
340
425
  this.trigger(_types4.TASK_EVENTS.TASK_INCOMING, task);
341
426
  };
427
+ handleVoiceConnectionStateChange = state => {
428
+ // WebexPlugin exposes `trigger` at runtime, though it is missing from its TypeScript types.
429
+ // @ts-ignore
430
+ this.trigger(_types3.VOICE_CONNECTION_EVENTS.STATE_CHANGE, state);
431
+ };
342
432
 
343
433
  /**
344
434
  * Handles task hydration events for updating task data
@@ -350,6 +440,16 @@ class ContactCenter extends _webexCore.WebexPlugin {
350
440
  this.trigger(_types4.TASK_EVENTS.TASK_HYDRATE, task);
351
441
  };
352
442
 
443
+ /**
444
+ * Handles multi-login hydrate events for SDK instances without Mobius registration
445
+ * @private
446
+ * @param {ITask} task The task object associated with the multi-login hydrate
447
+ */
448
+ handleTaskMultiLoginHydrate = task => {
449
+ // @ts-ignore
450
+ this.trigger(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, task);
451
+ };
452
+
353
453
  /**
354
454
  * Handles task merged events when tasks are combined eg: EPDN merge/transfer
355
455
  * @private
@@ -369,6 +469,84 @@ class ContactCenter extends _webexCore.WebexPlugin {
369
469
  // @ts-ignore
370
470
  this.trigger(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, task);
371
471
  };
472
+ trackInvalidWellnessEvent(reason) {
473
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.AI_ASSISTANT_WELLNESS_EVENT_INVALID, {
474
+ reason
475
+ }, ['operational']);
476
+ }
477
+ normalizeWellnessBreakEvent(payload) {
478
+ if (this.agentConfig?.isWellnessBreakEnabled !== true) {
479
+ this.trackInvalidWellnessEvent('wellness_disabled');
480
+ return null;
481
+ }
482
+ const notificationData = (0, _Utils.isRecord)(payload.data) ? payload.data : null;
483
+ const notificationDetails = notificationData && (0, _Utils.isRecord)(notificationData.notifDetails) ? notificationData.notifDetails : null;
484
+ const sessionData = notificationData && (0, _Utils.isRecord)(notificationData.data) ? notificationData.data : null;
485
+ const actionEvent = notificationDetails?.actionEvent;
486
+ if (payload.type !== _constants.WELLNESS_BREAK_HANDLER || notificationData?.notifType !== _constants.WELLNESS_BREAK_HANDLER || typeof actionEvent !== 'string') {
487
+ this.trackInvalidWellnessEvent('malformed_wellness_event');
488
+ return null;
489
+ }
490
+ if (!Object.values(_types.WELLNESS_BREAK_NOTIFICATION_ACTIONS).includes(actionEvent)) {
491
+ this.trackInvalidWellnessEvent('unknown_wellness_action');
492
+ return null;
493
+ }
494
+ const agentId = notificationData.agentId;
495
+ const eventOrgId = notificationData.orgId;
496
+ const sessionOrgId = sessionData?.orgId;
497
+ const envelopeOrgId = payload.orgId;
498
+ const agentSessionId = sessionData?.agentSessionId;
499
+ const currentOrgId = this.$webex.credentials.getOrgId();
500
+ if (typeof agentId !== 'string' || typeof eventOrgId !== 'string' || typeof sessionOrgId !== 'string' || typeof envelopeOrgId !== 'string' || typeof agentSessionId !== 'string' || !agentId || !eventOrgId || !sessionOrgId || !envelopeOrgId || !agentSessionId) {
501
+ this.trackInvalidWellnessEvent('missing_wellness_identity');
502
+ return null;
503
+ }
504
+ if (agentId !== this.agentConfig?.agentId || eventOrgId !== currentOrgId || sessionOrgId !== currentOrgId || envelopeOrgId !== currentOrgId) {
505
+ this.trackInvalidWellnessEvent('mismatched_wellness_identity');
506
+ return null;
507
+ }
508
+ const interactionValue = sessionData.interactionId ?? sessionData.InteractionId;
509
+ const actionText = notificationDetails.actionText;
510
+ const trackingId = payload.trackingId;
511
+ return {
512
+ agentId,
513
+ orgId: currentOrgId,
514
+ agentSessionId,
515
+ actionEvent: actionEvent,
516
+ ...(typeof actionText === 'string' ? {
517
+ actionText
518
+ } : {}),
519
+ ...(typeof interactionValue === 'string' ? {
520
+ interactionId: interactionValue
521
+ } : {}),
522
+ ...(typeof trackingId === 'string' ? {
523
+ trackingId
524
+ } : {})
525
+ };
526
+ }
527
+ handleWellnessBreakWebsocketPayload(payload) {
528
+ if (payload.type !== _constants.WELLNESS_BREAK_HANDLER) {
529
+ return false;
530
+ }
531
+ const wellnessEvent = this.normalizeWellnessBreakEvent(payload);
532
+ if (wellnessEvent) {
533
+ // @ts-ignore - WebexPlugin emit is available at runtime but absent from its declaration.
534
+ this.emit(_types3.CC_EVENTS.WELLNESS_BREAK, wellnessEvent);
535
+ }
536
+ return true;
537
+ }
538
+ handleRTDWebsocketMessage = event => {
539
+ let payload;
540
+ try {
541
+ payload = JSON.parse(event);
542
+ } catch {
543
+ // TaskManager retains its existing malformed RTD message handling.
544
+ }
545
+ if ((0, _Utils.isRecord)(payload) && this.handleWellnessBreakWebsocketPayload(payload)) {
546
+ return;
547
+ }
548
+ this.taskManager.handleRealtimeWebsocketEvent(event);
549
+ };
372
550
 
373
551
  /**
374
552
  * Sets up event listeners for incoming tasks and task hydration
@@ -378,6 +556,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
378
556
  incomingTaskListener() {
379
557
  this.taskManager.on(_types4.TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
380
558
  this.taskManager.on(_types4.TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
559
+ this.taskManager.on(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this.handleTaskMultiLoginHydrate);
381
560
  this.taskManager.on(_types4.TASK_EVENTS.TASK_MERGED, this.handleTaskMerged);
382
561
  this.taskManager.on(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, this.handleCampaignPreviewReservation);
383
562
  }
@@ -410,22 +589,25 @@ class ContactCenter extends _webexCore.WebexPlugin {
410
589
  *
411
590
  * console.log('Agent ID:', profile.agentId);
412
591
  * console.log('Default DN:', profile.defaultDn);
413
- * console.log('Teams:', profile.teams.map(t => t.teamId));
592
+ * console.log('Teams:', profile.teams.map(t => t.id));
414
593
  * console.log('WebRTC Enabled:', profile.webRtcEnabled);
415
594
  * console.log('Supported Login Options:', profile.loginVoiceOptions);
416
595
  *
417
596
  * // Now you can proceed with station login, state changes, etc.
418
- * await cc.stationLogin({ teamId: profile.teams[0].teamId, loginOption: 'BROWSER' });
597
+ * await cc.stationLogin({ teamId: profile.teams[0].id, loginOption: 'BROWSER' });
419
598
  * ```
420
599
  */
421
600
  async register() {
422
- _loggerProxy.default.info('Starting CC SDK registration', {
601
+ this.wellnessRegistrationGeneration += 1;
602
+ this.wellbeingBreakIdleCode = undefined;
603
+ _loggerProxy.default.log('Starting CC SDK registration', {
423
604
  module: _constants.CC_FILE,
424
605
  method: _constants.METHODS.REGISTER
425
606
  });
426
607
  try {
427
608
  this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_SUCCESS, _constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_FAILED]);
428
609
  this.setupEventListeners();
610
+ this.services.webSocketManager.on('message', this.handleWebsocketMessage);
429
611
  const resp = await this.connectWebsocket();
430
612
  // Ensure 'dn' is always populated from 'defaultDn'
431
613
  resp.dn = resp.defaultDn;
@@ -437,7 +619,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
437
619
  module: _constants.CC_FILE,
438
620
  method: _constants.METHODS.REGISTER
439
621
  });
440
- return resp;
622
+
623
+ // Registration can silently restore a station session without emitting a
624
+ // relogin event. Project the active session for consumers that must
625
+ // recover session-scoped state after a page refresh.
626
+ return resp.isAgentLoggedIn && this.currentAgentSessionId ? {
627
+ ...resp,
628
+ agentSessionId: this.currentAgentSessionId
629
+ } : resp;
441
630
  } catch (error) {
442
631
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_FAILED, {
443
632
  orgId: error.orgId
@@ -484,14 +673,25 @@ class ContactCenter extends _webexCore.WebexPlugin {
484
673
  *
485
674
  */
486
675
  async deregister() {
676
+ this.wellnessRegistrationGeneration += 1;
677
+ this.wellbeingBreakIdleCode = undefined;
678
+ this.updateWellnessSession();
487
679
  try {
488
680
  this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_SUCCESS, _constants4.METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_FAIL]);
681
+ this.taskManager.clearAISummaryState();
489
682
  this.taskManager.off(_types4.TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
490
683
  this.taskManager.off(_types4.TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
684
+ this.taskManager.off(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this.handleTaskMultiLoginHydrate);
491
685
  this.taskManager.off(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, this.handleCampaignPreviewReservation);
492
686
  this.taskManager.unregisterIncomingCallEvent();
493
687
  this.services.webSocketManager.off('message', this.handleWebsocketMessage);
688
+ this.services.rtdWebSocketManager.off('message', this.handleRTDWebsocketMessage);
494
689
  this.services.connectionService.off('connectionLost', this.handleConnectionLost);
690
+ const {
691
+ publishError: wxAppPublishError
692
+ } = await this.teardownWxAppLocalState({
693
+ clearInitFlag: true
694
+ });
495
695
  if (this.agentConfig.webRtcEnabled && this.agentConfig.loginVoiceOptions.includes(_types.LoginOption.BROWSER)) {
496
696
  if (this.$webex.internal.mercury.connected) {
497
697
  this.$webex.internal.mercury.off('online');
@@ -508,9 +708,20 @@ class ContactCenter extends _webexCore.WebexPlugin {
508
708
  if (!this.services.webSocketManager.isSocketClosed) {
509
709
  this.services.webSocketManager.close(false, 'Unregistering the SDK');
510
710
  }
711
+ if (this.services.rtdWebSocketManager && !this.services.rtdWebSocketManager.isSocketClosed) {
712
+ this.services.rtdWebSocketManager.close(false, 'Unregistering the SDK');
713
+ }
714
+ if (this.services.rtdWebSocketManager && !this.services.rtdWebSocketManager.isSocketClosed) {
715
+ this.services.rtdWebSocketManager.close(false, 'Unregistering the RTD websocket');
716
+ }
511
717
 
512
718
  // Clear any cached agent configuration
719
+ this.wellbeingBreakIdleCode = undefined;
513
720
  this.agentConfig = null;
721
+ this.updateWellnessSession();
722
+ if (wxAppPublishError) {
723
+ throw wxAppPublishError;
724
+ }
514
725
  _loggerProxy.default.log('Deregistered successfully', {
515
726
  module: _constants.CC_FILE,
516
727
  method: _constants.METHODS.DEREGISTER
@@ -564,6 +775,12 @@ class ContactCenter extends _webexCore.WebexPlugin {
564
775
  * ```
565
776
  */
566
777
  async getBuddyAgents(data) {
778
+ const {
779
+ action,
780
+ state,
781
+ mediaType = 'telephony'
782
+ } = data;
783
+ const buddyAgentState = state ?? (action === 'Transfer' ? _constants2.AGENT_STATE_AVAILABLE : undefined);
567
784
  _loggerProxy.default.info('Fetching buddy agents', {
568
785
  module: _constants.CC_FILE,
569
786
  method: _constants.METHODS.GET_BUDDY_AGENTS
@@ -573,13 +790,16 @@ class ContactCenter extends _webexCore.WebexPlugin {
573
790
  const resp = await this.services.agent.buddyAgents({
574
791
  data: {
575
792
  agentProfileId: this.agentConfig.agentProfileID,
576
- ...data
793
+ mediaType,
794
+ ...(buddyAgentState ? {
795
+ state: buddyAgentState
796
+ } : {})
577
797
  }
578
798
  });
579
799
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_SUCCESS, {
580
800
  ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(resp),
581
- mediaType: data.mediaType,
582
- buddyAgentState: data.state,
801
+ mediaType,
802
+ buddyAgentState,
583
803
  buddyAgentCount: resp.data.agentList.length
584
804
  }, ['operational']);
585
805
  _loggerProxy.default.log(`Successfully retrieved ${resp.data.agentList.length} buddy agents`, {
@@ -592,8 +812,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
592
812
  const failureResp = error.details;
593
813
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_FAILED, {
594
814
  ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failureResp),
595
- mediaType: data.mediaType,
596
- buddyAgentState: data.state
815
+ mediaType,
816
+ buddyAgentState
597
817
  }, ['operational']);
598
818
  const {
599
819
  error: detailedError
@@ -609,13 +829,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
609
829
  * @private
610
830
  */
611
831
  async connectWebsocket() {
612
- _loggerProxy.default.info('Connecting to websocket', {
832
+ _loggerProxy.default.log('Connecting to websocket', {
613
833
  module: _constants.CC_FILE,
614
834
  method: _constants.METHODS.CONNECT_WEBSOCKET
615
835
  });
616
836
  try {
617
837
  const data = await this.services.webSocketManager.initWebSocket({
618
- body: this.getConnectionConfig()
838
+ body: this.getConnectionConfig(),
839
+ resource: _constants3.SUBSCRIBE_API
619
840
  });
620
841
  const agentId = data.agentId;
621
842
  const orgId = this.$webex.credentials.getOrgId();
@@ -624,13 +845,58 @@ class ContactCenter extends _webexCore.WebexPlugin {
624
845
  module: _constants.CC_FILE,
625
846
  method: _constants.METHODS.CONNECT_WEBSOCKET
626
847
  });
627
-
848
+ const configFlags = {
849
+ isEndTaskEnabled: this.agentConfig.isEndTaskEnabled,
850
+ isEndConsultEnabled: this.agentConfig.isEndConsultEnabled,
851
+ webRtcEnabled: this.agentConfig.webRtcEnabled,
852
+ autoWrapup: this.agentConfig.wrapUpData?.wrapUpProps?.autoWrapup ?? false,
853
+ aiFeature: this.agentConfig.aiFeature,
854
+ consultTransfer: {
855
+ allowConsultToQueue: this.agentConfig.allowConsultToQueue,
856
+ accessQueue: this.agentConfig.accessQueue,
857
+ accessEntryPoint: this.agentConfig.accessEntryPoint,
858
+ accessBuddyTeam: this.agentConfig.accessBuddyTeam
859
+ },
860
+ enableWxBetterTogether: this.isWxBetterTogetherEnabled(),
861
+ getWxAppUsersubPublished: () => this.webexCrossClientService.isAnswerCallsStateActive()
862
+ };
863
+ this.taskManager.setConfigFlags(configFlags);
628
864
  // TODO: Make profile a singleton to make it available throughout app/sdk so we dont need to inject info everywhere
629
865
  this.taskManager.setWrapupData(this.agentConfig.wrapUpData);
630
866
  this.taskManager.setAgentId(this.agentConfig.agentId);
867
+ this.taskManager.setAgentName(this.agentConfig.agentName);
631
868
  this.taskManager.setWebRtcEnabled(this.agentConfig.webRtcEnabled);
632
869
  this.apiAIAssistant.setAIFeatureFlags(this.agentConfig.aiFeature);
633
- if (this.agentConfig.webRtcEnabled && this.agentConfig.loginVoiceOptions.includes(_types.LoginOption.BROWSER)) {
870
+ this.wellbeingBreakIdleCode = undefined;
871
+ this.updateWellnessSession();
872
+
873
+ /**
874
+ * RTD websocket currently supports realtime transcripts and suggested responses.
875
+ * Extend this condition when additional AI RTD features are introduced.
876
+ * Wellness break notifications also arrive on this websocket.
877
+ */
878
+ if (this.agentConfig.aiFeature?.realtimeTranscripts?.enable || this.agentConfig.aiFeature?.suggestedResponses?.enable || this.agentConfig.aiFeature?.generatedSummaries?.wrapUpSummariesEnabled === true || this.agentConfig.aiFeature?.generatedSummaries?.consultTransferSummariesEnabled === true || this.agentConfig.isWellnessBreakEnabled) {
879
+ _loggerProxy.default.info('Connecting to RTD websocket', {
880
+ module: _constants.CC_FILE,
881
+ method: _constants.METHODS.CONNECT_WEBSOCKET
882
+ });
883
+ this.services.rtdWebSocketManager.initWebSocket({
884
+ body: this.getConnectionConfig(),
885
+ resource: _constants3.RTD_SUBSCRIBE_API
886
+ }).then(() => {
887
+ _loggerProxy.default.log('RTD websocket connected successfully', {
888
+ module: _constants.CC_FILE,
889
+ method: _constants.METHODS.CONNECT_WEBSOCKET
890
+ });
891
+ this.services.rtdWebSocketManager.on('message', this.handleRTDWebsocketMessage);
892
+ }).catch(error => {
893
+ _loggerProxy.default.error(`Error connecting to RTD websocket ${error}`, {
894
+ module: _constants.CC_FILE,
895
+ method: _constants.METHODS.CONNECT_WEBSOCKET
896
+ });
897
+ });
898
+ }
899
+ if (this.agentConfig.loginVoiceOptions.some(loginOption => this.isBrowserVoiceRequired(loginOption))) {
634
900
  try {
635
901
  await this.$webex.internal.mercury.connect();
636
902
  _loggerProxy.default.log('Authentication: webex.internal.mercury.connect successful', {
@@ -643,12 +909,23 @@ class ContactCenter extends _webexCore.WebexPlugin {
643
909
  method: _constants.METHODS.CONNECT_WEBSOCKET
644
910
  });
645
911
  }
912
+ } else if (this.isWebRTCRegistrationDisabled()) {
913
+ _loggerProxy.default.info('Skipping Mobius registration because disableWebRTCRegistration is enabled', {
914
+ module: _constants.CC_FILE,
915
+ method: _constants.METHODS.CONNECT_WEBSOCKET
916
+ });
646
917
  }
647
918
  if (this.$config && this.$config.allowAutomatedRelogin) {
648
919
  await this.silentRelogin();
920
+ } else {
921
+ _loggerProxy.default.log('Skipping silent relogin: allowAutomatedRelogin is disabled', {
922
+ module: _constants.CC_FILE,
923
+ method: _constants.METHODS.CONNECT_WEBSOCKET
924
+ });
649
925
  }
650
926
  return this.agentConfig;
651
927
  } catch (error) {
928
+ this.updateWellnessSession();
652
929
  _loggerProxy.default.error(`Error during register: ${error}`, {
653
930
  module: _constants.CC_FILE,
654
931
  method: _constants.METHODS.CONNECT_WEBSOCKET
@@ -686,30 +963,37 @@ class ContactCenter extends _webexCore.WebexPlugin {
686
963
  * ```
687
964
  */
688
965
  async stationLogin(data) {
689
- _loggerProxy.default.info('Starting agent station login', {
966
+ const loggerContext = {
690
967
  module: _constants.CC_FILE,
691
968
  method: _constants.METHODS.STATION_LOGIN
692
- });
969
+ };
693
970
  try {
971
+ _loggerProxy.default.log(`Starting agent station login | loginOption: ${data?.loginOption} teamId: ${data?.teamId}`, loggerContext);
694
972
  this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.STATION_LOGIN_SUCCESS, _constants4.METRIC_EVENT_NAMES.STATION_LOGIN_FAILED]);
695
973
  const dialPlanEntries = this.agentConfig?.dialPlan?.dialPlanEntity ?? [];
696
- if (data.loginOption === _types.LoginOption.AGENT_DN && !(0, _Utils.isValidDialNumber)(data.dialNumber, dialPlanEntries)) {
697
- const error = new Error('INVALID_DIAL_NUMBER');
698
- // @ts-ignore - adding custom key to the error object
699
- error.details = {
700
- data: {
701
- reason: 'INVALID_DIAL_NUMBER'
702
- }
703
- };
704
- throw error;
974
+ if (data.loginOption === _types.LoginOption.AGENT_DN) {
975
+ _loggerProxy.default.log(`Validating dial number | dialPlanEnabled: ${!!this.agentConfig?.dialPlan} | dialPlanEntryCount: ${dialPlanEntries.length}`, loggerContext);
976
+ if (!(0, _Utils.isValidDialNumber)(data.dialNumber, dialPlanEntries)) {
977
+ _loggerProxy.default.log(`Dial number validation failed | dialNumber: ${data.dialNumber} | dialPlanEntryCount: ${dialPlanEntries.length}`, loggerContext);
978
+ const error = new Error('INVALID_DIAL_NUMBER');
979
+ // @ts-ignore - adding custom key to the error object
980
+ error.details = {
981
+ data: {
982
+ reason: 'INVALID_DIAL_NUMBER'
983
+ }
984
+ };
985
+ throw error;
986
+ }
705
987
  }
988
+ const deviceId = this.getDeviceId(data.loginOption, data.dialNumber);
706
989
  const loginResponse = await this.services.agent.stationLogin({
707
990
  data: {
708
- dialNumber: data.loginOption === _types.LoginOption.BROWSER ? this.agentConfig.agentId : data.dialNumber,
991
+ // BROWSER DN must be webrtc-{agentId} so VPOP/RTMS do not treat a bare UUID as PSTN.
992
+ dialNumber: data.loginOption === _types.LoginOption.BROWSER ? deviceId : data.dialNumber,
709
993
  teamId: data.teamId,
710
994
  deviceType: data.loginOption,
711
995
  isExtension: data.loginOption === _types.LoginOption.EXTENSION,
712
- deviceId: this.getDeviceId(data.loginOption, data.dialNumber),
996
+ deviceId,
713
997
  roles: [_constants3.AGENT],
714
998
  teamName: _constants.EMPTY_STRING,
715
999
  siteId: _constants.EMPTY_STRING,
@@ -717,14 +1001,22 @@ class ContactCenter extends _webexCore.WebexPlugin {
717
1001
  auxCodeId: _constants.EMPTY_STRING
718
1002
  }
719
1003
  });
720
- if (this.agentConfig.webRtcEnabled && data.loginOption === _types.LoginOption.BROWSER) {
1004
+ this.webCallingService.setLoginOption(data.loginOption);
1005
+ this.webCallingService.setBrowserVoiceRequired(this.isBrowserVoiceRequired(data.loginOption));
1006
+ if (this.isBrowserVoiceRequired(data.loginOption)) {
721
1007
  await this.webCallingService.registerWebCallingLine();
1008
+ } else if (this.agentConfig.webRtcEnabled && data.loginOption === _types.LoginOption.BROWSER && this.isWebRTCRegistrationDisabled()) {
1009
+ _loggerProxy.default.info('Skipping web calling line registration because disableWebRTCRegistration is enabled', {
1010
+ module: _constants.CC_FILE,
1011
+ method: _constants.METHODS.STATION_LOGIN
1012
+ });
722
1013
  }
723
1014
  const resp = await loginResponse;
724
1015
  const {
725
1016
  channelsMap,
726
1017
  ...loginData
727
1018
  } = resp.data;
1019
+ this.updateWellnessSession(resp.data.agentSessionId);
728
1020
  this.agentConfig.currentTeamId = resp.data.teamId;
729
1021
  const response = {
730
1022
  ...loginData,
@@ -736,7 +1028,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
736
1028
  },
737
1029
  notifsTrackingId: resp.trackingId
738
1030
  };
739
- this.webCallingService.setLoginOption(data.loginOption);
1031
+ if (this.agentConfig) {
1032
+ this.agentConfig.deviceType = data.loginOption;
1033
+ if (data.loginOption === _types.LoginOption.AGENT_DN || data.loginOption === _types.LoginOption.EXTENSION) {
1034
+ this.agentConfig.defaultDn = data.dialNumber;
1035
+ this.agentConfig.dn = data.dialNumber;
1036
+ }
1037
+ }
740
1038
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.STATION_LOGIN_SUCCESS, {
741
1039
  ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(resp),
742
1040
  loginType: data.loginOption,
@@ -749,6 +1047,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
749
1047
  method: _constants.METHODS.STATION_LOGIN,
750
1048
  trackingId: resp.trackingId
751
1049
  });
1050
+ await this.ensureWxAppPostStationLogin();
752
1051
  return response;
753
1052
  } catch (error) {
754
1053
  const failure = error.details;
@@ -801,8 +1100,10 @@ class ContactCenter extends _webexCore.WebexPlugin {
801
1100
  logoutReason: data.logoutReason
802
1101
  }, ['behavioral', 'business', 'operational']);
803
1102
  if (this.webCallingService) {
804
- this.webCallingService.deregisterWebCallingLine();
1103
+ await this.webCallingService.deregisterWebCallingLine();
805
1104
  }
1105
+ await this.teardownWxAppLocalState();
1106
+ this.updateWellnessSession();
806
1107
  _loggerProxy.default.log(`Agent station logout completed successfully`, {
807
1108
  module: _constants.CC_FILE,
808
1109
  method: _constants.METHODS.STATION_LOGOUT,
@@ -887,6 +1188,18 @@ class ContactCenter extends _webexCore.WebexPlugin {
887
1188
  });
888
1189
  try {
889
1190
  this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.AGENT_STATE_CHANGE_SUCCESS, _constants4.METRIC_EVENT_NAMES.AGENT_STATE_CHANGE_FAILED]);
1191
+ if (data.state === _constants2.AGENT_STATE_AVAILABLE && this.webCallingService?.isBrowserVoiceRequired() && !this.webCallingService.isVoiceReady()) {
1192
+ const error = new Error(_types.VOICE_CONNECTION_ERROR.NOT_READY);
1193
+ error.details = {
1194
+ type: 'SDK_VALIDATION_ERROR',
1195
+ orgId: this.$webex.credentials.getOrgId(),
1196
+ trackingId: _constants.EMPTY_STRING,
1197
+ data: {
1198
+ reason: _types.VOICE_CONNECTION_ERROR.NOT_READY
1199
+ }
1200
+ };
1201
+ throw error;
1202
+ }
890
1203
  const agentStatusResponse = await this.services.agent.stateChange({
891
1204
  data: {
892
1205
  ...data,
@@ -896,7 +1209,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
896
1209
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.AGENT_STATE_CHANGE_SUCCESS, {
897
1210
  ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(agentStatusResponse),
898
1211
  requestedState: data.state,
899
- teamId: this.agentConfig?.teams[0]?.teamId ?? _constants.EMPTY_STRING,
1212
+ teamId: this.agentConfig?.teams[0]?.id ?? _constants.EMPTY_STRING,
900
1213
  status: agentStatusResponse.data?.status,
901
1214
  subStatus: agentStatusResponse.data?.subStatus,
902
1215
  auxCodeId: data.auxCodeId,
@@ -923,6 +1236,85 @@ class ContactCenter extends _webexCore.WebexPlugin {
923
1236
  }
924
1237
  }
925
1238
 
1239
+ /**
1240
+ * Returns the system-managed `WellbeingBreak` idle code for the current registration.
1241
+ * The value is fetched outside Desktop Profile filtering and cached until deregistration.
1242
+ * @returns The normalized system idle-code entity
1243
+ * @throws Structured Contact Center error when wellness is disabled or the code is unavailable
1244
+ * @example
1245
+ * const idleCode = await webex.cc.getWellbeingBreakIdleCode();
1246
+ * @public
1247
+ */
1248
+ async getWellbeingBreakIdleCode() {
1249
+ const method = _constants.METHODS.GET_WELLBEING_BREAK_IDLE_CODE;
1250
+ try {
1251
+ if (!this.agentConfig?.isWellnessBreakEnabled) {
1252
+ const validationError = new Error('WELLNESS_BREAK_NOT_ENABLED');
1253
+ validationError.details = {
1254
+ type: 'SDK_VALIDATION_ERROR',
1255
+ orgId: this.$webex.credentials.getOrgId(),
1256
+ trackingId: _constants.EMPTY_STRING,
1257
+ data: {
1258
+ reason: 'WELLNESS_BREAK_NOT_ENABLED'
1259
+ }
1260
+ };
1261
+ throw validationError;
1262
+ }
1263
+ if (this.wellbeingBreakIdleCode) {
1264
+ return this.wellbeingBreakIdleCode;
1265
+ }
1266
+ this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS, _constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED]);
1267
+ const registrationGeneration = this.wellnessRegistrationGeneration;
1268
+ const orgId = this.$webex.credentials.getOrgId();
1269
+ const idleCode = await this.services.config.getWellbeingBreakIdleCode(orgId);
1270
+ if (registrationGeneration !== this.wellnessRegistrationGeneration || orgId !== this.$webex.credentials.getOrgId() || !this.agentConfig?.isWellnessBreakEnabled) {
1271
+ const staleRegistrationError = new Error('WELLNESS_BREAK_REGISTRATION_CHANGED');
1272
+ staleRegistrationError.details = {
1273
+ type: 'SDK_VALIDATION_ERROR',
1274
+ orgId,
1275
+ trackingId: _constants.EMPTY_STRING,
1276
+ data: {
1277
+ reason: 'WELLNESS_BREAK_REGISTRATION_CHANGED'
1278
+ }
1279
+ };
1280
+ throw staleRegistrationError;
1281
+ }
1282
+ this.wellbeingBreakIdleCode = idleCode;
1283
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS, {}, ['operational']);
1284
+ return idleCode;
1285
+ } catch (error) {
1286
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED, {
1287
+ reason: error instanceof Error ? error.message : _constants.UNKNOWN_ERROR
1288
+ }, ['operational']);
1289
+ const {
1290
+ error: detailedError
1291
+ } = (0, _Utils.getErrorDetails)(error, method, _constants.CC_FILE);
1292
+ throw detailedError;
1293
+ }
1294
+ }
1295
+
1296
+ /**
1297
+ * Returns the current browser voice connection state.
1298
+ * Subscribe to `voice:connectionStateChange` to receive updates. The snapshot keeps line
1299
+ * registration separate from Mobius socket connectivity and does not represent the Contact
1300
+ * Center WebSocket connection.
1301
+ *
1302
+ * @returns {VoiceConnectionState} Current browser voice status and underlying connection states
1303
+ * @fires voice:connectionStateChange When browser voice availability changes
1304
+ * @public
1305
+ * @example
1306
+ * ```typescript
1307
+ * cc.on('voice:connectionStateChange', onVoiceStateChange);
1308
+ * const state = cc.getVoiceConnectionState();
1309
+ * ```
1310
+ */
1311
+ getVoiceConnectionState() {
1312
+ const state = this.webCallingService?.getVoiceConnectionState();
1313
+ return state ?? {
1314
+ ..._constants.DEFAULT_VOICE_CONNECTION_STATE
1315
+ };
1316
+ }
1317
+
926
1318
  /**
927
1319
  * Processes incoming websocket messages and emits corresponding events
928
1320
  * Handles various event types including agent state changes, login events,
@@ -932,8 +1324,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
932
1324
  */
933
1325
  handleWebsocketMessage = event => {
934
1326
  const eventData = JSON.parse(event);
935
- // Re-emit all the events related to agent except keep-alives
936
- if (!eventData.keepalive && eventData.data && eventData.data.type) {
1327
+ // Re-emit all the events related to agent except keep-alives. Only event names present in
1328
+ // the typed CC_EVENTS allow-list are emitted; unknown/server-injected types are ignored.
1329
+ if (!eventData.keepalive && eventData.data && eventData.data.type && CC_EVENT_ALLOW_LIST.has(eventData.data.type)) {
937
1330
  // @ts-ignore
938
1331
  this.emit(eventData.data.type, eventData.data);
939
1332
  }
@@ -956,8 +1349,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
956
1349
  };
957
1350
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WEBSOCKET_EVENT_RECEIVED, metricsPayload, ['operational']);
958
1351
  }
1352
+ if (this.handleWellnessBreakWebsocketPayload(eventData)) {
1353
+ return;
1354
+ }
959
1355
  switch (eventData.type) {
960
1356
  case _types3.CC_EVENTS.AGENT_MULTI_LOGIN:
1357
+ if (eventData.data?.type === 'AgentMultiLoginCloseSession' && (!eventData.data.agentSessionId || eventData.data.agentSessionId === this.currentAgentSessionId)) {
1358
+ this.updateWellnessSession();
1359
+ }
961
1360
  // @ts-ignore
962
1361
  this.emit(_types2.AGENT_EVENTS.AGENT_MULTI_LOGIN, eventData.data);
963
1362
  break;
@@ -978,6 +1377,10 @@ class ContactCenter extends _webexCore.WebexPlugin {
978
1377
  channelsMap,
979
1378
  ...loginData
980
1379
  } = eventData.data;
1380
+ this.updateWellnessSession(loginData.agentSessionId);
1381
+ if (loginData.deviceType === _types.LoginOption.EXTENSION || loginData.deviceType === _types.LoginOption.AGENT_DN) {
1382
+ this.webCallingService.setBrowserVoiceRequired(false);
1383
+ }
981
1384
  const stationLoginData = {
982
1385
  ...loginData,
983
1386
  mmProfile: {
@@ -999,6 +1402,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
999
1402
  channelsMap,
1000
1403
  ...loginData
1001
1404
  } = eventData.data;
1405
+ this.updateWellnessSession(loginData.agentSessionId);
1002
1406
  const stationReLoginData = {
1003
1407
  ...loginData,
1004
1408
  mmProfile: {
@@ -1011,8 +1415,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
1011
1415
  };
1012
1416
  // @ts-ignore
1013
1417
  this.emit(_types2.AGENT_EVENTS.AGENT_RELOGIN_SUCCESS, stationReLoginData);
1418
+ break;
1014
1419
  }
1015
- break;
1016
1420
  case _types3.CC_EVENTS.AGENT_STATE_CHANGE_SUCCESS:
1017
1421
  // @ts-ignore
1018
1422
  this.emit(_types2.AGENT_EVENTS.AGENT_STATE_CHANGE_SUCCESS, eventData.data);
@@ -1026,6 +1430,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
1026
1430
  this.emit(_types2.AGENT_EVENTS.AGENT_STATION_LOGIN_FAILED, eventData.data);
1027
1431
  break;
1028
1432
  case _types3.CC_EVENTS.AGENT_LOGOUT_SUCCESS:
1433
+ if (!eventData.data.agentSessionId || eventData.data.agentSessionId === this.currentAgentSessionId) {
1434
+ this.updateWellnessSession();
1435
+ }
1029
1436
  // @ts-ignore
1030
1437
  this.emit(_types2.AGENT_EVENTS.AGENT_LOGOUT_SUCCESS, eventData.data);
1031
1438
  break;
@@ -1042,6 +1449,514 @@ class ContactCenter extends _webexCore.WebexPlugin {
1042
1449
  }
1043
1450
  };
1044
1451
 
1452
+ /**
1453
+ * Checks whether Mobius/WebRTC registration should be skipped by config
1454
+ * @returns {boolean} True when browser WebRTC registration is disabled
1455
+ * @private
1456
+ */
1457
+ isWebRTCRegistrationDisabled() {
1458
+ return this.$config?.disableWebRTCRegistration === true;
1459
+ }
1460
+
1461
+ /**
1462
+ * Determines whether this local login should register a browser voice line.
1463
+ * @param {LoginOption} loginOption Login device selected for this station login
1464
+ * @returns {boolean} True when browser WebRTC registration is enabled
1465
+ * @private
1466
+ */
1467
+ isBrowserVoiceRequired(loginOption) {
1468
+ return loginOption === _types.LoginOption.BROWSER && this.agentConfig?.webRtcEnabled === true && !this.isWebRTCRegistrationDisabled();
1469
+ }
1470
+
1471
+ /**
1472
+ * Validates contact-center plugin configuration before service initialization
1473
+ * @private
1474
+ */
1475
+ validatePluginConfig() {
1476
+ if (this.$config?.disableWebRTCRegistration === true && this.$config?.allowMultiLogin === false) {
1477
+ throw new Error('Invalid Contact Center configuration: disableWebRTCRegistration cannot be true when allowMultiLogin is false. Enable allowMultiLogin or allow WebRTC registration so an SDK instance can receive Mobius/WebRTC task events.');
1478
+ }
1479
+ }
1480
+
1481
+ /**
1482
+ * Whether wxApp thick-client answer is enabled for this SDK instance.
1483
+ * @public
1484
+ */
1485
+ isWxBetterTogetherEnabled() {
1486
+ return this.$config?.enableWxBetterTogether === true;
1487
+ }
1488
+
1489
+ /**
1490
+ * Current station login option (Extension, Dial Number, or Browser/Desktop).
1491
+ * Prefer webCallingService — updated on every stationLogin before wxApp hooks run.
1492
+ * @private
1493
+ */
1494
+ getCurrentStationLoginOption() {
1495
+ return this.webCallingService?.loginOption ?? this.agentConfig?.deviceType;
1496
+ }
1497
+
1498
+ /**
1499
+ * wxApp thick-client answer is supported for Extension and Dial Number station login only —
1500
+ * not Browser/Desktop (WebRTC) login.
1501
+ * @private
1502
+ */
1503
+ assertWxAppStationLoginSupportedForEnable() {
1504
+ const loginOption = this.getCurrentStationLoginOption();
1505
+ if (loginOption !== _types.LoginOption.EXTENSION && loginOption !== _types.LoginOption.AGENT_DN) {
1506
+ throw new Error('setManageWebexCallingInWxcc requires EXTENSION or AGENT_DN station login. Complete station login before enabling.');
1507
+ }
1508
+ }
1509
+
1510
+ /**
1511
+ * Clears runtime wxApp config after logout/deregister so stale flags do not apply on relogin.
1512
+ * @private
1513
+ */
1514
+ resetEnableWxBetterTogetherConfig() {
1515
+ if (this.$config) {
1516
+ this.$config.enableWxBetterTogether = false;
1517
+ }
1518
+ this.taskManager.applyEnableWxBetterTogether(false);
1519
+ }
1520
+
1521
+ /**
1522
+ * Runtime enable/disable for wxApp Better Together (toast suppression + Mercury mute sync).
1523
+ *
1524
+ * **Phase 1 (WXCC-6026 / MMT): NOT part of the public host contract.**
1525
+ * Hosts must set `webexConfig.cc.enableWxBetterTogether` before `webex.init()` / `cc.register()`.
1526
+ * To change the flag after the SDK is initialized, re-init the SDK with the updated config.
1527
+ *
1528
+ * **Supported public read API:** {@link isWxBetterTogetherEnabled}.
1529
+ * **Supported telephony API:** unified `task.accept()`, `task.decline()`, `task.toggleMute()`,
1530
+ * `task.transmitDtmf()` — SDK routes wxApp calls internally when the init flag is active.
1531
+ *
1532
+ * **Production lifecycle does not call this method.** Station login, silent relogin, logout,
1533
+ * and deregister use {@link ensureWxAppPostStationLogin} and {@link teardownWxAppLocalState}
1534
+ * (usersub publish + Mercury subscribe/unsubscribe based on the init flag).
1535
+ *
1536
+ * This setter remains as a **private implementation** for Phase 2 runtime toggle and unit tests.
1537
+ * It updates `$config.enableWxBetterTogether`, TaskManager flags, cross-client usersub
1538
+ * (`answer-calls-on-wxcc`), and Mercury mute sync; rolls back config on publish/connect failure.
1539
+ *
1540
+ * @param enabled - `true` to enable wxApp answer + usersub suppression; `false` to disable and tear down.
1541
+ * @throws When enabling without login, on unsupported BROWSER station login, or when usersub/Mercury init fails.
1542
+ * @internal
1543
+ * @see enableWxBetterTogether (CCPluginConfig init flag)
1544
+ * @see ensureWxAppPostStationLogin
1545
+ * @see teardownWxAppLocalState
1546
+ */
1547
+ async setManageWebexCallingInWxcc(enabled) {
1548
+ if (enabled && !this.$webex.internal.device?.userId) {
1549
+ throw new Error('Cannot publish answer-calls-on-wxcc: user is not logged in');
1550
+ }
1551
+ if (enabled) {
1552
+ this.assertWxAppStationLoginSupportedForEnable();
1553
+ }
1554
+ const previousEnabled = this.isWxBetterTogetherEnabled();
1555
+ if (this.$config) {
1556
+ this.$config.enableWxBetterTogether = enabled;
1557
+ }
1558
+ this.taskManager.applyEnableWxBetterTogether(enabled);
1559
+ let publishedEnable = false;
1560
+ try {
1561
+ if (enabled) {
1562
+ await this.ensureWxAppMercuryAndSubscribe();
1563
+ await this.publishAnswerOnWebexCrossClientState(true);
1564
+ publishedEnable = true;
1565
+ this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
1566
+ this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
1567
+ } else {
1568
+ await this.publishAnswerOnWebexCrossClientState(false);
1569
+ this.wxAppTelephonyMercurySync.unsubscribe();
1570
+ await this.releaseWxAppMercuryResources();
1571
+ }
1572
+ } catch (error) {
1573
+ if (publishedEnable) {
1574
+ await this.revertWxAppCrossClientPublish();
1575
+ } else if (enabled) {
1576
+ this.wxAppTelephonyMercurySync.unsubscribe();
1577
+ await this.releaseWxAppMercuryResources();
1578
+ }
1579
+ if (this.$config) {
1580
+ this.$config.enableWxBetterTogether = previousEnabled;
1581
+ }
1582
+ this.taskManager.applyEnableWxBetterTogether(previousEnabled);
1583
+ throw error;
1584
+ }
1585
+ }
1586
+ getWxAppTelephonyTaskType() {
1587
+ const loginOption = this.getCurrentStationLoginOption();
1588
+ if (loginOption === _types.LoginOption.BROWSER) {
1589
+ return 'WebRTC';
1590
+ }
1591
+ if (loginOption === _types.LoginOption.EXTENSION || loginOption === _types.LoginOption.AGENT_DN) {
1592
+ return 'Voice';
1593
+ }
1594
+ return 'unknown';
1595
+ }
1596
+ async ensureWxAppPostStationLogin() {
1597
+ const loginOption = this.getCurrentStationLoginOption();
1598
+ const flagEnabled = this.isWxBetterTogetherEnabled();
1599
+ const telephonyTaskType = this.getWxAppTelephonyTaskType();
1600
+ if (loginOption === _types.LoginOption.BROWSER) {
1601
+ if (flagEnabled) {
1602
+ (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
1603
+ enableWxBetterTogether: true,
1604
+ loginOption,
1605
+ wxAppHooksApplied: false,
1606
+ usersubPublished: false,
1607
+ mercurySubscribed: false,
1608
+ telephonyTaskType,
1609
+ skipReason: 'unsupported_browser_login'
1610
+ });
1611
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED, {
1612
+ loginOption,
1613
+ enableWxBetterTogether: true,
1614
+ skipReason: 'unsupported_browser_login'
1615
+ }, ['operational', 'behavioral']);
1616
+ }
1617
+ return;
1618
+ }
1619
+ let publishedEnable = false;
1620
+ let wxAppInitStage = 'mercury';
1621
+ try {
1622
+ if (flagEnabled) {
1623
+ this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS, _constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED]);
1624
+ await this.ensureWxAppMercuryAndSubscribe();
1625
+ wxAppInitStage = 'publish';
1626
+ await this.publishAnswerOnWebexCrossClientState(true);
1627
+ publishedEnable = true;
1628
+ this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
1629
+ this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
1630
+ const mercurySubscribed = this.wxAppTelephonyMercurySync.isSubscribed();
1631
+ const usersubPublished = this.webexCrossClientService.isAnswerCallsStateActive();
1632
+ (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
1633
+ enableWxBetterTogether: true,
1634
+ loginOption,
1635
+ wxAppHooksApplied: true,
1636
+ usersubPublished,
1637
+ mercurySubscribed,
1638
+ telephonyTaskType
1639
+ });
1640
+ const sessionInitReady = mercurySubscribed && usersubPublished;
1641
+ if (sessionInitReady) {
1642
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS, {
1643
+ loginOption,
1644
+ enableWxBetterTogether: true,
1645
+ usersubPublished,
1646
+ mercurySubscribed,
1647
+ telephonyTaskType
1648
+ }, ['operational', 'behavioral']);
1649
+ } else {
1650
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED, {
1651
+ loginOption,
1652
+ enableWxBetterTogether: true,
1653
+ usersubPublished,
1654
+ mercurySubscribed,
1655
+ telephonyTaskType,
1656
+ skipReason: !usersubPublished ? 'usersub_not_published' : 'mercury_not_subscribed'
1657
+ }, ['operational', 'behavioral']);
1658
+ }
1659
+ } else {
1660
+ await this.ensureWxAppDeviceRegistered();
1661
+ await this.publishAnswerOnWebexCrossClientState(false, {
1662
+ force: true
1663
+ });
1664
+ this.webexCrossClientService.teardown();
1665
+ this.wxAppTelephonyMercurySync.unsubscribe();
1666
+ await this.releaseWxAppMercuryResources();
1667
+ (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
1668
+ enableWxBetterTogether: false,
1669
+ loginOption,
1670
+ wxAppHooksApplied: true,
1671
+ usersubPublished: false,
1672
+ mercurySubscribed: false,
1673
+ telephonyTaskType,
1674
+ skipReason: 'flag_disabled'
1675
+ });
1676
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED, {
1677
+ loginOption,
1678
+ enableWxBetterTogether: false,
1679
+ skipReason: 'flag_disabled'
1680
+ }, ['operational', 'behavioral']);
1681
+ }
1682
+ } catch (error) {
1683
+ _loggerProxy.default.error(`Failed to initialize wxApp post-station-login: ${error}`, {
1684
+ module: _constants.CC_FILE,
1685
+ method: _constants.METHODS.STATION_LOGIN
1686
+ });
1687
+ if (flagEnabled) {
1688
+ const sessionInitFailureReason = wxAppInitStage === 'mercury' ? 'mercury_subscribe_failed' : 'publish_failed';
1689
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED, {
1690
+ loginOption,
1691
+ enableWxBetterTogether: true,
1692
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
1693
+ mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
1694
+ telephonyTaskType,
1695
+ skipReason: sessionInitFailureReason,
1696
+ error: error instanceof Error ? error.toString() : String(error)
1697
+ }, ['operational', 'behavioral']);
1698
+ (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
1699
+ enableWxBetterTogether: true,
1700
+ loginOption,
1701
+ wxAppHooksApplied: false,
1702
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
1703
+ mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
1704
+ telephonyTaskType,
1705
+ skipReason: sessionInitFailureReason
1706
+ });
1707
+ if (publishedEnable) {
1708
+ await this.revertWxAppCrossClientPublish();
1709
+ } else {
1710
+ this.wxAppTelephonyMercurySync.unsubscribe();
1711
+ await this.releaseWxAppMercuryResources();
1712
+ }
1713
+ this.resetEnableWxBetterTogetherConfig();
1714
+ } else {
1715
+ this.scheduleForcedFalsePublishRetry();
1716
+ }
1717
+ }
1718
+ }
1719
+ clearWxAppFalsePublishRetryTimer() {
1720
+ if (this.wxAppFalsePublishRetryTimer) {
1721
+ clearTimeout(this.wxAppFalsePublishRetryTimer);
1722
+ this.wxAppFalsePublishRetryTimer = undefined;
1723
+ }
1724
+ }
1725
+ scheduleForcedFalsePublishRetry(retryAttempt = 0) {
1726
+ this.scheduleFalsePublishRetry(retryAttempt, {
1727
+ requireDisabled: true
1728
+ });
1729
+ }
1730
+
1731
+ /**
1732
+ * Retries compensating false publish after rollback failure, regardless of enabled flag.
1733
+ * @private
1734
+ */
1735
+ scheduleCompensatingFalsePublishRetry(retryAttempt = 0) {
1736
+ this.scheduleFalsePublishRetry(retryAttempt);
1737
+ }
1738
+ scheduleFalsePublishRetry(retryAttempt = 0, options = {}) {
1739
+ if (retryAttempt >= ContactCenter.WXAPP_FALSE_PUBLISH_MAX_RETRIES) {
1740
+ return;
1741
+ }
1742
+ if (options?.requireDisabled && this.isWxBetterTogetherEnabled()) {
1743
+ return;
1744
+ }
1745
+ this.clearWxAppFalsePublishRetryTimer();
1746
+ this.wxAppFalsePublishRetryTimer = setTimeout(async () => {
1747
+ this.wxAppFalsePublishRetryTimer = undefined;
1748
+ if (options?.requireDisabled && this.isWxBetterTogetherEnabled()) {
1749
+ return;
1750
+ }
1751
+ if (!options?.requireDisabled && this.isWxBetterTogetherEnabled() && this.webexCrossClientService.isAnswerCallsStateActive()) {
1752
+ return;
1753
+ }
1754
+ try {
1755
+ await this.ensureWxAppDeviceRegistered();
1756
+ await this.publishAnswerOnWebexCrossClientState(false, {
1757
+ force: true
1758
+ });
1759
+ this.webexCrossClientService.teardown();
1760
+ this.wxAppTelephonyMercurySync.unsubscribe();
1761
+ await this.releaseWxAppMercuryResources();
1762
+ } catch (retryError) {
1763
+ _loggerProxy.default.error(`Failed to retry forced answer-calls-on-wxcc false publish: ${retryError}`, {
1764
+ module: _constants.CC_FILE,
1765
+ method: _constants.METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC
1766
+ });
1767
+ this.scheduleFalsePublishRetry(retryAttempt + 1, options);
1768
+ }
1769
+ }, ContactCenter.WXAPP_FALSE_PUBLISH_RETRY_DELAY_MS);
1770
+ }
1771
+
1772
+ /**
1773
+ * Best-effort rollback when usersub true was published but wxApp setup did not complete.
1774
+ * @private
1775
+ */
1776
+ async revertWxAppCrossClientPublish() {
1777
+ try {
1778
+ await this.publishAnswerOnWebexCrossClientState(false, {
1779
+ force: true
1780
+ });
1781
+ } catch (error) {
1782
+ _loggerProxy.default.error(`Failed to publish compensating answer-calls-on-wxcc false during wxApp rollback: ${error}`, {
1783
+ module: _constants.CC_FILE,
1784
+ method: _constants.METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC
1785
+ });
1786
+ this.scheduleCompensatingFalsePublishRetry();
1787
+ }
1788
+ this.webexCrossClientService.teardown();
1789
+ this.wxAppTelephonyMercurySync.unsubscribe();
1790
+ await this.releaseWxAppMercuryResources();
1791
+ }
1792
+ async ensureWxAppDeviceRegistered() {
1793
+ const device = this.$webex.internal.device;
1794
+ if (device && !device.registered && device.register) {
1795
+ await device.register();
1796
+ this.wxAppDeviceRegisteredByCc = true;
1797
+ _loggerProxy.default.log('WxApp: device registered for cross-client publish', {
1798
+ module: _constants.CC_FILE,
1799
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1800
+ });
1801
+ }
1802
+ }
1803
+ async ensureWxAppMercuryConnected() {
1804
+ const mercury = this.$webex.internal.mercury;
1805
+ await this.ensureWxAppDeviceRegistered();
1806
+ if (mercury && !mercury.connected) {
1807
+ await mercury.connect();
1808
+ this.wxAppMercuryConnectedByCc = true;
1809
+ _loggerProxy.default.log('WxApp mute sync: mercury connected', {
1810
+ module: _constants.CC_FILE,
1811
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1812
+ });
1813
+ }
1814
+ }
1815
+
1816
+ /**
1817
+ * Disconnects Mercury and unregisters the device when wxApp mute sync opened them.
1818
+ * @private
1819
+ */
1820
+ async releaseWxAppMercuryResources() {
1821
+ const mercury = this.$webex.internal.mercury;
1822
+ const device = this.$webex.internal.device;
1823
+ if (this.wxAppMercuryConnectedByCc && mercury?.connected) {
1824
+ try {
1825
+ await mercury.disconnect();
1826
+ this.wxAppMercuryConnectedByCc = false;
1827
+ _loggerProxy.default.log('WxApp mute sync: mercury disconnected', {
1828
+ module: _constants.CC_FILE,
1829
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1830
+ });
1831
+ } catch (error) {
1832
+ _loggerProxy.default.error(`Failed to disconnect wxApp Mercury: ${error}`, {
1833
+ module: _constants.CC_FILE,
1834
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1835
+ });
1836
+ }
1837
+ }
1838
+ if (this.wxAppDeviceRegisteredByCc && device?.registered && device.unregister) {
1839
+ try {
1840
+ // @ts-ignore
1841
+ await device.unregister();
1842
+ this.wxAppDeviceRegisteredByCc = false;
1843
+ _loggerProxy.default.log('WxApp mute sync: device unregistered', {
1844
+ module: _constants.CC_FILE,
1845
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1846
+ });
1847
+ } catch (error) {
1848
+ _loggerProxy.default.error(`Failed to unregister wxApp device: ${error}`, {
1849
+ module: _constants.CC_FILE,
1850
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1851
+ });
1852
+ }
1853
+ } else if (this.wxAppDeviceRegisteredByCc) {
1854
+ this.wxAppDeviceRegisteredByCc = false;
1855
+ }
1856
+ }
1857
+
1858
+ /**
1859
+ * Clears wxApp runtime state and feature-owned resources. Publish failures are logged;
1860
+ * optional rethrow for deregister when callers need to surface usersub errors.
1861
+ * @private
1862
+ */
1863
+ async teardownWxAppLocalState(options) {
1864
+ this.clearWxAppFalsePublishRetryTimer();
1865
+ let publishError;
1866
+ try {
1867
+ const shouldForceFalsePublish = this.isWxBetterTogetherEnabled() || this.webexCrossClientService.isAnswerCallsStateActive();
1868
+ await this.publishAnswerOnWebexCrossClientState(false, {
1869
+ force: shouldForceFalsePublish
1870
+ });
1871
+ } catch (error) {
1872
+ publishError = error;
1873
+ _loggerProxy.default.error(`Failed to publish answer-calls-on-wxcc false during wxApp teardown: ${error}`, {
1874
+ module: _constants.CC_FILE,
1875
+ method: _constants.METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC
1876
+ });
1877
+ }
1878
+ this.webexCrossClientService.teardown();
1879
+ this.wxAppTelephonyMercurySync.unsubscribe();
1880
+ await this.releaseWxAppMercuryResources();
1881
+ if (options?.clearInitFlag) {
1882
+ this.resetEnableWxBetterTogetherConfig();
1883
+ }
1884
+ if (publishError) {
1885
+ this.scheduleCompensatingFalsePublishRetry();
1886
+ }
1887
+ if (options?.rethrowPublishError && publishError) {
1888
+ throw publishError;
1889
+ }
1890
+ return {
1891
+ publishError: publishError ?? undefined
1892
+ };
1893
+ }
1894
+ async ensureWxAppMercuryAndSubscribe() {
1895
+ if (!this.isWxBetterTogetherEnabled()) {
1896
+ return;
1897
+ }
1898
+ if (this.getCurrentStationLoginOption() === _types.LoginOption.BROWSER) {
1899
+ return;
1900
+ }
1901
+ const agentId = this.agentConfig?.agentId;
1902
+ if (!agentId) {
1903
+ _loggerProxy.default.error('Cannot subscribe wxApp mute sync: agentId unavailable', {
1904
+ module: _constants.CC_FILE,
1905
+ method: _constants.METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY
1906
+ });
1907
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED, {
1908
+ error: 'agentId unavailable',
1909
+ mercurySubscribed: false
1910
+ }, ['operational', 'behavioral']);
1911
+ return;
1912
+ }
1913
+ try {
1914
+ await this.ensureWxAppMercuryConnected();
1915
+ this.wxAppTelephonyMercurySync.subscribe(agentId, (callId, muted) => {
1916
+ this.taskManager.applyWxAppMuteStateFromSync(callId, muted);
1917
+ });
1918
+ } catch (error) {
1919
+ _loggerProxy.default.error(`Failed to ensure wxApp Mercury mute sync: ${error}`, {
1920
+ module: _constants.CC_FILE,
1921
+ method: _constants.METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY
1922
+ });
1923
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED, {
1924
+ error: error instanceof Error ? error.toString() : String(error),
1925
+ mercurySubscribed: false
1926
+ }, ['operational', 'behavioral']);
1927
+ this.wxAppTelephonyMercurySync.unsubscribe();
1928
+ await this.releaseWxAppMercuryResources();
1929
+ throw error;
1930
+ }
1931
+ }
1932
+ async publishAnswerOnWebexCrossClientState(enable, options) {
1933
+ if (enable && !this.isWxBetterTogetherEnabled()) {
1934
+ return;
1935
+ }
1936
+ if (!enable && !options?.force && !this.webexCrossClientService.isAnswerCallsStateActive()) {
1937
+ return;
1938
+ }
1939
+ const userId = this.$webex.internal.device?.userId;
1940
+ if (!userId) {
1941
+ if (enable && this.isWxBetterTogetherEnabled()) {
1942
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED, {
1943
+ enableWxBetterTogether: true,
1944
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
1945
+ skipReason: 'user_id_unavailable',
1946
+ error: 'User ID is unavailable for cross-client publish'
1947
+ }, ['operational', 'behavioral']);
1948
+ }
1949
+ return;
1950
+ }
1951
+ await this.webexCrossClientService.setManageWebexCallingInWxcc(enable, {
1952
+ userId,
1953
+ trackPublishMetrics: true
1954
+ });
1955
+ if (enable) {
1956
+ this.clearWxAppFalsePublishRetryTimer();
1957
+ }
1958
+ }
1959
+
1045
1960
  /**
1046
1961
  * Initializes event listeners for the Contact Center service
1047
1962
  * Sets up handlers for connection state changes and other core events
@@ -1073,13 +1988,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
1073
1988
  async handleConnectionLost(msg) {
1074
1989
  if (msg.isConnectionLost) {
1075
1990
  // TODO: Emit an event saying connection is lost
1076
- _loggerProxy.default.info('event=handleConnectionLost | Connection lost', {
1991
+ _loggerProxy.default.log('event=handleConnectionLost | Connection lost', {
1077
1992
  module: _constants.CC_FILE,
1078
1993
  method: _constants.METHODS.HANDLE_CONNECTION_LOST
1079
1994
  });
1080
1995
  } else if (msg.isSocketReconnected) {
1081
1996
  // TODO: Emit an event saying connection is re-estabilished
1082
- _loggerProxy.default.info('event=handleConnectionReconnect | Connection reconnected attempting to request silent relogin', {
1997
+ _loggerProxy.default.log('event=handleConnectionReconnect | Connection reconnected attempting to request silent relogin', {
1083
1998
  module: _constants.CC_FILE,
1084
1999
  method: _constants.METHODS.HANDLE_CONNECTION_LOST
1085
2000
  });
@@ -1094,12 +2009,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
1094
2009
  * @private
1095
2010
  */
1096
2011
  async silentRelogin() {
1097
- _loggerProxy.default.info('Starting silent relogin process', {
2012
+ _loggerProxy.default.log('Starting silent relogin process', {
1098
2013
  module: _constants.CC_FILE,
1099
2014
  method: _constants.METHODS.SILENT_RELOGIN
1100
2015
  });
1101
2016
  try {
1102
2017
  const reLoginResponse = await this.services.agent.reload();
2018
+ this.updateWellnessSession(reLoginResponse.data.agentSessionId);
1103
2019
  const {
1104
2020
  agentId,
1105
2021
  lastStateChangeReason,
@@ -1116,7 +2032,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
1116
2032
  this.agentConfig.currentTeamId = reLoginResponse.data.teamId;
1117
2033
  await this.handleDeviceType(deviceType, dn);
1118
2034
  if (lastStateChangeReason === 'agent-wss-disconnect') {
1119
- _loggerProxy.default.info('event=requestAutoStateChange | Requesting state change to available on socket reconnect', {
2035
+ _loggerProxy.default.log('event=requestAutoStateChange | Requesting state change to available on socket reconnect', {
1120
2036
  module: _constants.CC_FILE,
1121
2037
  method: _constants.METHODS.SILENT_RELOGIN
1122
2038
  });
@@ -1140,8 +2056,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
1140
2056
  }
1141
2057
  this.agentConfig.lastStateAuxCodeId = auxCodeId;
1142
2058
  this.agentConfig.isAgentLoggedIn = true;
1143
- // TODO: https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-626777 Implement the de-register method and close the listener there
1144
- this.services.webSocketManager.on('message', this.handleWebsocketMessage);
2059
+ await this.ensureWxAppPostStationLogin();
1145
2060
  _loggerProxy.default.log(`Silent relogin process completed successfully with login Option: ${reLoginResponse.data.deviceType} teamId: ${reLoginResponse.data.teamId}`, {
1146
2061
  module: _constants.CC_FILE,
1147
2062
  method: _constants.METHODS.SILENT_RELOGIN,
@@ -1173,9 +2088,17 @@ class ContactCenter extends _webexCore.WebexPlugin {
1173
2088
  */
1174
2089
  async handleDeviceType(deviceType, dn) {
1175
2090
  this.webCallingService.setLoginOption(deviceType);
2091
+ this.webCallingService.setBrowserVoiceRequired(this.isBrowserVoiceRequired(deviceType));
1176
2092
  this.agentConfig.deviceType = deviceType;
1177
2093
  switch (deviceType) {
1178
2094
  case _types.LoginOption.BROWSER:
2095
+ if (this.isWebRTCRegistrationDisabled()) {
2096
+ _loggerProxy.default.info('Skipping web calling line registration because disableWebRTCRegistration is enabled', {
2097
+ module: _constants.CC_FILE,
2098
+ method: _constants.METHODS.HANDLE_DEVICE_TYPE
2099
+ });
2100
+ break;
2101
+ }
1179
2102
  try {
1180
2103
  await this.webCallingService.registerWebCallingLine();
1181
2104
  } catch (error) {
@@ -1415,6 +2338,138 @@ class ContactCenter extends _webexCore.WebexPlugin {
1415
2338
  }
1416
2339
  }
1417
2340
 
2341
+ /**
2342
+ * Skips a campaign preview contact, requesting the next contact from the campaign.
2343
+ *
2344
+ * When a campaign manager reserves a contact for an agent, the agent receives an
2345
+ * `AgentOfferCampaignReservation` event. Instead of accepting, the agent can skip the
2346
+ * preview contact to move to the next contact in the campaign.
2347
+ *
2348
+ * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
2349
+ * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
2350
+ * @throws {Error} If the operation fails (network error, etc.)
2351
+ *
2352
+ * @example
2353
+ * ```typescript
2354
+ * webex.cc.on('task:campaignPreviewReservation', async (task) => {
2355
+ * const { interactionId } = task.data;
2356
+ * const campaignId = task.data.interaction.callProcessingDetails.campaignId;
2357
+ *
2358
+ * const result = await webex.cc.skipPreviewContact({ interactionId, campaignId });
2359
+ * });
2360
+ * ```
2361
+ */
2362
+ async skipPreviewContact(payload) {
2363
+ const task = this.taskManager.getTask(payload.interactionId);
2364
+ if (task?.data?.interaction?.callProcessingDetails?.campaignPreviewSkipDisabled === 'true') {
2365
+ _loggerProxy.default.warn('Skip action is disabled for this campaign preview contact', {
2366
+ module: _constants.CC_FILE,
2367
+ method: _constants.METHODS.SKIP_PREVIEW_CONTACT,
2368
+ interactionId: payload.interactionId
2369
+ });
2370
+ throw new Error('Skip action is disabled for this campaign preview contact');
2371
+ }
2372
+ _loggerProxy.default.info('Skipping campaign preview contact', {
2373
+ module: _constants.CC_FILE,
2374
+ method: _constants.METHODS.SKIP_PREVIEW_CONTACT
2375
+ });
2376
+ try {
2377
+ this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS, _constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED]);
2378
+ const result = await this.services.dialer.skipPreviewContact({
2379
+ data: payload
2380
+ });
2381
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS, {
2382
+ ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
2383
+ interactionId: payload.interactionId,
2384
+ campaignId: payload.campaignId
2385
+ }, ['behavioral', 'business', 'operational']);
2386
+ _loggerProxy.default.log('Campaign preview contact skipped successfully', {
2387
+ module: _constants.CC_FILE,
2388
+ method: _constants.METHODS.SKIP_PREVIEW_CONTACT,
2389
+ trackingId: result.trackingId,
2390
+ interactionId: payload.interactionId
2391
+ });
2392
+ return result;
2393
+ } catch (error) {
2394
+ const failure = error.details;
2395
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED, {
2396
+ ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
2397
+ interactionId: payload.interactionId,
2398
+ campaignId: payload.campaignId
2399
+ }, ['behavioral', 'business', 'operational']);
2400
+ const {
2401
+ error: detailedError
2402
+ } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.SKIP_PREVIEW_CONTACT, _constants.CC_FILE);
2403
+ throw detailedError;
2404
+ }
2405
+ }
2406
+
2407
+ /**
2408
+ * Removes a campaign preview contact from the campaign list entirely.
2409
+ *
2410
+ * When a campaign manager reserves a contact for an agent, the agent receives an
2411
+ * `AgentOfferCampaignReservation` event. Instead of accepting or skipping, the agent can
2412
+ * remove the preview contact to permanently take it out of the campaign contact list.
2413
+ *
2414
+ * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
2415
+ * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
2416
+ * @throws {Error} If the operation fails (network error, etc.)
2417
+ *
2418
+ * @example
2419
+ * ```typescript
2420
+ * webex.cc.on('task:campaignPreviewReservation', async (task) => {
2421
+ * const { interactionId } = task.data;
2422
+ * const campaignId = task.data.interaction.callProcessingDetails.campaignId;
2423
+ *
2424
+ * const result = await webex.cc.removePreviewContact({ interactionId, campaignId });
2425
+ * });
2426
+ * ```
2427
+ */
2428
+ async removePreviewContact(payload) {
2429
+ const task = this.taskManager.getTask(payload.interactionId);
2430
+ if (task?.data?.interaction?.callProcessingDetails?.campaignPreviewRemoveDisabled === 'true') {
2431
+ _loggerProxy.default.warn('Remove action is disabled for this campaign preview contact', {
2432
+ module: _constants.CC_FILE,
2433
+ method: _constants.METHODS.REMOVE_PREVIEW_CONTACT,
2434
+ interactionId: payload.interactionId
2435
+ });
2436
+ throw new Error('Remove action is disabled for this campaign preview contact');
2437
+ }
2438
+ _loggerProxy.default.info('Removing campaign preview contact', {
2439
+ module: _constants.CC_FILE,
2440
+ method: _constants.METHODS.REMOVE_PREVIEW_CONTACT
2441
+ });
2442
+ try {
2443
+ this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS, _constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED]);
2444
+ const result = await this.services.dialer.removePreviewContact({
2445
+ data: payload
2446
+ });
2447
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS, {
2448
+ ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
2449
+ interactionId: payload.interactionId,
2450
+ campaignId: payload.campaignId
2451
+ }, ['behavioral', 'business', 'operational']);
2452
+ _loggerProxy.default.log('Campaign preview contact removed successfully', {
2453
+ module: _constants.CC_FILE,
2454
+ method: _constants.METHODS.REMOVE_PREVIEW_CONTACT,
2455
+ trackingId: result.trackingId,
2456
+ interactionId: payload.interactionId
2457
+ });
2458
+ return result;
2459
+ } catch (error) {
2460
+ const failure = error.details;
2461
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED, {
2462
+ ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
2463
+ interactionId: payload.interactionId,
2464
+ campaignId: payload.campaignId
2465
+ }, ['behavioral', 'business', 'operational']);
2466
+ const {
2467
+ error: detailedError
2468
+ } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.REMOVE_PREVIEW_CONTACT, _constants.CC_FILE);
2469
+ throw detailedError;
2470
+ }
2471
+ }
2472
+
1418
2473
  /**
1419
2474
  * Fetches outdial ANI (Automatic Number Identification) entries for an outdial ANI ID.
1420
2475
  *
@@ -1619,8 +2674,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
1619
2674
  }
1620
2675
 
1621
2676
  /**
1622
- * Returns paginated entry points for the organization.
1623
- * Thin wrapper around internal EntryPoint instance.
2677
+ * Returns paginated entry points using the EntryPoint service defaults.
2678
+ * Existing request parameters can override those defaults.
1624
2679
  * @public
1625
2680
  */
1626
2681
  async getEntryPoints(params = {}) {
@@ -1628,8 +2683,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
1628
2683
  }
1629
2684
 
1630
2685
  /**
1631
- * Returns paginated contact service queues for the organization.
1632
- * Thin wrapper around internal Queue instance.
2686
+ * Returns paginated contact service queues using the Queue service defaults.
2687
+ * Existing request parameters can override those defaults.
1633
2688
  * @public
1634
2689
  */
1635
2690
  async getQueues(params = {}) {