@webex/contact-center 3.12.0 → 3.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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 +62 -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 +385 -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 +1045 -45
  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 +40 -3
  46. package/dist/constants.js.map +1 -1
  47. package/dist/index.js +54 -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 +10 -2
  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 +97 -24
  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 +197 -9
  149. package/dist/types/config.d.ts +13 -0
  150. package/dist/types/constants.d.ts +38 -1
  151. package/dist/types/index.d.ts +54 -20
  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 +248 -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 +213 -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 +168 -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 +1367 -101
  209. package/src/config.ts +13 -0
  210. package/src/constants.ts +41 -1
  211. package/src/index.ts +62 -15
  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 +16 -2
  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 +233 -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 +272 -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 +3764 -118
  290. package/test/unit/spec/index.ts +885 -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 +45 -1
  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,20 @@ 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.answerCallOnWebexService = new _AnswerCallOnWebexService.default(this.$webex);
393
+ this.webexCrossClientService = new _WebexCrossClientService.default(this.$webex);
394
+ this.wxAppTelephonyMercurySync = new _WxAppTelephonyMercurySync.default(this.$webex);
395
+ this.apiAIAssistant = new _ApiAiAssistant.ApiAIAssistant(this.$webex, () => ({
396
+ isWellnessBreakEnabled: this.agentConfig?.isWellnessBreakEnabled === true,
397
+ agentId: this.agentConfig?.agentId,
398
+ agentSessionId: this.currentAgentSessionId
399
+ }));
318
400
  this.metricsManager = _MetricsManager.default.getInstance({
319
401
  webex: this.$webex
320
402
  });
321
- this.taskManager = _TaskManager.default.getTaskManager(this.apiAIAssistant, this.services.contact, this.webCallingService, this.services.webSocketManager);
403
+ this.taskManager = _TaskManager.default.getTaskManager(this.apiAIAssistant, this.services.contact, this.webCallingService, this.services.webSocketManager, this.services.rtdWebSocketManager);
404
+ this.taskManager.setAnswerCallOnWebexService(this.answerCallOnWebexService);
322
405
  this.incomingTaskListener();
323
406
 
324
407
  // Initialize API instances
@@ -326,6 +409,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
326
409
  this.entryPoint = new _EntryPoint.EntryPoint(this.$webex);
327
410
  this.addressBook = new _AddressBook.AddressBook(this.$webex, () => this.agentConfig?.addressBookId);
328
411
  this.queue = new _Queue.Queue(this.$webex);
412
+ this.userPreference = new _UserPreference.UserPreference(this.$webex, () => this.agentConfig?.agentId);
329
413
  _loggerProxy.default.initialize(this.$webex.logger);
330
414
  });
331
415
  }
@@ -350,6 +434,16 @@ class ContactCenter extends _webexCore.WebexPlugin {
350
434
  this.trigger(_types4.TASK_EVENTS.TASK_HYDRATE, task);
351
435
  };
352
436
 
437
+ /**
438
+ * Handles multi-login hydrate events for SDK instances without Mobius registration
439
+ * @private
440
+ * @param {ITask} task The task object associated with the multi-login hydrate
441
+ */
442
+ handleTaskMultiLoginHydrate = task => {
443
+ // @ts-ignore
444
+ this.trigger(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, task);
445
+ };
446
+
353
447
  /**
354
448
  * Handles task merged events when tasks are combined eg: EPDN merge/transfer
355
449
  * @private
@@ -369,6 +463,84 @@ class ContactCenter extends _webexCore.WebexPlugin {
369
463
  // @ts-ignore
370
464
  this.trigger(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, task);
371
465
  };
466
+ trackInvalidWellnessEvent(reason) {
467
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.AI_ASSISTANT_WELLNESS_EVENT_INVALID, {
468
+ reason
469
+ }, ['operational']);
470
+ }
471
+ normalizeWellnessBreakEvent(payload) {
472
+ if (this.agentConfig?.isWellnessBreakEnabled !== true) {
473
+ this.trackInvalidWellnessEvent('wellness_disabled');
474
+ return null;
475
+ }
476
+ const notificationData = (0, _Utils.isRecord)(payload.data) ? payload.data : null;
477
+ const notificationDetails = notificationData && (0, _Utils.isRecord)(notificationData.notifDetails) ? notificationData.notifDetails : null;
478
+ const sessionData = notificationData && (0, _Utils.isRecord)(notificationData.data) ? notificationData.data : null;
479
+ const actionEvent = notificationDetails?.actionEvent;
480
+ if (payload.type !== _constants.WELLNESS_BREAK_HANDLER || notificationData?.notifType !== _constants.WELLNESS_BREAK_HANDLER || typeof actionEvent !== 'string') {
481
+ this.trackInvalidWellnessEvent('malformed_wellness_event');
482
+ return null;
483
+ }
484
+ if (!Object.values(_types.WELLNESS_BREAK_NOTIFICATION_ACTIONS).includes(actionEvent)) {
485
+ this.trackInvalidWellnessEvent('unknown_wellness_action');
486
+ return null;
487
+ }
488
+ const agentId = notificationData.agentId;
489
+ const eventOrgId = notificationData.orgId;
490
+ const sessionOrgId = sessionData?.orgId;
491
+ const envelopeOrgId = payload.orgId;
492
+ const agentSessionId = sessionData?.agentSessionId;
493
+ const currentOrgId = this.$webex.credentials.getOrgId();
494
+ if (typeof agentId !== 'string' || typeof eventOrgId !== 'string' || typeof sessionOrgId !== 'string' || typeof envelopeOrgId !== 'string' || typeof agentSessionId !== 'string' || !agentId || !eventOrgId || !sessionOrgId || !envelopeOrgId || !agentSessionId) {
495
+ this.trackInvalidWellnessEvent('missing_wellness_identity');
496
+ return null;
497
+ }
498
+ if (agentId !== this.agentConfig?.agentId || eventOrgId !== currentOrgId || sessionOrgId !== currentOrgId || envelopeOrgId !== currentOrgId) {
499
+ this.trackInvalidWellnessEvent('mismatched_wellness_identity');
500
+ return null;
501
+ }
502
+ const interactionValue = sessionData.interactionId ?? sessionData.InteractionId;
503
+ const actionText = notificationDetails.actionText;
504
+ const trackingId = payload.trackingId;
505
+ return {
506
+ agentId,
507
+ orgId: currentOrgId,
508
+ agentSessionId,
509
+ actionEvent: actionEvent,
510
+ ...(typeof actionText === 'string' ? {
511
+ actionText
512
+ } : {}),
513
+ ...(typeof interactionValue === 'string' ? {
514
+ interactionId: interactionValue
515
+ } : {}),
516
+ ...(typeof trackingId === 'string' ? {
517
+ trackingId
518
+ } : {})
519
+ };
520
+ }
521
+ handleWellnessBreakWebsocketPayload(payload) {
522
+ if (payload.type !== _constants.WELLNESS_BREAK_HANDLER) {
523
+ return false;
524
+ }
525
+ const wellnessEvent = this.normalizeWellnessBreakEvent(payload);
526
+ if (wellnessEvent) {
527
+ // @ts-ignore - WebexPlugin emit is available at runtime but absent from its declaration.
528
+ this.emit(_types3.CC_EVENTS.WELLNESS_BREAK, wellnessEvent);
529
+ }
530
+ return true;
531
+ }
532
+ handleRTDWebsocketMessage = event => {
533
+ let payload;
534
+ try {
535
+ payload = JSON.parse(event);
536
+ } catch {
537
+ // TaskManager retains its existing malformed RTD message handling.
538
+ }
539
+ if ((0, _Utils.isRecord)(payload) && this.handleWellnessBreakWebsocketPayload(payload)) {
540
+ return;
541
+ }
542
+ this.taskManager.handleRealtimeWebsocketEvent(event);
543
+ };
372
544
 
373
545
  /**
374
546
  * Sets up event listeners for incoming tasks and task hydration
@@ -378,6 +550,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
378
550
  incomingTaskListener() {
379
551
  this.taskManager.on(_types4.TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
380
552
  this.taskManager.on(_types4.TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
553
+ this.taskManager.on(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this.handleTaskMultiLoginHydrate);
381
554
  this.taskManager.on(_types4.TASK_EVENTS.TASK_MERGED, this.handleTaskMerged);
382
555
  this.taskManager.on(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, this.handleCampaignPreviewReservation);
383
556
  }
@@ -410,22 +583,25 @@ class ContactCenter extends _webexCore.WebexPlugin {
410
583
  *
411
584
  * console.log('Agent ID:', profile.agentId);
412
585
  * console.log('Default DN:', profile.defaultDn);
413
- * console.log('Teams:', profile.teams.map(t => t.teamId));
586
+ * console.log('Teams:', profile.teams.map(t => t.id));
414
587
  * console.log('WebRTC Enabled:', profile.webRtcEnabled);
415
588
  * console.log('Supported Login Options:', profile.loginVoiceOptions);
416
589
  *
417
590
  * // Now you can proceed with station login, state changes, etc.
418
- * await cc.stationLogin({ teamId: profile.teams[0].teamId, loginOption: 'BROWSER' });
591
+ * await cc.stationLogin({ teamId: profile.teams[0].id, loginOption: 'BROWSER' });
419
592
  * ```
420
593
  */
421
594
  async register() {
422
- _loggerProxy.default.info('Starting CC SDK registration', {
595
+ this.wellnessRegistrationGeneration += 1;
596
+ this.wellbeingBreakIdleCode = undefined;
597
+ _loggerProxy.default.log('Starting CC SDK registration', {
423
598
  module: _constants.CC_FILE,
424
599
  method: _constants.METHODS.REGISTER
425
600
  });
426
601
  try {
427
602
  this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_SUCCESS, _constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_FAILED]);
428
603
  this.setupEventListeners();
604
+ this.services.webSocketManager.on('message', this.handleWebsocketMessage);
429
605
  const resp = await this.connectWebsocket();
430
606
  // Ensure 'dn' is always populated from 'defaultDn'
431
607
  resp.dn = resp.defaultDn;
@@ -437,7 +613,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
437
613
  module: _constants.CC_FILE,
438
614
  method: _constants.METHODS.REGISTER
439
615
  });
440
- return resp;
616
+
617
+ // Registration can silently restore a station session without emitting a
618
+ // relogin event. Project the active session for consumers that must
619
+ // recover session-scoped state after a page refresh.
620
+ return resp.isAgentLoggedIn && this.currentAgentSessionId ? {
621
+ ...resp,
622
+ agentSessionId: this.currentAgentSessionId
623
+ } : resp;
441
624
  } catch (error) {
442
625
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WEBSOCKET_REGISTER_FAILED, {
443
626
  orgId: error.orgId
@@ -484,14 +667,25 @@ class ContactCenter extends _webexCore.WebexPlugin {
484
667
  *
485
668
  */
486
669
  async deregister() {
670
+ this.wellnessRegistrationGeneration += 1;
671
+ this.wellbeingBreakIdleCode = undefined;
672
+ this.updateWellnessSession();
487
673
  try {
488
674
  this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_SUCCESS, _constants4.METRIC_EVENT_NAMES.WEBSOCKET_DEREGISTER_FAIL]);
675
+ this.taskManager.clearAISummaryState();
489
676
  this.taskManager.off(_types4.TASK_EVENTS.TASK_INCOMING, this.handleIncomingTask);
490
677
  this.taskManager.off(_types4.TASK_EVENTS.TASK_HYDRATE, this.handleTaskHydrate);
678
+ this.taskManager.off(_types4.TASK_EVENTS.TASK_MULTI_LOGIN_HYDRATE, this.handleTaskMultiLoginHydrate);
491
679
  this.taskManager.off(_types4.TASK_EVENTS.TASK_CAMPAIGN_PREVIEW_RESERVATION, this.handleCampaignPreviewReservation);
492
680
  this.taskManager.unregisterIncomingCallEvent();
493
681
  this.services.webSocketManager.off('message', this.handleWebsocketMessage);
682
+ this.services.rtdWebSocketManager.off('message', this.handleRTDWebsocketMessage);
494
683
  this.services.connectionService.off('connectionLost', this.handleConnectionLost);
684
+ const {
685
+ publishError: wxAppPublishError
686
+ } = await this.teardownWxAppLocalState({
687
+ clearInitFlag: true
688
+ });
495
689
  if (this.agentConfig.webRtcEnabled && this.agentConfig.loginVoiceOptions.includes(_types.LoginOption.BROWSER)) {
496
690
  if (this.$webex.internal.mercury.connected) {
497
691
  this.$webex.internal.mercury.off('online');
@@ -508,9 +702,20 @@ class ContactCenter extends _webexCore.WebexPlugin {
508
702
  if (!this.services.webSocketManager.isSocketClosed) {
509
703
  this.services.webSocketManager.close(false, 'Unregistering the SDK');
510
704
  }
705
+ if (this.services.rtdWebSocketManager && !this.services.rtdWebSocketManager.isSocketClosed) {
706
+ this.services.rtdWebSocketManager.close(false, 'Unregistering the SDK');
707
+ }
708
+ if (this.services.rtdWebSocketManager && !this.services.rtdWebSocketManager.isSocketClosed) {
709
+ this.services.rtdWebSocketManager.close(false, 'Unregistering the RTD websocket');
710
+ }
511
711
 
512
712
  // Clear any cached agent configuration
713
+ this.wellbeingBreakIdleCode = undefined;
513
714
  this.agentConfig = null;
715
+ this.updateWellnessSession();
716
+ if (wxAppPublishError) {
717
+ throw wxAppPublishError;
718
+ }
514
719
  _loggerProxy.default.log('Deregistered successfully', {
515
720
  module: _constants.CC_FILE,
516
721
  method: _constants.METHODS.DEREGISTER
@@ -564,6 +769,12 @@ class ContactCenter extends _webexCore.WebexPlugin {
564
769
  * ```
565
770
  */
566
771
  async getBuddyAgents(data) {
772
+ const {
773
+ action,
774
+ state,
775
+ mediaType = 'telephony'
776
+ } = data;
777
+ const buddyAgentState = state ?? (action === 'Transfer' ? _constants2.AGENT_STATE_AVAILABLE : undefined);
567
778
  _loggerProxy.default.info('Fetching buddy agents', {
568
779
  module: _constants.CC_FILE,
569
780
  method: _constants.METHODS.GET_BUDDY_AGENTS
@@ -573,13 +784,16 @@ class ContactCenter extends _webexCore.WebexPlugin {
573
784
  const resp = await this.services.agent.buddyAgents({
574
785
  data: {
575
786
  agentProfileId: this.agentConfig.agentProfileID,
576
- ...data
787
+ mediaType,
788
+ ...(buddyAgentState ? {
789
+ state: buddyAgentState
790
+ } : {})
577
791
  }
578
792
  });
579
793
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_SUCCESS, {
580
794
  ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(resp),
581
- mediaType: data.mediaType,
582
- buddyAgentState: data.state,
795
+ mediaType,
796
+ buddyAgentState,
583
797
  buddyAgentCount: resp.data.agentList.length
584
798
  }, ['operational']);
585
799
  _loggerProxy.default.log(`Successfully retrieved ${resp.data.agentList.length} buddy agents`, {
@@ -592,8 +806,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
592
806
  const failureResp = error.details;
593
807
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.FETCH_BUDDY_AGENTS_FAILED, {
594
808
  ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failureResp),
595
- mediaType: data.mediaType,
596
- buddyAgentState: data.state
809
+ mediaType,
810
+ buddyAgentState
597
811
  }, ['operational']);
598
812
  const {
599
813
  error: detailedError
@@ -609,13 +823,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
609
823
  * @private
610
824
  */
611
825
  async connectWebsocket() {
612
- _loggerProxy.default.info('Connecting to websocket', {
826
+ _loggerProxy.default.log('Connecting to websocket', {
613
827
  module: _constants.CC_FILE,
614
828
  method: _constants.METHODS.CONNECT_WEBSOCKET
615
829
  });
616
830
  try {
617
831
  const data = await this.services.webSocketManager.initWebSocket({
618
- body: this.getConnectionConfig()
832
+ body: this.getConnectionConfig(),
833
+ resource: _constants3.SUBSCRIBE_API
619
834
  });
620
835
  const agentId = data.agentId;
621
836
  const orgId = this.$webex.credentials.getOrgId();
@@ -624,13 +839,58 @@ class ContactCenter extends _webexCore.WebexPlugin {
624
839
  module: _constants.CC_FILE,
625
840
  method: _constants.METHODS.CONNECT_WEBSOCKET
626
841
  });
627
-
842
+ const configFlags = {
843
+ isEndTaskEnabled: this.agentConfig.isEndTaskEnabled,
844
+ isEndConsultEnabled: this.agentConfig.isEndConsultEnabled,
845
+ webRtcEnabled: this.agentConfig.webRtcEnabled,
846
+ autoWrapup: this.agentConfig.wrapUpData?.wrapUpProps?.autoWrapup ?? false,
847
+ aiFeature: this.agentConfig.aiFeature,
848
+ consultTransfer: {
849
+ allowConsultToQueue: this.agentConfig.allowConsultToQueue,
850
+ accessQueue: this.agentConfig.accessQueue,
851
+ accessEntryPoint: this.agentConfig.accessEntryPoint,
852
+ accessBuddyTeam: this.agentConfig.accessBuddyTeam
853
+ },
854
+ enableWxBetterTogether: this.isWxBetterTogetherEnabled(),
855
+ getWxAppUsersubPublished: () => this.webexCrossClientService.isAnswerCallsStateActive()
856
+ };
857
+ this.taskManager.setConfigFlags(configFlags);
628
858
  // TODO: Make profile a singleton to make it available throughout app/sdk so we dont need to inject info everywhere
629
859
  this.taskManager.setWrapupData(this.agentConfig.wrapUpData);
630
860
  this.taskManager.setAgentId(this.agentConfig.agentId);
861
+ this.taskManager.setAgentName(this.agentConfig.agentName);
631
862
  this.taskManager.setWebRtcEnabled(this.agentConfig.webRtcEnabled);
632
863
  this.apiAIAssistant.setAIFeatureFlags(this.agentConfig.aiFeature);
633
- if (this.agentConfig.webRtcEnabled && this.agentConfig.loginVoiceOptions.includes(_types.LoginOption.BROWSER)) {
864
+ this.wellbeingBreakIdleCode = undefined;
865
+ this.updateWellnessSession();
866
+
867
+ /**
868
+ * RTD websocket currently supports realtime transcripts and suggested responses.
869
+ * Extend this condition when additional AI RTD features are introduced.
870
+ * Wellness break notifications also arrive on this websocket.
871
+ */
872
+ 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) {
873
+ _loggerProxy.default.info('Connecting to RTD websocket', {
874
+ module: _constants.CC_FILE,
875
+ method: _constants.METHODS.CONNECT_WEBSOCKET
876
+ });
877
+ this.services.rtdWebSocketManager.initWebSocket({
878
+ body: this.getConnectionConfig(),
879
+ resource: _constants3.RTD_SUBSCRIBE_API
880
+ }).then(() => {
881
+ _loggerProxy.default.log('RTD websocket connected successfully', {
882
+ module: _constants.CC_FILE,
883
+ method: _constants.METHODS.CONNECT_WEBSOCKET
884
+ });
885
+ this.services.rtdWebSocketManager.on('message', this.handleRTDWebsocketMessage);
886
+ }).catch(error => {
887
+ _loggerProxy.default.error(`Error connecting to RTD websocket ${error}`, {
888
+ module: _constants.CC_FILE,
889
+ method: _constants.METHODS.CONNECT_WEBSOCKET
890
+ });
891
+ });
892
+ }
893
+ if (this.agentConfig.webRtcEnabled && this.agentConfig.loginVoiceOptions.includes(_types.LoginOption.BROWSER) && !this.isWebRTCRegistrationDisabled()) {
634
894
  try {
635
895
  await this.$webex.internal.mercury.connect();
636
896
  _loggerProxy.default.log('Authentication: webex.internal.mercury.connect successful', {
@@ -643,12 +903,23 @@ class ContactCenter extends _webexCore.WebexPlugin {
643
903
  method: _constants.METHODS.CONNECT_WEBSOCKET
644
904
  });
645
905
  }
906
+ } else if (this.isWebRTCRegistrationDisabled()) {
907
+ _loggerProxy.default.info('Skipping Mobius registration because disableWebRTCRegistration is enabled', {
908
+ module: _constants.CC_FILE,
909
+ method: _constants.METHODS.CONNECT_WEBSOCKET
910
+ });
646
911
  }
647
912
  if (this.$config && this.$config.allowAutomatedRelogin) {
648
913
  await this.silentRelogin();
914
+ } else {
915
+ _loggerProxy.default.log('Skipping silent relogin: allowAutomatedRelogin is disabled', {
916
+ module: _constants.CC_FILE,
917
+ method: _constants.METHODS.CONNECT_WEBSOCKET
918
+ });
649
919
  }
650
920
  return this.agentConfig;
651
921
  } catch (error) {
922
+ this.updateWellnessSession();
652
923
  _loggerProxy.default.error(`Error during register: ${error}`, {
653
924
  module: _constants.CC_FILE,
654
925
  method: _constants.METHODS.CONNECT_WEBSOCKET
@@ -686,30 +957,37 @@ class ContactCenter extends _webexCore.WebexPlugin {
686
957
  * ```
687
958
  */
688
959
  async stationLogin(data) {
689
- _loggerProxy.default.info('Starting agent station login', {
960
+ const loggerContext = {
690
961
  module: _constants.CC_FILE,
691
962
  method: _constants.METHODS.STATION_LOGIN
692
- });
963
+ };
693
964
  try {
965
+ _loggerProxy.default.log(`Starting agent station login | loginOption: ${data?.loginOption} teamId: ${data?.teamId}`, loggerContext);
694
966
  this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.STATION_LOGIN_SUCCESS, _constants4.METRIC_EVENT_NAMES.STATION_LOGIN_FAILED]);
695
967
  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;
968
+ if (data.loginOption === _types.LoginOption.AGENT_DN) {
969
+ _loggerProxy.default.log(`Validating dial number | dialPlanEnabled: ${!!this.agentConfig?.dialPlan} | dialPlanEntryCount: ${dialPlanEntries.length}`, loggerContext);
970
+ if (!(0, _Utils.isValidDialNumber)(data.dialNumber, dialPlanEntries)) {
971
+ _loggerProxy.default.log(`Dial number validation failed | dialNumber: ${data.dialNumber} | dialPlanEntryCount: ${dialPlanEntries.length}`, loggerContext);
972
+ const error = new Error('INVALID_DIAL_NUMBER');
973
+ // @ts-ignore - adding custom key to the error object
974
+ error.details = {
975
+ data: {
976
+ reason: 'INVALID_DIAL_NUMBER'
977
+ }
978
+ };
979
+ throw error;
980
+ }
705
981
  }
982
+ const deviceId = this.getDeviceId(data.loginOption, data.dialNumber);
706
983
  const loginResponse = await this.services.agent.stationLogin({
707
984
  data: {
708
- dialNumber: data.loginOption === _types.LoginOption.BROWSER ? this.agentConfig.agentId : data.dialNumber,
985
+ // BROWSER DN must be webrtc-{agentId} so VPOP/RTMS do not treat a bare UUID as PSTN.
986
+ dialNumber: data.loginOption === _types.LoginOption.BROWSER ? deviceId : data.dialNumber,
709
987
  teamId: data.teamId,
710
988
  deviceType: data.loginOption,
711
989
  isExtension: data.loginOption === _types.LoginOption.EXTENSION,
712
- deviceId: this.getDeviceId(data.loginOption, data.dialNumber),
990
+ deviceId,
713
991
  roles: [_constants3.AGENT],
714
992
  teamName: _constants.EMPTY_STRING,
715
993
  siteId: _constants.EMPTY_STRING,
@@ -717,14 +995,20 @@ class ContactCenter extends _webexCore.WebexPlugin {
717
995
  auxCodeId: _constants.EMPTY_STRING
718
996
  }
719
997
  });
720
- if (this.agentConfig.webRtcEnabled && data.loginOption === _types.LoginOption.BROWSER) {
998
+ if (this.agentConfig.webRtcEnabled && data.loginOption === _types.LoginOption.BROWSER && !this.isWebRTCRegistrationDisabled()) {
721
999
  await this.webCallingService.registerWebCallingLine();
1000
+ } else if (this.agentConfig.webRtcEnabled && data.loginOption === _types.LoginOption.BROWSER && this.isWebRTCRegistrationDisabled()) {
1001
+ _loggerProxy.default.info('Skipping web calling line registration because disableWebRTCRegistration is enabled', {
1002
+ module: _constants.CC_FILE,
1003
+ method: _constants.METHODS.STATION_LOGIN
1004
+ });
722
1005
  }
723
1006
  const resp = await loginResponse;
724
1007
  const {
725
1008
  channelsMap,
726
1009
  ...loginData
727
1010
  } = resp.data;
1011
+ this.updateWellnessSession(resp.data.agentSessionId);
728
1012
  this.agentConfig.currentTeamId = resp.data.teamId;
729
1013
  const response = {
730
1014
  ...loginData,
@@ -737,6 +1021,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
737
1021
  notifsTrackingId: resp.trackingId
738
1022
  };
739
1023
  this.webCallingService.setLoginOption(data.loginOption);
1024
+ if (this.agentConfig) {
1025
+ this.agentConfig.deviceType = data.loginOption;
1026
+ if (data.loginOption === _types.LoginOption.AGENT_DN || data.loginOption === _types.LoginOption.EXTENSION) {
1027
+ this.agentConfig.defaultDn = data.dialNumber;
1028
+ this.agentConfig.dn = data.dialNumber;
1029
+ }
1030
+ }
740
1031
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.STATION_LOGIN_SUCCESS, {
741
1032
  ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(resp),
742
1033
  loginType: data.loginOption,
@@ -749,6 +1040,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
749
1040
  method: _constants.METHODS.STATION_LOGIN,
750
1041
  trackingId: resp.trackingId
751
1042
  });
1043
+ await this.ensureWxAppPostStationLogin();
752
1044
  return response;
753
1045
  } catch (error) {
754
1046
  const failure = error.details;
@@ -803,6 +1095,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
803
1095
  if (this.webCallingService) {
804
1096
  this.webCallingService.deregisterWebCallingLine();
805
1097
  }
1098
+ await this.teardownWxAppLocalState();
1099
+ this.updateWellnessSession();
806
1100
  _loggerProxy.default.log(`Agent station logout completed successfully`, {
807
1101
  module: _constants.CC_FILE,
808
1102
  method: _constants.METHODS.STATION_LOGOUT,
@@ -896,7 +1190,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
896
1190
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.AGENT_STATE_CHANGE_SUCCESS, {
897
1191
  ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(agentStatusResponse),
898
1192
  requestedState: data.state,
899
- teamId: this.agentConfig?.teams[0]?.teamId ?? _constants.EMPTY_STRING,
1193
+ teamId: this.agentConfig?.teams[0]?.id ?? _constants.EMPTY_STRING,
900
1194
  status: agentStatusResponse.data?.status,
901
1195
  subStatus: agentStatusResponse.data?.subStatus,
902
1196
  auxCodeId: data.auxCodeId,
@@ -923,6 +1217,63 @@ class ContactCenter extends _webexCore.WebexPlugin {
923
1217
  }
924
1218
  }
925
1219
 
1220
+ /**
1221
+ * Returns the system-managed `WellbeingBreak` idle code for the current registration.
1222
+ * The value is fetched outside Desktop Profile filtering and cached until deregistration.
1223
+ * @returns The normalized system idle-code entity
1224
+ * @throws Structured Contact Center error when wellness is disabled or the code is unavailable
1225
+ * @example
1226
+ * const idleCode = await webex.cc.getWellbeingBreakIdleCode();
1227
+ * @public
1228
+ */
1229
+ async getWellbeingBreakIdleCode() {
1230
+ const method = _constants.METHODS.GET_WELLBEING_BREAK_IDLE_CODE;
1231
+ try {
1232
+ if (!this.agentConfig?.isWellnessBreakEnabled) {
1233
+ const validationError = new Error('WELLNESS_BREAK_NOT_ENABLED');
1234
+ validationError.details = {
1235
+ type: 'SDK_VALIDATION_ERROR',
1236
+ orgId: this.$webex.credentials.getOrgId(),
1237
+ trackingId: _constants.EMPTY_STRING,
1238
+ data: {
1239
+ reason: 'WELLNESS_BREAK_NOT_ENABLED'
1240
+ }
1241
+ };
1242
+ throw validationError;
1243
+ }
1244
+ if (this.wellbeingBreakIdleCode) {
1245
+ return this.wellbeingBreakIdleCode;
1246
+ }
1247
+ this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS, _constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED]);
1248
+ const registrationGeneration = this.wellnessRegistrationGeneration;
1249
+ const orgId = this.$webex.credentials.getOrgId();
1250
+ const idleCode = await this.services.config.getWellbeingBreakIdleCode(orgId);
1251
+ if (registrationGeneration !== this.wellnessRegistrationGeneration || orgId !== this.$webex.credentials.getOrgId() || !this.agentConfig?.isWellnessBreakEnabled) {
1252
+ const staleRegistrationError = new Error('WELLNESS_BREAK_REGISTRATION_CHANGED');
1253
+ staleRegistrationError.details = {
1254
+ type: 'SDK_VALIDATION_ERROR',
1255
+ orgId,
1256
+ trackingId: _constants.EMPTY_STRING,
1257
+ data: {
1258
+ reason: 'WELLNESS_BREAK_REGISTRATION_CHANGED'
1259
+ }
1260
+ };
1261
+ throw staleRegistrationError;
1262
+ }
1263
+ this.wellbeingBreakIdleCode = idleCode;
1264
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS, {}, ['operational']);
1265
+ return idleCode;
1266
+ } catch (error) {
1267
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED, {
1268
+ reason: error instanceof Error ? error.message : _constants.UNKNOWN_ERROR
1269
+ }, ['operational']);
1270
+ const {
1271
+ error: detailedError
1272
+ } = (0, _Utils.getErrorDetails)(error, method, _constants.CC_FILE);
1273
+ throw detailedError;
1274
+ }
1275
+ }
1276
+
926
1277
  /**
927
1278
  * Processes incoming websocket messages and emits corresponding events
928
1279
  * Handles various event types including agent state changes, login events,
@@ -932,8 +1283,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
932
1283
  */
933
1284
  handleWebsocketMessage = event => {
934
1285
  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) {
1286
+ // Re-emit all the events related to agent except keep-alives. Only event names present in
1287
+ // the typed CC_EVENTS allow-list are emitted; unknown/server-injected types are ignored.
1288
+ if (!eventData.keepalive && eventData.data && eventData.data.type && CC_EVENT_ALLOW_LIST.has(eventData.data.type)) {
937
1289
  // @ts-ignore
938
1290
  this.emit(eventData.data.type, eventData.data);
939
1291
  }
@@ -956,8 +1308,14 @@ class ContactCenter extends _webexCore.WebexPlugin {
956
1308
  };
957
1309
  this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WEBSOCKET_EVENT_RECEIVED, metricsPayload, ['operational']);
958
1310
  }
1311
+ if (this.handleWellnessBreakWebsocketPayload(eventData)) {
1312
+ return;
1313
+ }
959
1314
  switch (eventData.type) {
960
1315
  case _types3.CC_EVENTS.AGENT_MULTI_LOGIN:
1316
+ if (eventData.data?.type === 'AgentMultiLoginCloseSession' && (!eventData.data.agentSessionId || eventData.data.agentSessionId === this.currentAgentSessionId)) {
1317
+ this.updateWellnessSession();
1318
+ }
961
1319
  // @ts-ignore
962
1320
  this.emit(_types2.AGENT_EVENTS.AGENT_MULTI_LOGIN, eventData.data);
963
1321
  break;
@@ -978,6 +1336,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
978
1336
  channelsMap,
979
1337
  ...loginData
980
1338
  } = eventData.data;
1339
+ this.updateWellnessSession(loginData.agentSessionId);
981
1340
  const stationLoginData = {
982
1341
  ...loginData,
983
1342
  mmProfile: {
@@ -999,6 +1358,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
999
1358
  channelsMap,
1000
1359
  ...loginData
1001
1360
  } = eventData.data;
1361
+ this.updateWellnessSession(loginData.agentSessionId);
1002
1362
  const stationReLoginData = {
1003
1363
  ...loginData,
1004
1364
  mmProfile: {
@@ -1011,8 +1371,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
1011
1371
  };
1012
1372
  // @ts-ignore
1013
1373
  this.emit(_types2.AGENT_EVENTS.AGENT_RELOGIN_SUCCESS, stationReLoginData);
1374
+ break;
1014
1375
  }
1015
- break;
1016
1376
  case _types3.CC_EVENTS.AGENT_STATE_CHANGE_SUCCESS:
1017
1377
  // @ts-ignore
1018
1378
  this.emit(_types2.AGENT_EVENTS.AGENT_STATE_CHANGE_SUCCESS, eventData.data);
@@ -1026,6 +1386,9 @@ class ContactCenter extends _webexCore.WebexPlugin {
1026
1386
  this.emit(_types2.AGENT_EVENTS.AGENT_STATION_LOGIN_FAILED, eventData.data);
1027
1387
  break;
1028
1388
  case _types3.CC_EVENTS.AGENT_LOGOUT_SUCCESS:
1389
+ if (!eventData.data.agentSessionId || eventData.data.agentSessionId === this.currentAgentSessionId) {
1390
+ this.updateWellnessSession();
1391
+ }
1029
1392
  // @ts-ignore
1030
1393
  this.emit(_types2.AGENT_EVENTS.AGENT_LOGOUT_SUCCESS, eventData.data);
1031
1394
  break;
@@ -1042,6 +1405,504 @@ class ContactCenter extends _webexCore.WebexPlugin {
1042
1405
  }
1043
1406
  };
1044
1407
 
1408
+ /**
1409
+ * Checks whether Mobius/WebRTC registration should be skipped by config
1410
+ * @returns {boolean} True when browser WebRTC registration is disabled
1411
+ * @private
1412
+ */
1413
+ isWebRTCRegistrationDisabled() {
1414
+ return this.$config?.disableWebRTCRegistration === true;
1415
+ }
1416
+
1417
+ /**
1418
+ * Validates contact-center plugin configuration before service initialization
1419
+ * @private
1420
+ */
1421
+ validatePluginConfig() {
1422
+ if (this.$config?.disableWebRTCRegistration === true && this.$config?.allowMultiLogin === false) {
1423
+ 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.');
1424
+ }
1425
+ }
1426
+
1427
+ /**
1428
+ * Whether wxApp thick-client answer is enabled for this SDK instance.
1429
+ * @public
1430
+ */
1431
+ isWxBetterTogetherEnabled() {
1432
+ return this.$config?.enableWxBetterTogether === true;
1433
+ }
1434
+
1435
+ /**
1436
+ * Current station login option (Extension, Dial Number, or Browser/Desktop).
1437
+ * Prefer webCallingService — updated on every stationLogin before wxApp hooks run.
1438
+ * @private
1439
+ */
1440
+ getCurrentStationLoginOption() {
1441
+ return this.webCallingService?.loginOption ?? this.agentConfig?.deviceType;
1442
+ }
1443
+
1444
+ /**
1445
+ * wxApp thick-client answer is supported for Extension and Dial Number station login only —
1446
+ * not Browser/Desktop (WebRTC) login.
1447
+ * @private
1448
+ */
1449
+ assertWxAppStationLoginSupportedForEnable() {
1450
+ const loginOption = this.getCurrentStationLoginOption();
1451
+ if (loginOption !== _types.LoginOption.EXTENSION && loginOption !== _types.LoginOption.AGENT_DN) {
1452
+ throw new Error('setManageWebexCallingInWxcc requires EXTENSION or AGENT_DN station login. Complete station login before enabling.');
1453
+ }
1454
+ }
1455
+
1456
+ /**
1457
+ * Clears runtime wxApp config after logout/deregister so stale flags do not apply on relogin.
1458
+ * @private
1459
+ */
1460
+ resetEnableWxBetterTogetherConfig() {
1461
+ if (this.$config) {
1462
+ this.$config.enableWxBetterTogether = false;
1463
+ }
1464
+ this.taskManager.applyEnableWxBetterTogether(false);
1465
+ }
1466
+
1467
+ /**
1468
+ * Runtime enable/disable for wxApp Better Together (toast suppression + Mercury mute sync).
1469
+ *
1470
+ * **Phase 1 (WXCC-6026 / MMT): NOT part of the public host contract.**
1471
+ * Hosts must set `webexConfig.cc.enableWxBetterTogether` before `webex.init()` / `cc.register()`.
1472
+ * To change the flag after the SDK is initialized, re-init the SDK with the updated config.
1473
+ *
1474
+ * **Supported public read API:** {@link isWxBetterTogetherEnabled}.
1475
+ * **Supported telephony API:** unified `task.accept()`, `task.decline()`, `task.toggleMute()`,
1476
+ * `task.transmitDtmf()` — SDK routes wxApp calls internally when the init flag is active.
1477
+ *
1478
+ * **Production lifecycle does not call this method.** Station login, silent relogin, logout,
1479
+ * and deregister use {@link ensureWxAppPostStationLogin} and {@link teardownWxAppLocalState}
1480
+ * (usersub publish + Mercury subscribe/unsubscribe based on the init flag).
1481
+ *
1482
+ * This setter remains as a **private implementation** for Phase 2 runtime toggle and unit tests.
1483
+ * It updates `$config.enableWxBetterTogether`, TaskManager flags, cross-client usersub
1484
+ * (`answer-calls-on-wxcc`), and Mercury mute sync; rolls back config on publish/connect failure.
1485
+ *
1486
+ * @param enabled - `true` to enable wxApp answer + usersub suppression; `false` to disable and tear down.
1487
+ * @throws When enabling without login, on unsupported BROWSER station login, or when usersub/Mercury init fails.
1488
+ * @internal
1489
+ * @see enableWxBetterTogether (CCPluginConfig init flag)
1490
+ * @see ensureWxAppPostStationLogin
1491
+ * @see teardownWxAppLocalState
1492
+ */
1493
+ async setManageWebexCallingInWxcc(enabled) {
1494
+ if (enabled && !this.$webex.internal.device?.userId) {
1495
+ throw new Error('Cannot publish answer-calls-on-wxcc: user is not logged in');
1496
+ }
1497
+ if (enabled) {
1498
+ this.assertWxAppStationLoginSupportedForEnable();
1499
+ }
1500
+ const previousEnabled = this.isWxBetterTogetherEnabled();
1501
+ if (this.$config) {
1502
+ this.$config.enableWxBetterTogether = enabled;
1503
+ }
1504
+ this.taskManager.applyEnableWxBetterTogether(enabled);
1505
+ let publishedEnable = false;
1506
+ try {
1507
+ if (enabled) {
1508
+ await this.ensureWxAppMercuryAndSubscribe();
1509
+ await this.publishAnswerOnWebexCrossClientState(true);
1510
+ publishedEnable = true;
1511
+ this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
1512
+ this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
1513
+ } else {
1514
+ await this.publishAnswerOnWebexCrossClientState(false);
1515
+ this.wxAppTelephonyMercurySync.unsubscribe();
1516
+ await this.releaseWxAppMercuryResources();
1517
+ }
1518
+ } catch (error) {
1519
+ if (publishedEnable) {
1520
+ await this.revertWxAppCrossClientPublish();
1521
+ } else if (enabled) {
1522
+ this.wxAppTelephonyMercurySync.unsubscribe();
1523
+ await this.releaseWxAppMercuryResources();
1524
+ }
1525
+ if (this.$config) {
1526
+ this.$config.enableWxBetterTogether = previousEnabled;
1527
+ }
1528
+ this.taskManager.applyEnableWxBetterTogether(previousEnabled);
1529
+ throw error;
1530
+ }
1531
+ }
1532
+ getWxAppTelephonyTaskType() {
1533
+ const loginOption = this.getCurrentStationLoginOption();
1534
+ if (loginOption === _types.LoginOption.BROWSER) {
1535
+ return 'WebRTC';
1536
+ }
1537
+ if (loginOption === _types.LoginOption.EXTENSION || loginOption === _types.LoginOption.AGENT_DN) {
1538
+ return 'Voice';
1539
+ }
1540
+ return 'unknown';
1541
+ }
1542
+ async ensureWxAppPostStationLogin() {
1543
+ const loginOption = this.getCurrentStationLoginOption();
1544
+ const flagEnabled = this.isWxBetterTogetherEnabled();
1545
+ const telephonyTaskType = this.getWxAppTelephonyTaskType();
1546
+ if (loginOption === _types.LoginOption.BROWSER) {
1547
+ if (flagEnabled) {
1548
+ (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
1549
+ enableWxBetterTogether: true,
1550
+ loginOption,
1551
+ wxAppHooksApplied: false,
1552
+ usersubPublished: false,
1553
+ mercurySubscribed: false,
1554
+ telephonyTaskType,
1555
+ skipReason: 'unsupported_browser_login'
1556
+ });
1557
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED, {
1558
+ loginOption,
1559
+ enableWxBetterTogether: true,
1560
+ skipReason: 'unsupported_browser_login'
1561
+ }, ['operational', 'behavioral']);
1562
+ }
1563
+ return;
1564
+ }
1565
+ let publishedEnable = false;
1566
+ let wxAppInitStage = 'mercury';
1567
+ try {
1568
+ if (flagEnabled) {
1569
+ this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS, _constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED]);
1570
+ await this.ensureWxAppMercuryAndSubscribe();
1571
+ wxAppInitStage = 'publish';
1572
+ await this.publishAnswerOnWebexCrossClientState(true);
1573
+ publishedEnable = true;
1574
+ this.taskManager.syncWxAppMuteFromCallDetailsForAllTasks();
1575
+ this.taskManager.refreshWxAppOfferObservabilityForAllTasks();
1576
+ const mercurySubscribed = this.wxAppTelephonyMercurySync.isSubscribed();
1577
+ const usersubPublished = this.webexCrossClientService.isAnswerCallsStateActive();
1578
+ (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
1579
+ enableWxBetterTogether: true,
1580
+ loginOption,
1581
+ wxAppHooksApplied: true,
1582
+ usersubPublished,
1583
+ mercurySubscribed,
1584
+ telephonyTaskType
1585
+ });
1586
+ const sessionInitReady = mercurySubscribed && usersubPublished;
1587
+ if (sessionInitReady) {
1588
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_SUCCESS, {
1589
+ loginOption,
1590
+ enableWxBetterTogether: true,
1591
+ usersubPublished,
1592
+ mercurySubscribed,
1593
+ telephonyTaskType
1594
+ }, ['operational', 'behavioral']);
1595
+ } else {
1596
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED, {
1597
+ loginOption,
1598
+ enableWxBetterTogether: true,
1599
+ usersubPublished,
1600
+ mercurySubscribed,
1601
+ telephonyTaskType,
1602
+ skipReason: !usersubPublished ? 'usersub_not_published' : 'mercury_not_subscribed'
1603
+ }, ['operational', 'behavioral']);
1604
+ }
1605
+ } else {
1606
+ await this.ensureWxAppDeviceRegistered();
1607
+ await this.publishAnswerOnWebexCrossClientState(false, {
1608
+ force: true
1609
+ });
1610
+ this.webexCrossClientService.teardown();
1611
+ this.wxAppTelephonyMercurySync.unsubscribe();
1612
+ await this.releaseWxAppMercuryResources();
1613
+ (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
1614
+ enableWxBetterTogether: false,
1615
+ loginOption,
1616
+ wxAppHooksApplied: true,
1617
+ usersubPublished: false,
1618
+ mercurySubscribed: false,
1619
+ telephonyTaskType,
1620
+ skipReason: 'flag_disabled'
1621
+ });
1622
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_SKIPPED, {
1623
+ loginOption,
1624
+ enableWxBetterTogether: false,
1625
+ skipReason: 'flag_disabled'
1626
+ }, ['operational', 'behavioral']);
1627
+ }
1628
+ } catch (error) {
1629
+ _loggerProxy.default.error(`Failed to initialize wxApp post-station-login: ${error}`, {
1630
+ module: _constants.CC_FILE,
1631
+ method: _constants.METHODS.STATION_LOGIN
1632
+ });
1633
+ if (flagEnabled) {
1634
+ const sessionInitFailureReason = wxAppInitStage === 'mercury' ? 'mercury_subscribe_failed' : 'publish_failed';
1635
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_SESSION_INIT_FAILED, {
1636
+ loginOption,
1637
+ enableWxBetterTogether: true,
1638
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
1639
+ mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
1640
+ telephonyTaskType,
1641
+ skipReason: sessionInitFailureReason,
1642
+ error: error instanceof Error ? error.toString() : String(error)
1643
+ }, ['operational', 'behavioral']);
1644
+ (0, _wxAppDiagnosticLogging.logWxAppSessionReadiness)({
1645
+ enableWxBetterTogether: true,
1646
+ loginOption,
1647
+ wxAppHooksApplied: false,
1648
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
1649
+ mercurySubscribed: this.wxAppTelephonyMercurySync.isSubscribed(),
1650
+ telephonyTaskType,
1651
+ skipReason: sessionInitFailureReason
1652
+ });
1653
+ if (publishedEnable) {
1654
+ await this.revertWxAppCrossClientPublish();
1655
+ } else {
1656
+ this.wxAppTelephonyMercurySync.unsubscribe();
1657
+ await this.releaseWxAppMercuryResources();
1658
+ }
1659
+ this.resetEnableWxBetterTogetherConfig();
1660
+ } else {
1661
+ this.scheduleForcedFalsePublishRetry();
1662
+ }
1663
+ }
1664
+ }
1665
+ clearWxAppFalsePublishRetryTimer() {
1666
+ if (this.wxAppFalsePublishRetryTimer) {
1667
+ clearTimeout(this.wxAppFalsePublishRetryTimer);
1668
+ this.wxAppFalsePublishRetryTimer = undefined;
1669
+ }
1670
+ }
1671
+ scheduleForcedFalsePublishRetry(retryAttempt = 0) {
1672
+ this.scheduleFalsePublishRetry(retryAttempt, {
1673
+ requireDisabled: true
1674
+ });
1675
+ }
1676
+
1677
+ /**
1678
+ * Retries compensating false publish after rollback failure, regardless of enabled flag.
1679
+ * @private
1680
+ */
1681
+ scheduleCompensatingFalsePublishRetry(retryAttempt = 0) {
1682
+ this.scheduleFalsePublishRetry(retryAttempt);
1683
+ }
1684
+ scheduleFalsePublishRetry(retryAttempt = 0, options = {}) {
1685
+ if (retryAttempt >= ContactCenter.WXAPP_FALSE_PUBLISH_MAX_RETRIES) {
1686
+ return;
1687
+ }
1688
+ if (options?.requireDisabled && this.isWxBetterTogetherEnabled()) {
1689
+ return;
1690
+ }
1691
+ this.clearWxAppFalsePublishRetryTimer();
1692
+ this.wxAppFalsePublishRetryTimer = setTimeout(async () => {
1693
+ this.wxAppFalsePublishRetryTimer = undefined;
1694
+ if (options?.requireDisabled && this.isWxBetterTogetherEnabled()) {
1695
+ return;
1696
+ }
1697
+ if (!options?.requireDisabled && this.isWxBetterTogetherEnabled() && this.webexCrossClientService.isAnswerCallsStateActive()) {
1698
+ return;
1699
+ }
1700
+ try {
1701
+ await this.ensureWxAppDeviceRegistered();
1702
+ await this.publishAnswerOnWebexCrossClientState(false, {
1703
+ force: true
1704
+ });
1705
+ this.webexCrossClientService.teardown();
1706
+ this.wxAppTelephonyMercurySync.unsubscribe();
1707
+ await this.releaseWxAppMercuryResources();
1708
+ } catch (retryError) {
1709
+ _loggerProxy.default.error(`Failed to retry forced answer-calls-on-wxcc false publish: ${retryError}`, {
1710
+ module: _constants.CC_FILE,
1711
+ method: _constants.METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC
1712
+ });
1713
+ this.scheduleFalsePublishRetry(retryAttempt + 1, options);
1714
+ }
1715
+ }, ContactCenter.WXAPP_FALSE_PUBLISH_RETRY_DELAY_MS);
1716
+ }
1717
+
1718
+ /**
1719
+ * Best-effort rollback when usersub true was published but wxApp setup did not complete.
1720
+ * @private
1721
+ */
1722
+ async revertWxAppCrossClientPublish() {
1723
+ try {
1724
+ await this.publishAnswerOnWebexCrossClientState(false, {
1725
+ force: true
1726
+ });
1727
+ } catch (error) {
1728
+ _loggerProxy.default.error(`Failed to publish compensating answer-calls-on-wxcc false during wxApp rollback: ${error}`, {
1729
+ module: _constants.CC_FILE,
1730
+ method: _constants.METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC
1731
+ });
1732
+ this.scheduleCompensatingFalsePublishRetry();
1733
+ }
1734
+ this.webexCrossClientService.teardown();
1735
+ this.wxAppTelephonyMercurySync.unsubscribe();
1736
+ await this.releaseWxAppMercuryResources();
1737
+ }
1738
+ async ensureWxAppDeviceRegistered() {
1739
+ const device = this.$webex.internal.device;
1740
+ if (device && !device.registered && device.register) {
1741
+ await device.register();
1742
+ this.wxAppDeviceRegisteredByCc = true;
1743
+ _loggerProxy.default.log('WxApp: device registered for cross-client publish', {
1744
+ module: _constants.CC_FILE,
1745
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1746
+ });
1747
+ }
1748
+ }
1749
+ async ensureWxAppMercuryConnected() {
1750
+ const mercury = this.$webex.internal.mercury;
1751
+ await this.ensureWxAppDeviceRegistered();
1752
+ if (mercury && !mercury.connected) {
1753
+ await mercury.connect();
1754
+ this.wxAppMercuryConnectedByCc = true;
1755
+ _loggerProxy.default.log('WxApp mute sync: mercury connected', {
1756
+ module: _constants.CC_FILE,
1757
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1758
+ });
1759
+ }
1760
+ }
1761
+
1762
+ /**
1763
+ * Disconnects Mercury and unregisters the device when wxApp mute sync opened them.
1764
+ * @private
1765
+ */
1766
+ async releaseWxAppMercuryResources() {
1767
+ const mercury = this.$webex.internal.mercury;
1768
+ const device = this.$webex.internal.device;
1769
+ if (this.wxAppMercuryConnectedByCc && mercury?.connected) {
1770
+ try {
1771
+ await mercury.disconnect();
1772
+ this.wxAppMercuryConnectedByCc = false;
1773
+ _loggerProxy.default.log('WxApp mute sync: mercury disconnected', {
1774
+ module: _constants.CC_FILE,
1775
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1776
+ });
1777
+ } catch (error) {
1778
+ _loggerProxy.default.error(`Failed to disconnect wxApp Mercury: ${error}`, {
1779
+ module: _constants.CC_FILE,
1780
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1781
+ });
1782
+ }
1783
+ }
1784
+ if (this.wxAppDeviceRegisteredByCc && device?.registered && device.unregister) {
1785
+ try {
1786
+ // @ts-ignore
1787
+ await device.unregister();
1788
+ this.wxAppDeviceRegisteredByCc = false;
1789
+ _loggerProxy.default.log('WxApp mute sync: device unregistered', {
1790
+ module: _constants.CC_FILE,
1791
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1792
+ });
1793
+ } catch (error) {
1794
+ _loggerProxy.default.error(`Failed to unregister wxApp device: ${error}`, {
1795
+ module: _constants.CC_FILE,
1796
+ method: _constants.METHODS.ENSURE_WXAPP_MERCURY_CONNECTED
1797
+ });
1798
+ }
1799
+ } else if (this.wxAppDeviceRegisteredByCc) {
1800
+ this.wxAppDeviceRegisteredByCc = false;
1801
+ }
1802
+ }
1803
+
1804
+ /**
1805
+ * Clears wxApp runtime state and feature-owned resources. Publish failures are logged;
1806
+ * optional rethrow for deregister when callers need to surface usersub errors.
1807
+ * @private
1808
+ */
1809
+ async teardownWxAppLocalState(options) {
1810
+ this.clearWxAppFalsePublishRetryTimer();
1811
+ let publishError;
1812
+ try {
1813
+ const shouldForceFalsePublish = this.isWxBetterTogetherEnabled() || this.webexCrossClientService.isAnswerCallsStateActive();
1814
+ await this.publishAnswerOnWebexCrossClientState(false, {
1815
+ force: shouldForceFalsePublish
1816
+ });
1817
+ } catch (error) {
1818
+ publishError = error;
1819
+ _loggerProxy.default.error(`Failed to publish answer-calls-on-wxcc false during wxApp teardown: ${error}`, {
1820
+ module: _constants.CC_FILE,
1821
+ method: _constants.METHODS.SET_MANAGE_WEBEX_CALLING_IN_WXCC
1822
+ });
1823
+ }
1824
+ this.webexCrossClientService.teardown();
1825
+ this.wxAppTelephonyMercurySync.unsubscribe();
1826
+ await this.releaseWxAppMercuryResources();
1827
+ if (options?.clearInitFlag) {
1828
+ this.resetEnableWxBetterTogetherConfig();
1829
+ }
1830
+ if (publishError) {
1831
+ this.scheduleCompensatingFalsePublishRetry();
1832
+ }
1833
+ if (options?.rethrowPublishError && publishError) {
1834
+ throw publishError;
1835
+ }
1836
+ return {
1837
+ publishError: publishError ?? undefined
1838
+ };
1839
+ }
1840
+ async ensureWxAppMercuryAndSubscribe() {
1841
+ if (!this.isWxBetterTogetherEnabled()) {
1842
+ return;
1843
+ }
1844
+ if (this.getCurrentStationLoginOption() === _types.LoginOption.BROWSER) {
1845
+ return;
1846
+ }
1847
+ const agentId = this.agentConfig?.agentId;
1848
+ if (!agentId) {
1849
+ _loggerProxy.default.error('Cannot subscribe wxApp mute sync: agentId unavailable', {
1850
+ module: _constants.CC_FILE,
1851
+ method: _constants.METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY
1852
+ });
1853
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED, {
1854
+ error: 'agentId unavailable',
1855
+ mercurySubscribed: false
1856
+ }, ['operational', 'behavioral']);
1857
+ return;
1858
+ }
1859
+ try {
1860
+ await this.ensureWxAppMercuryConnected();
1861
+ this.wxAppTelephonyMercurySync.subscribe(agentId, (callId, muted) => {
1862
+ this.taskManager.applyWxAppMuteStateFromSync(callId, muted);
1863
+ });
1864
+ } catch (error) {
1865
+ _loggerProxy.default.error(`Failed to ensure wxApp Mercury mute sync: ${error}`, {
1866
+ module: _constants.CC_FILE,
1867
+ method: _constants.METHODS.SYNC_WXAPP_MUTE_FROM_MERCURY
1868
+ });
1869
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_MERCURY_SUBSCRIBE_FAILED, {
1870
+ error: error instanceof Error ? error.toString() : String(error),
1871
+ mercurySubscribed: false
1872
+ }, ['operational', 'behavioral']);
1873
+ this.wxAppTelephonyMercurySync.unsubscribe();
1874
+ await this.releaseWxAppMercuryResources();
1875
+ throw error;
1876
+ }
1877
+ }
1878
+ async publishAnswerOnWebexCrossClientState(enable, options) {
1879
+ if (enable && !this.isWxBetterTogetherEnabled()) {
1880
+ return;
1881
+ }
1882
+ if (!enable && !options?.force && !this.webexCrossClientService.isAnswerCallsStateActive()) {
1883
+ return;
1884
+ }
1885
+ const userId = this.$webex.internal.device?.userId;
1886
+ if (!userId) {
1887
+ if (enable && this.isWxBetterTogetherEnabled()) {
1888
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.WXAPP_USERSUB_PUBLISH_FAILED, {
1889
+ enableWxBetterTogether: true,
1890
+ usersubPublished: this.webexCrossClientService.isAnswerCallsStateActive(),
1891
+ skipReason: 'user_id_unavailable',
1892
+ error: 'User ID is unavailable for cross-client publish'
1893
+ }, ['operational', 'behavioral']);
1894
+ }
1895
+ return;
1896
+ }
1897
+ await this.webexCrossClientService.setManageWebexCallingInWxcc(enable, {
1898
+ userId,
1899
+ trackPublishMetrics: true
1900
+ });
1901
+ if (enable) {
1902
+ this.clearWxAppFalsePublishRetryTimer();
1903
+ }
1904
+ }
1905
+
1045
1906
  /**
1046
1907
  * Initializes event listeners for the Contact Center service
1047
1908
  * Sets up handlers for connection state changes and other core events
@@ -1073,13 +1934,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
1073
1934
  async handleConnectionLost(msg) {
1074
1935
  if (msg.isConnectionLost) {
1075
1936
  // TODO: Emit an event saying connection is lost
1076
- _loggerProxy.default.info('event=handleConnectionLost | Connection lost', {
1937
+ _loggerProxy.default.log('event=handleConnectionLost | Connection lost', {
1077
1938
  module: _constants.CC_FILE,
1078
1939
  method: _constants.METHODS.HANDLE_CONNECTION_LOST
1079
1940
  });
1080
1941
  } else if (msg.isSocketReconnected) {
1081
1942
  // TODO: Emit an event saying connection is re-estabilished
1082
- _loggerProxy.default.info('event=handleConnectionReconnect | Connection reconnected attempting to request silent relogin', {
1943
+ _loggerProxy.default.log('event=handleConnectionReconnect | Connection reconnected attempting to request silent relogin', {
1083
1944
  module: _constants.CC_FILE,
1084
1945
  method: _constants.METHODS.HANDLE_CONNECTION_LOST
1085
1946
  });
@@ -1094,12 +1955,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
1094
1955
  * @private
1095
1956
  */
1096
1957
  async silentRelogin() {
1097
- _loggerProxy.default.info('Starting silent relogin process', {
1958
+ _loggerProxy.default.log('Starting silent relogin process', {
1098
1959
  module: _constants.CC_FILE,
1099
1960
  method: _constants.METHODS.SILENT_RELOGIN
1100
1961
  });
1101
1962
  try {
1102
1963
  const reLoginResponse = await this.services.agent.reload();
1964
+ this.updateWellnessSession(reLoginResponse.data.agentSessionId);
1103
1965
  const {
1104
1966
  agentId,
1105
1967
  lastStateChangeReason,
@@ -1116,7 +1978,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
1116
1978
  this.agentConfig.currentTeamId = reLoginResponse.data.teamId;
1117
1979
  await this.handleDeviceType(deviceType, dn);
1118
1980
  if (lastStateChangeReason === 'agent-wss-disconnect') {
1119
- _loggerProxy.default.info('event=requestAutoStateChange | Requesting state change to available on socket reconnect', {
1981
+ _loggerProxy.default.log('event=requestAutoStateChange | Requesting state change to available on socket reconnect', {
1120
1982
  module: _constants.CC_FILE,
1121
1983
  method: _constants.METHODS.SILENT_RELOGIN
1122
1984
  });
@@ -1140,8 +2002,7 @@ class ContactCenter extends _webexCore.WebexPlugin {
1140
2002
  }
1141
2003
  this.agentConfig.lastStateAuxCodeId = auxCodeId;
1142
2004
  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);
2005
+ await this.ensureWxAppPostStationLogin();
1145
2006
  _loggerProxy.default.log(`Silent relogin process completed successfully with login Option: ${reLoginResponse.data.deviceType} teamId: ${reLoginResponse.data.teamId}`, {
1146
2007
  module: _constants.CC_FILE,
1147
2008
  method: _constants.METHODS.SILENT_RELOGIN,
@@ -1176,6 +2037,13 @@ class ContactCenter extends _webexCore.WebexPlugin {
1176
2037
  this.agentConfig.deviceType = deviceType;
1177
2038
  switch (deviceType) {
1178
2039
  case _types.LoginOption.BROWSER:
2040
+ if (this.isWebRTCRegistrationDisabled()) {
2041
+ _loggerProxy.default.info('Skipping web calling line registration because disableWebRTCRegistration is enabled', {
2042
+ module: _constants.CC_FILE,
2043
+ method: _constants.METHODS.HANDLE_DEVICE_TYPE
2044
+ });
2045
+ break;
2046
+ }
1179
2047
  try {
1180
2048
  await this.webCallingService.registerWebCallingLine();
1181
2049
  } catch (error) {
@@ -1415,6 +2283,138 @@ class ContactCenter extends _webexCore.WebexPlugin {
1415
2283
  }
1416
2284
  }
1417
2285
 
2286
+ /**
2287
+ * Skips a campaign preview contact, requesting the next contact from the campaign.
2288
+ *
2289
+ * When a campaign manager reserves a contact for an agent, the agent receives an
2290
+ * `AgentOfferCampaignReservation` event. Instead of accepting, the agent can skip the
2291
+ * preview contact to move to the next contact in the campaign.
2292
+ *
2293
+ * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
2294
+ * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
2295
+ * @throws {Error} If the operation fails (network error, etc.)
2296
+ *
2297
+ * @example
2298
+ * ```typescript
2299
+ * webex.cc.on('task:campaignPreviewReservation', async (task) => {
2300
+ * const { interactionId } = task.data;
2301
+ * const campaignId = task.data.interaction.callProcessingDetails.campaignId;
2302
+ *
2303
+ * const result = await webex.cc.skipPreviewContact({ interactionId, campaignId });
2304
+ * });
2305
+ * ```
2306
+ */
2307
+ async skipPreviewContact(payload) {
2308
+ const task = this.taskManager.getTask(payload.interactionId);
2309
+ if (task?.data?.interaction?.callProcessingDetails?.campaignPreviewSkipDisabled === 'true') {
2310
+ _loggerProxy.default.warn('Skip action is disabled for this campaign preview contact', {
2311
+ module: _constants.CC_FILE,
2312
+ method: _constants.METHODS.SKIP_PREVIEW_CONTACT,
2313
+ interactionId: payload.interactionId
2314
+ });
2315
+ throw new Error('Skip action is disabled for this campaign preview contact');
2316
+ }
2317
+ _loggerProxy.default.info('Skipping campaign preview contact', {
2318
+ module: _constants.CC_FILE,
2319
+ method: _constants.METHODS.SKIP_PREVIEW_CONTACT
2320
+ });
2321
+ try {
2322
+ this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS, _constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED]);
2323
+ const result = await this.services.dialer.skipPreviewContact({
2324
+ data: payload
2325
+ });
2326
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS, {
2327
+ ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
2328
+ interactionId: payload.interactionId,
2329
+ campaignId: payload.campaignId
2330
+ }, ['behavioral', 'business', 'operational']);
2331
+ _loggerProxy.default.log('Campaign preview contact skipped successfully', {
2332
+ module: _constants.CC_FILE,
2333
+ method: _constants.METHODS.SKIP_PREVIEW_CONTACT,
2334
+ trackingId: result.trackingId,
2335
+ interactionId: payload.interactionId
2336
+ });
2337
+ return result;
2338
+ } catch (error) {
2339
+ const failure = error.details;
2340
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED, {
2341
+ ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
2342
+ interactionId: payload.interactionId,
2343
+ campaignId: payload.campaignId
2344
+ }, ['behavioral', 'business', 'operational']);
2345
+ const {
2346
+ error: detailedError
2347
+ } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.SKIP_PREVIEW_CONTACT, _constants.CC_FILE);
2348
+ throw detailedError;
2349
+ }
2350
+ }
2351
+
2352
+ /**
2353
+ * Removes a campaign preview contact from the campaign list entirely.
2354
+ *
2355
+ * When a campaign manager reserves a contact for an agent, the agent receives an
2356
+ * `AgentOfferCampaignReservation` event. Instead of accepting or skipping, the agent can
2357
+ * remove the preview contact to permanently take it out of the campaign contact list.
2358
+ *
2359
+ * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
2360
+ * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
2361
+ * @throws {Error} If the operation fails (network error, etc.)
2362
+ *
2363
+ * @example
2364
+ * ```typescript
2365
+ * webex.cc.on('task:campaignPreviewReservation', async (task) => {
2366
+ * const { interactionId } = task.data;
2367
+ * const campaignId = task.data.interaction.callProcessingDetails.campaignId;
2368
+ *
2369
+ * const result = await webex.cc.removePreviewContact({ interactionId, campaignId });
2370
+ * });
2371
+ * ```
2372
+ */
2373
+ async removePreviewContact(payload) {
2374
+ const task = this.taskManager.getTask(payload.interactionId);
2375
+ if (task?.data?.interaction?.callProcessingDetails?.campaignPreviewRemoveDisabled === 'true') {
2376
+ _loggerProxy.default.warn('Remove action is disabled for this campaign preview contact', {
2377
+ module: _constants.CC_FILE,
2378
+ method: _constants.METHODS.REMOVE_PREVIEW_CONTACT,
2379
+ interactionId: payload.interactionId
2380
+ });
2381
+ throw new Error('Remove action is disabled for this campaign preview contact');
2382
+ }
2383
+ _loggerProxy.default.info('Removing campaign preview contact', {
2384
+ module: _constants.CC_FILE,
2385
+ method: _constants.METHODS.REMOVE_PREVIEW_CONTACT
2386
+ });
2387
+ try {
2388
+ this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS, _constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED]);
2389
+ const result = await this.services.dialer.removePreviewContact({
2390
+ data: payload
2391
+ });
2392
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS, {
2393
+ ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
2394
+ interactionId: payload.interactionId,
2395
+ campaignId: payload.campaignId
2396
+ }, ['behavioral', 'business', 'operational']);
2397
+ _loggerProxy.default.log('Campaign preview contact removed successfully', {
2398
+ module: _constants.CC_FILE,
2399
+ method: _constants.METHODS.REMOVE_PREVIEW_CONTACT,
2400
+ trackingId: result.trackingId,
2401
+ interactionId: payload.interactionId
2402
+ });
2403
+ return result;
2404
+ } catch (error) {
2405
+ const failure = error.details;
2406
+ this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED, {
2407
+ ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
2408
+ interactionId: payload.interactionId,
2409
+ campaignId: payload.campaignId
2410
+ }, ['behavioral', 'business', 'operational']);
2411
+ const {
2412
+ error: detailedError
2413
+ } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.REMOVE_PREVIEW_CONTACT, _constants.CC_FILE);
2414
+ throw detailedError;
2415
+ }
2416
+ }
2417
+
1418
2418
  /**
1419
2419
  * Fetches outdial ANI (Automatic Number Identification) entries for an outdial ANI ID.
1420
2420
  *
@@ -1619,8 +2619,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
1619
2619
  }
1620
2620
 
1621
2621
  /**
1622
- * Returns paginated entry points for the organization.
1623
- * Thin wrapper around internal EntryPoint instance.
2622
+ * Returns paginated entry points using the EntryPoint service defaults.
2623
+ * Existing request parameters can override those defaults.
1624
2624
  * @public
1625
2625
  */
1626
2626
  async getEntryPoints(params = {}) {
@@ -1628,8 +2628,8 @@ class ContactCenter extends _webexCore.WebexPlugin {
1628
2628
  }
1629
2629
 
1630
2630
  /**
1631
- * Returns paginated contact service queues for the organization.
1632
- * Thin wrapper around internal Queue instance.
2631
+ * Returns paginated contact service queues using the Queue service defaults.
2632
+ * Existing request parameters can override those defaults.
1633
2633
  * @public
1634
2634
  */
1635
2635
  async getQueues(params = {}) {