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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (250) hide show
  1. package/.sdd/manifest.json +24 -13
  2. package/ai-docs/ARCHITECTURE.md +1 -1
  3. package/ai-docs/CONTRACTS.md +21 -3
  4. package/ai-docs/SECURITY.md +1 -1
  5. package/ai-docs/SERVICE_STATE.md +4 -0
  6. package/ai-docs/contact-center-spec.md +53 -6
  7. package/ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md +362 -0
  8. package/ai-docs/features/contact-owner-change-refactor.md +78 -0
  9. package/dist/cc.js +816 -26
  10. package/dist/cc.js.map +1 -1
  11. package/dist/config.js +7 -0
  12. package/dist/config.js.map +1 -1
  13. package/dist/constants.js +29 -2
  14. package/dist/constants.js.map +1 -1
  15. package/dist/index.js +66 -12
  16. package/dist/index.js.map +1 -1
  17. package/dist/metrics/MetricsManager.js +16 -0
  18. package/dist/metrics/MetricsManager.js.map +1 -1
  19. package/dist/metrics/behavioral-events.js +110 -0
  20. package/dist/metrics/behavioral-events.js.map +1 -1
  21. package/dist/metrics/constants.js +33 -0
  22. package/dist/metrics/constants.js.map +1 -1
  23. package/dist/services/AddressBook.js +18 -15
  24. package/dist/services/AddressBook.js.map +1 -1
  25. package/dist/services/AnswerCallOnWebexService.js +202 -0
  26. package/dist/services/AnswerCallOnWebexService.js.map +1 -0
  27. package/dist/services/ApiAiAssistant.js +221 -11
  28. package/dist/services/ApiAiAssistant.js.map +1 -1
  29. package/dist/services/EntryPoint.js +46 -68
  30. package/dist/services/EntryPoint.js.map +1 -1
  31. package/dist/services/Queue.js +27 -22
  32. package/dist/services/Queue.js.map +1 -1
  33. package/dist/services/WebCallingService.js +287 -37
  34. package/dist/services/WebCallingService.js.map +1 -1
  35. package/dist/services/WebexCrossClientService.js +225 -0
  36. package/dist/services/WebexCrossClientService.js.map +1 -0
  37. package/dist/services/WxAppTelephonyMercurySync.js +111 -0
  38. package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
  39. package/dist/services/config/Util.js +46 -46
  40. package/dist/services/config/Util.js.map +1 -1
  41. package/dist/services/config/constants.js +34 -77
  42. package/dist/services/config/constants.js.map +1 -1
  43. package/dist/services/config/index.js +100 -226
  44. package/dist/services/config/index.js.map +1 -1
  45. package/dist/services/config/types.js +55 -35
  46. package/dist/services/config/types.js.map +1 -1
  47. package/dist/services/constants.js +11 -1
  48. package/dist/services/constants.js.map +1 -1
  49. package/dist/services/core/Err.js.map +1 -1
  50. package/dist/services/core/Utils.js +25 -1
  51. package/dist/services/core/Utils.js.map +1 -1
  52. package/dist/services/core/WebexRequest.js +6 -2
  53. package/dist/services/core/WebexRequest.js.map +1 -1
  54. package/dist/services/core/aqm-reqs.js +17 -11
  55. package/dist/services/core/aqm-reqs.js.map +1 -1
  56. package/dist/services/core/constants.js +9 -1
  57. package/dist/services/core/constants.js.map +1 -1
  58. package/dist/services/core/types.js.map +1 -1
  59. package/dist/services/core/websocket/WebSocketManager.js +17 -1
  60. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  61. package/dist/services/task/Task.js +275 -8
  62. package/dist/services/task/Task.js.map +1 -1
  63. package/dist/services/task/TaskFactory.js +11 -6
  64. package/dist/services/task/TaskFactory.js.map +1 -1
  65. package/dist/services/task/TaskManager.js +590 -42
  66. package/dist/services/task/TaskManager.js.map +1 -1
  67. package/dist/services/task/TaskUtils.js +11 -1
  68. package/dist/services/task/TaskUtils.js.map +1 -1
  69. package/dist/services/task/WebexCallingUtils.js +70 -0
  70. package/dist/services/task/WebexCallingUtils.js.map +1 -0
  71. package/dist/services/task/constants.js +14 -2
  72. package/dist/services/task/constants.js.map +1 -1
  73. package/dist/services/task/contact.js +29 -0
  74. package/dist/services/task/contact.js.map +1 -1
  75. package/dist/services/task/digital/Digital.js +4 -3
  76. package/dist/services/task/digital/Digital.js.map +1 -1
  77. package/dist/services/task/state-machine/TaskStateMachine.js +162 -53
  78. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -1
  79. package/dist/services/task/state-machine/actions.js +6 -1
  80. package/dist/services/task/state-machine/actions.js.map +1 -1
  81. package/dist/services/task/state-machine/guards.js +7 -10
  82. package/dist/services/task/state-machine/guards.js.map +1 -1
  83. package/dist/services/task/state-machine/types.js.map +1 -1
  84. package/dist/services/task/state-machine/uiControlsComputer.js +118 -18
  85. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -1
  86. package/dist/services/task/types.js +47 -1
  87. package/dist/services/task/types.js.map +1 -1
  88. package/dist/services/task/voice/Voice.js +477 -17
  89. package/dist/services/task/voice/Voice.js.map +1 -1
  90. package/dist/services/task/voice/WebRTC.js +6 -3
  91. package/dist/services/task/voice/WebRTC.js.map +1 -1
  92. package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
  93. package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
  94. package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
  95. package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
  96. package/dist/services/wxAppDiagnosticLogging.js +159 -0
  97. package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
  98. package/dist/services/wxAppTelephonyUtils.js +19 -0
  99. package/dist/services/wxAppTelephonyUtils.js.map +1 -0
  100. package/dist/types/cc.d.ts +127 -9
  101. package/dist/types/config.d.ts +7 -0
  102. package/dist/types/constants.d.ts +23 -0
  103. package/dist/types/index.d.ts +38 -17
  104. package/dist/types/metrics/MetricsManager.d.ts +6 -0
  105. package/dist/types/metrics/constants.d.ts +31 -0
  106. package/dist/types/services/AddressBook.d.ts +2 -1
  107. package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
  108. package/dist/types/services/ApiAiAssistant.d.ts +48 -4
  109. package/dist/types/services/EntryPoint.d.ts +7 -5
  110. package/dist/types/services/Queue.d.ts +5 -3
  111. package/dist/types/services/WebexCrossClientService.d.ts +32 -0
  112. package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
  113. package/dist/types/services/config/Util.d.ts +4 -8
  114. package/dist/types/services/config/constants.d.ts +28 -76
  115. package/dist/types/services/config/index.d.ts +16 -64
  116. package/dist/types/services/config/types.d.ts +150 -173
  117. package/dist/types/services/constants.d.ts +9 -0
  118. package/dist/types/services/core/Err.d.ts +2 -0
  119. package/dist/types/services/core/Utils.d.ts +10 -0
  120. package/dist/types/services/core/WebexRequest.d.ts +1 -0
  121. package/dist/types/services/core/constants.d.ts +7 -0
  122. package/dist/types/services/core/types.d.ts +2 -0
  123. package/dist/types/services/task/Task.d.ts +34 -5
  124. package/dist/types/services/task/TaskFactory.d.ts +4 -2
  125. package/dist/types/services/task/TaskUtils.d.ts +6 -0
  126. package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
  127. package/dist/types/services/task/constants.d.ts +12 -0
  128. package/dist/types/services/task/contact.d.ts +4 -0
  129. package/dist/types/services/task/digital/Digital.d.ts +4 -3
  130. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +304 -56
  131. package/dist/types/services/task/state-machine/guards.d.ts +6 -5
  132. package/dist/types/services/task/state-machine/types.d.ts +9 -1
  133. package/dist/types/services/task/types.d.ts +192 -5
  134. package/dist/types/services/task/voice/Voice.d.ts +68 -11
  135. package/dist/types/services/task/voice/WebRTC.d.ts +5 -4
  136. package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
  137. package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
  138. package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
  139. package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
  140. package/dist/types/types.d.ts +125 -13
  141. package/dist/types/utils/PageCache.d.ts +20 -3
  142. package/dist/types.js +90 -8
  143. package/dist/types.js.map +1 -1
  144. package/dist/utils/PageCache.js +19 -5
  145. package/dist/utils/PageCache.js.map +1 -1
  146. package/dist/webex.js +9 -1
  147. package/dist/webex.js.map +1 -1
  148. package/package.json +10 -9
  149. package/src/cc.ts +1047 -48
  150. package/src/config.ts +7 -0
  151. package/src/constants.ts +36 -0
  152. package/src/index.ts +49 -11
  153. package/src/metrics/MetricsManager.ts +16 -0
  154. package/src/metrics/ai-docs/metrics-spec.md +138 -21
  155. package/src/metrics/behavioral-events.ts +112 -0
  156. package/src/metrics/constants.ts +36 -0
  157. package/src/services/AddressBook.ts +17 -6
  158. package/src/services/AnswerCallOnWebexService.ts +239 -0
  159. package/src/services/ApiAiAssistant.ts +297 -13
  160. package/src/services/EntryPoint.ts +59 -60
  161. package/src/services/Queue.ts +29 -12
  162. package/src/services/WebCallingService.ts +362 -40
  163. package/src/services/WebexCrossClientService.ts +298 -0
  164. package/src/services/WxAppTelephonyMercurySync.ts +142 -0
  165. package/src/services/agent/ai-docs/AGENTS.md +1 -1
  166. package/src/services/agent/ai-docs/agent-spec.md +1 -0
  167. package/src/services/ai-docs/AGENTS.md +11 -11
  168. package/src/services/ai-docs/services-spec.md +25 -5
  169. package/src/services/config/Util.ts +52 -82
  170. package/src/services/config/ai-docs/AGENTS.md +35 -40
  171. package/src/services/config/ai-docs/ARCHITECTURE.md +90 -103
  172. package/src/services/config/ai-docs/config-spec.md +132 -132
  173. package/src/services/config/constants.ts +39 -85
  174. package/src/services/config/index.ts +116 -277
  175. package/src/services/config/types.ts +145 -195
  176. package/src/services/constants.ts +10 -0
  177. package/src/services/core/Err.ts +1 -0
  178. package/src/services/core/Utils.ts +28 -0
  179. package/src/services/core/WebexRequest.ts +3 -1
  180. package/src/services/core/ai-docs/core-spec.md +25 -11
  181. package/src/services/core/aqm-reqs.ts +18 -12
  182. package/src/services/core/constants.ts +8 -0
  183. package/src/services/core/types.ts +33 -1
  184. package/src/services/core/websocket/WebSocketManager.ts +26 -2
  185. package/src/services/task/Task.ts +386 -12
  186. package/src/services/task/TaskFactory.ts +33 -6
  187. package/src/services/task/TaskManager.ts +857 -41
  188. package/src/services/task/TaskUtils.ts +13 -0
  189. package/src/services/task/WebexCallingUtils.ts +136 -0
  190. package/src/services/task/ai-docs/ARCHITECTURE.md +1 -0
  191. package/src/services/task/ai-docs/task-spec.md +190 -8
  192. package/src/services/task/constants.ts +13 -0
  193. package/src/services/task/contact.ts +30 -0
  194. package/src/services/task/digital/Digital.ts +11 -4
  195. package/src/services/task/state-machine/TaskStateMachine.ts +235 -81
  196. package/src/services/task/state-machine/actions.ts +5 -2
  197. package/src/services/task/state-machine/ai-docs/AGENTS.md +6 -4
  198. package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +35 -16
  199. package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +103 -33
  200. package/src/services/task/state-machine/guards.ts +7 -10
  201. package/src/services/task/state-machine/types.ts +16 -1
  202. package/src/services/task/state-machine/uiControlsComputer.ts +206 -32
  203. package/src/services/task/types.ts +269 -4
  204. package/src/services/task/voice/Voice.ts +625 -17
  205. package/src/services/task/voice/WebRTC.ts +11 -4
  206. package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
  207. package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
  208. package/src/services/wxAppDiagnosticLogging.ts +286 -0
  209. package/src/services/wxAppTelephonyUtils.ts +14 -0
  210. package/src/types.ts +159 -13
  211. package/src/utils/AGENTS.md +21 -10
  212. package/src/utils/PageCache.ts +38 -5
  213. package/src/utils/ai-docs/utils-spec.md +21 -11
  214. package/src/webex.js +8 -0
  215. package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
  216. package/test/unit/spec/cc.ts +3595 -120
  217. package/test/unit/spec/index.ts +891 -0
  218. package/test/unit/spec/metrics/MetricsManager.ts +25 -0
  219. package/test/unit/spec/metrics/behavioral-events.ts +60 -0
  220. package/test/unit/spec/services/AddressBook.ts +37 -6
  221. package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
  222. package/test/unit/spec/services/ApiAiAssistant.ts +269 -8
  223. package/test/unit/spec/services/EntryPoint.ts +87 -40
  224. package/test/unit/spec/services/Queue.ts +123 -12
  225. package/test/unit/spec/services/WebCallingService.ts +483 -54
  226. package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
  227. package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
  228. package/test/unit/spec/services/config/Util.ts +501 -0
  229. package/test/unit/spec/services/config/index.ts +313 -543
  230. package/test/unit/spec/services/core/Utils.ts +22 -0
  231. package/test/unit/spec/services/core/WebexRequest.ts +8 -7
  232. package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
  233. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +64 -14
  234. package/test/unit/spec/services/task/Task.ts +2257 -11
  235. package/test/unit/spec/services/task/TaskFactory.ts +56 -2
  236. package/test/unit/spec/services/task/TaskManager.ts +5559 -1493
  237. package/test/unit/spec/services/task/TaskUtils.ts +72 -0
  238. package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
  239. package/test/unit/spec/services/task/contact.ts +33 -0
  240. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +1501 -92
  241. package/test/unit/spec/services/task/state-machine/guards.ts +210 -8
  242. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +445 -7
  243. package/test/unit/spec/services/task/voice/Voice.ts +1710 -4
  244. package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
  245. package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
  246. package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
  247. package/test/unit/spec/wellnessSampleUtils.ts +288 -0
  248. package/typedoc.md +1 -1
  249. package/umd/contact-center.min.js +2 -2
  250. package/umd/contact-center.min.js.map +1 -1
package/src/config.ts CHANGED
@@ -31,6 +31,13 @@ export default {
31
31
  * @default false
32
32
  */
33
33
  disableWebRTCRegistration: false,
34
+ /**
35
+ * Whether wxApp Better Together is enabled at SDK init.
36
+ * Must be set before SDK init. Default false (WXCC-6026).
37
+ * @type {boolean}
38
+ * @default false
39
+ */
40
+ enableWxBetterTogether: false,
34
41
  /**
35
42
  * The type of client making the connection.
36
43
  * @type {string}
package/src/constants.ts CHANGED
@@ -1,3 +1,10 @@
1
+ import {
2
+ VOICE_CONNECTION_STATUS,
3
+ VoiceConnectionState,
4
+ VoiceLineStatus,
5
+ VoiceMobiusSocketStatus,
6
+ } from './types';
7
+
1
8
  export const EVENT = 'event';
2
9
  export const READY = 'ready';
3
10
  export const TIMEOUT_DURATION = 20000; // 20 seconds timeout duration for webrtc registration
@@ -8,6 +15,7 @@ export const LOG_PREFIX = 'PLUGIN_CC';
8
15
  export const WEB_CALLING_SERVICE_FILE = 'WebCallingService';
9
16
  export const CONFIG_FILE_NAME = 'config-index';
10
17
  export const CC_FILE = 'cc';
18
+ export const WELLNESS_BREAK_HANDLER = 'Wellness_Break_Handler';
11
19
  export const CONNECTION_SERVICE_FILE = 'connection-service';
12
20
  export const WEB_SOCKET_MANAGER_FILE = 'WebSocketManager';
13
21
  export const AQM_REQS_FILE = 'aqm-reqs';
@@ -15,6 +23,7 @@ export const WEBEX_REQUEST_FILE = 'WebexRequest';
15
23
  export const TASK_MANAGER_FILE = 'TaskManager';
16
24
  export const TASK_FILE = 'Task';
17
25
  // AGENT OUTDIAL CONSTANTS
26
+ export const INBOUND_DIRECTION = 'INBOUND';
18
27
  export const OUTDIAL_DIRECTION = 'OUTBOUND';
19
28
  export const ATTRIBUTES = {};
20
29
  export const OUTDIAL_MEDIA_TYPE = 'telephony';
@@ -23,6 +32,11 @@ export const OUTBOUND_TYPE = 'OUTDIAL';
23
32
  // Log related constants
24
33
  export const UNKNOWN_ERROR = 'Unknown error';
25
34
  export const MERCURY_DISCONNECTED_SUCCESS = 'Mercury disconnected successfully';
35
+ export const DEFAULT_VOICE_CONNECTION_STATE: Readonly<VoiceConnectionState> = Object.freeze({
36
+ status: VOICE_CONNECTION_STATUS.NOT_REQUIRED,
37
+ lineStatus: VoiceLineStatus.UNKNOWN,
38
+ mobiusSocketStatus: VoiceMobiusSocketStatus.UNKNOWN,
39
+ });
26
40
 
27
41
  // METHOD NAMES
28
42
  export const METHODS = {
@@ -56,9 +70,11 @@ export const METHODS = {
56
70
  TRANSFER_CALL: 'transfer',
57
71
  CONSULT_TRANSFER: 'consultTransfer',
58
72
  CONSULT_CONFERENCE: 'consultConference',
73
+ DROP_CONFERENCE_PARTICIPANT: 'dropConferenceParticipant',
59
74
  EXIT_CONFERENCE: 'exitConference',
60
75
  TRANSFER_CONFERENCE: 'transferConference',
61
76
  TOGGLE_MUTE: 'toggleMute',
77
+ TRANSMIT_DTMF: 'transmitDtmf',
62
78
  COMPLETE_TRANSFER: 'completeTransfer',
63
79
  GET_OUTDIAL_ANI_ENTRIES: 'getOutdialAniEntries',
64
80
  ACCEPT_PREVIEW_CONTACT: 'acceptPreviewContact',
@@ -69,4 +85,24 @@ export const METHODS = {
69
85
  GET_REAL_TIME_ASSISTANCE: 'getRealTimeAssistance',
70
86
  SEND_REAL_TIME_ASSISTANCE_USER_ACTION: 'sendRealTimeAssistanceUserAction',
71
87
  FETCH_HISTORIC_TRANSCRIPTS: 'fetchHistoricTranscripts',
88
+ REQUEST_WELLNESS_BREAK: 'requestWellnessBreak',
89
+ RESPOND_TO_WELLNESS_BREAK: 'respondToWellnessBreak',
90
+ GET_WELLBEING_BREAK_IDLE_CODE: 'getWellbeingBreakIdleCode',
91
+ SET_MANAGE_WEBEX_CALLING_IN_WXCC: 'setManageWebexCallingInWxcc',
92
+ IS_WX_BETTER_TOGETHER_ENABLED: 'isWxBetterTogetherEnabled',
93
+ SYNC_WXAPP_MUTE_FROM_MERCURY: 'syncWxAppMuteFromMercury',
94
+ GET_CALL_DETAILS_ON_WEBEX: 'getCallDetailsOnWebex',
95
+ ENSURE_WXAPP_MERCURY_CONNECTED: 'ensureWxAppMercuryConnected',
72
96
  };
97
+
98
+ export const AI_SUMMARY_ERROR_CODES = {
99
+ POST_CALL_SUMMARY_DISABLED: 'POST_CALL_SUMMARY_DISABLED',
100
+ MID_CALL_SUMMARY_DISABLED: 'MID_CALL_SUMMARY_DISABLED',
101
+ AI_ASSISTANT_BASE_URL_NOT_AVAILABLE: 'AI_ASSISTANT_BASE_URL_NOT_AVAILABLE',
102
+ POST_CALL_SUMMARY_TIMEOUT: 'POST_CALL_SUMMARY_TIMEOUT',
103
+ MID_CALL_SUMMARY_TIMEOUT: 'MID_CALL_SUMMARY_TIMEOUT',
104
+ } as const;
105
+
106
+ export const AI_SUMMARY_INVALID_RESPONSE_PAYLOAD = 'AI_SUMMARY_INVALID_RESPONSE_PAYLOAD';
107
+
108
+ export const AI_ASSISTANT_CLIENT_TYPE = 'WxCC' as const;
package/src/index.ts CHANGED
@@ -4,7 +4,7 @@ import ContactCenter from './cc';
4
4
 
5
5
  /**
6
6
  * @module ContactCenterModule
7
- * /
7
+ */
8
8
 
9
9
  // Core exports
10
10
  /**
@@ -28,8 +28,12 @@ export {default as Task} from './services/task/Task';
28
28
  // API exports (AddressBook is public, EntryPoint and Queue are accessed via cc wrappers)
29
29
  export {default as AddressBook} from './services/AddressBook';
30
30
  export {default as ApiAIAssistant} from './services/ApiAiAssistant';
31
+ export {AI_SUMMARY_ERROR_CODES} from './constants';
31
32
  export {default as UserPreference} from './services/UserPreference';
32
33
 
34
+ /** Agent Wellness Break notification and action wire values. */
35
+ export {WELLNESS_BREAK_NOTIFICATION_ACTIONS, WELLNESS_BREAK_USER_ACTIONS} from './types';
36
+
33
37
  /** EntryPoint API types */
34
38
  export type {
35
39
  EntryPointRecord,
@@ -61,7 +65,7 @@ export {AGENT_EVENTS} from './services/agent/types';
61
65
  export type {AGENT_EVENTS as AgentEvents} from './services/agent/types';
62
66
 
63
67
  /**
64
- * Contact Center Task Events
68
+ * Contact Center task, realtime, and AI Assistant events
65
69
  * @enum {string}
66
70
  * @category Enums
67
71
  */
@@ -79,9 +83,17 @@ export {CC_AGENT_EVENTS} from './services/config/types';
79
83
  * @enum {string}
80
84
  * @category Enums
81
85
  */
82
- export {CC_EVENTS} from './services/config/types';
86
+ export {CC_EVENTS, VOICE_CONNECTION_EVENTS} from './services/config/types';
83
87
  export type {CC_EVENTS as ContactCenterEvents} from './services/config/types';
84
88
 
89
+ /** Browser voice connection state event and status values */
90
+ export {
91
+ VOICE_CONNECTION_ERROR,
92
+ VOICE_CONNECTION_STATUS,
93
+ VoiceLineStatus,
94
+ VoiceMobiusSocketStatus,
95
+ } from './types';
96
+
85
97
  // Interfaces
86
98
  /** Main types and interfaces for Contact Center functionality */
87
99
  export type {
@@ -91,6 +103,7 @@ export type {
91
103
  CCPluginConfig,
92
104
  /** WebexSDK interface */
93
105
  WebexSDK,
106
+ VoiceConnectionState,
94
107
  } from './types';
95
108
 
96
109
  // Types
@@ -120,6 +133,14 @@ export type {
120
133
  GenericError,
121
134
  /** Set state response */
122
135
  SetStateResponse,
136
+ /** Wellness notification action */
137
+ WellnessBreakNotificationAction,
138
+ /** Wellness action API value */
139
+ WellnessBreakUserAction,
140
+ /** Validated agent-scoped wellness notification */
141
+ WellnessBreakEvent,
142
+ /** Wellness offer-response parameters */
143
+ RespondToWellnessBreakParams,
123
144
  } from './types';
124
145
 
125
146
  /** Task related types */
@@ -133,6 +154,8 @@ export type {
133
154
  TaskData,
134
155
  /** Task response */
135
156
  TaskResponse,
157
+ /** Conference participant drop request */
158
+ DropConferenceParticipantPayload,
136
159
  ConsultPayload,
137
160
  ConsultEndPayload,
138
161
  ConsultTransferPayLoad,
@@ -146,6 +169,13 @@ export type {
146
169
  TaskUILeg,
147
170
  TaskUIControls,
148
171
  TaskUIControlState,
172
+ AISummaryAction,
173
+ AISummaryFeedback,
174
+ AISummaryState,
175
+ AISummarySections,
176
+ AISummary,
177
+ AISummaryFeatureEnablement,
178
+ AISummaryResponse,
149
179
  } from './services/task/types';
150
180
 
151
181
  /** UI controls utilities */
@@ -185,10 +215,14 @@ export type {
185
215
  export type {
186
216
  /** Profile interface */
187
217
  Profile,
188
- /** Response type from getUserUsingCI method */
218
+ /** Aggregated organization configuration from getOrgDesktopLoginConfig */
219
+ OrgDesktopLoginResponse,
220
+ /** Aggregated user configuration from getUserDesktopLoginConfig */
221
+ UserDesktopLoginResponse,
222
+ /** Agent identity, the `user` section of the user desktop-login aggregate */
189
223
  AgentResponse,
190
- /** Response from getDesktopProfileById */
191
- DesktopProfileResponse,
224
+ /** Desktop Profile settings, the `agentProfile` section of the user desktop-login aggregate */
225
+ AgentProfile,
192
226
  /** Response from getMultimediaProfileById */
193
227
  MultimediaProfileResponse,
194
228
  /** Response from getListOfTeams */
@@ -197,14 +231,18 @@ export type {
197
231
  ListAuxCodesResponse,
198
232
  /** Response from getSiteInfo */
199
233
  SiteInfo,
200
- /** Response from getOrgInfo */
234
+ /** Organization identity, the `organization` section of the org desktop-login aggregate */
201
235
  OrgInfo,
202
- /** Response from getOrganizationSetting */
236
+ /** Organization settings, the `organizationSetting` section of the org desktop-login aggregate */
203
237
  OrgSettings,
204
- /** Response from getTenantData */
238
+ /** Tenant configuration, the `tenantConfiguration` section of the org desktop-login aggregate */
205
239
  TenantData,
206
- /** Response from getURLMapping */
207
- URLMapping,
240
+ /** Microsoft Teams integration configuration, from the org desktop-login aggregate */
241
+ MicrosoftConfig,
242
+ /** Webex integration configuration, from the org desktop-login aggregate */
243
+ WebexConfig,
244
+ /** External integration URLs, the `urlMappings` section of the org desktop-login aggregate */
245
+ OrgUrlMappings,
208
246
  /** Response from getDialPlanData */
209
247
  DialPlanEntity,
210
248
  /** Auxiliary code information */
@@ -412,6 +412,22 @@ export default class MetricsManager {
412
412
  this.runningEvents[genericKey] = {startTime: Date.now(), keys: new Set(keyArray)};
413
413
  }
414
414
 
415
+ /**
416
+ * Clears a running timed event without emitting a metric.
417
+ * @param keys - A string or array of strings representing event keys (same as timeEvent).
418
+ * @public
419
+ */
420
+ public cancelTimedEvent(keys: string | string[]): void {
421
+ if (this.isMetricsDisabled()) {
422
+ return;
423
+ }
424
+ const keyArray = Array.isArray(keys) ? keys : [keys];
425
+ if (keyArray.length === 0) {
426
+ return;
427
+ }
428
+ delete this.runningEvents[keyArray[0]];
429
+ }
430
+
415
431
  /**
416
432
  * Sets the Webex SDK instance and marks the manager as ready when the SDK is ready.
417
433
  * @param webex - The Webex SDK instance.
@@ -11,8 +11,8 @@
11
11
  | Doc kind | Module spec |
12
12
  | Coverage score | Partial (manifest-authoritative); 15/15 required document fields present |
13
13
  | Generated from | `module-spec` @ SDLC template library `0.2.1` |
14
- | generated_by / approved_by / updated_at | Codex generator / developer-approved follow-up review remediation / 2026-07-21 |
15
- | Validation status | Follow-up validation passed (independent Claude fallback, 2026-07-21); coverage remains Partial |
14
+ | generated_by / approved_by / updated_at | Codex generator / developer-approved Agent Wellness Break delta / 2026-09-02 |
15
+ | Validation status | Agent Wellness Break v0.4 delta independently validated by claude-code on 2026-09-07; coverage remains Partial until the remaining baseline promotion criteria are satisfied |
16
16
 
17
17
  ## Evidence Rules
18
18
  Every requirement cites stable source and test file paths. Code/tests are the behavioral referee; routed source text supplies explicit intent and rationale. Missing or contradictory evidence blocks promotion.
@@ -35,6 +35,8 @@ Metrics is one of nine confirmed Contact Center SDK modules. Own timing, taxonom
35
35
 
36
36
  - **Behavioral Taxonomy**: Structured `product.agent.target.verb` naming convention for behavioral events
37
37
 
38
+ - **Webex Together behavioral naming**: Webex Together (wxApp) events use `*_webex_together` compound targets (e.g. `wxcc_sdk.user.task_accept_webex_together.complete`). Operational/business wire names remain `WXCC_SDK_WXAPP_*` unchanged.
39
+
38
40
  - **Payload Preparation**: Automatic cleanup of empty fields, space-to-underscore conversion, and `tabHidden` metadata
39
41
 
40
42
  - **AQM Response Helpers**: Static methods to extract common tracking fields from AQM responses
@@ -236,10 +238,20 @@ All event names are defined in `METRIC_EVENT_NAMES` (`constants.ts`). Events fol
236
238
  | `TASK_ACCEPT_CONSULT_SUCCESS` / `FAILED` | `'Task Accept Consult ...'` | Accept consult result |
237
239
  | `TASK_AUTO_ANSWER_SUCCESS` / `FAILED` | `'Task Auto Answer ...'` | Auto-answer result |
238
240
  | `TASK_OUTDIAL_SUCCESS` / `FAILED` | `'Task Outdial ...'` | Outdial result |
241
+ | `WXAPP_TASK_MUTE_SUCCESS` / `FAILED` | `'WxApp Task Mute ...'` | Webex Together task mute/unmute toggle (`wxcc_sdk.user.task_mute_webex_together.complete\|fail`). Mute telephony is queued per task via tail promise chain (`Voice.wxAppMuteToggleTail`) so concurrent toggles do not overwrite the shared `timeEvent` timer or reorder requests. |
242
+ | `WXAPP_TASK_DTMF_SUCCESS` / `FAILED` | `'WxApp Task Dtmf ...'` | Webex Together DTMF/keypad (`wxcc_sdk.user.task_dtmf_webex_together.complete\|fail`). DTMF telephony is queued per task via tail promise chain (`Voice.wxAppDtmfTail`) so concurrent keypad input does not overwrite the shared `timeEvent` timer or reorder digits. |
243
+ | `WXAPP_TASK_ACCEPT_SUCCESS` / `FAILED` | `'WxApp Task Accept ...'` | Webex Together accept/answer (`wxcc_sdk.user.task_accept_webex_together.complete\|fail`) |
244
+ | `WXAPP_TASK_DECLINE_SUCCESS` / `FAILED` | `'WxApp Task Decline ...'` | Webex Together reject/decline (`wxcc_sdk.user.task_reject_webex_together.complete\|fail`). Inbound offers: telephony `rejectCall` via `runWxAppReject`. wxApp outdial cancellations: CC `cancelTask` via `runWxAppOutdialDecline` (additive with `TASK_DECLINE_*`). Outdial failure payloads merge AQM `error.details` via `getCommonTrackingFieldForAQMResponseFailed` so wxApp metrics and diagnostic logs preserve `trackingId` / structured failure reason. |
245
+ | `WXAPP_SESSION_INIT_SUCCESS` / `FAILED` | `'WxApp Session Init ...'` | Webex Together session orchestration (`wxcc_sdk.user.webex_together_session_init.complete\|fail`) |
246
+ | `WXAPP_SESSION_SKIPPED` | `'WxApp Session Skipped'` | Webex Together session skipped (`wxcc_sdk.user.webex_together_session_init.ignore`) |
247
+ | `WXAPP_USERSUB_PUBLISH_SUCCESS` / `FAILED` | `'WxApp Usersub Publish ...'` | Cross-client usersub publish (`wxcc_sdk.user.webex_together_usersub_publish.complete\|fail`). Preflight failures (missing `userId` or device URL before HTTP publish) emit `WXAPP_USERSUB_PUBLISH_FAILED` with `skipReason` (`user_id_unavailable` / `device_url_unavailable`) and no `timeEvent` timer. Stale-generation discards (teardown or concurrent disable while HTTP publish is in flight) call `cancelTimedEvent` without emitting success/fail only when the completing publish still owns the active timer (`usersubPublishMetricsId` guard — a newer overlapping publish must not have its timer cleared). |
248
+ | `WXAPP_MERCURY_SUBSCRIBE_SUCCESS` / `FAILED` | `'WxApp Mercury Subscribe ...'` | Telephony Mercury mute-sync subscribe (`wxcc_sdk.user.webex_together_mercury_subscribe.complete\|fail`) |
249
+ | `WXAPP_OFFER_PARTICIPANT_FIELDS_MISSING` | `'WxApp Offer Participant Fields Missing'` | Read-only observability when usersub is active but inbound OFFERED participant **still** lacks valid wxApp fields after a **500 ms grace period** (orchestrated in `voice/wxAppOfferObservability.ts`; avoids false alarms from transient WS ordering). After usersub publish, `TaskManager.refreshWxAppOfferObservabilityForAllTasks()` re-runs the observer so a pre-publish OFFERED task can still schedule grace. Task removal calls `disposeWxAppOfferObservability()` so a pending timer cannot emit after `CONTACT_MERGED` / collection drop. Emitted with matching `[CC wxApp] participant fields mismatch` WARN (`wxcc_sdk.user.webex_together_offer_participant_fields.fail`) |
239
250
  | `TASK_CONFERENCE_START_SUCCESS` / `FAILED` | `'Task Conference Start ...'` | Conference start result |
240
251
  | `TASK_CONFERENCE_END_SUCCESS` / `FAILED` | `'Task Conference End ...'` | Conference end result |
241
252
  | `TASK_CONFERENCE_TRANSFER_SUCCESS` / `FAILED` | `'Task Conference Transfer ...'` | Conference transfer result |
242
253
  | `TASK_CONFERENCE_EXIT_SUCCESS` / `FAILED` | `'Task Conference Exit ...'` | Conference exit result |
254
+ | `TASK_CONFERENCE_PARTICIPANT_DROP_SUCCESS` / `FAILED` | `'Task Conference Participant Drop ...'` | Participant Drop result |
243
255
  | `TASK_SWITCH_CALL_SUCCESS` / `FAILED` | `'Task Switch Call ...'` | Switch call result |
244
256
  | `WEBSOCKET_REGISTER_SUCCESS` / `FAILED` | `'Websocket Register ...'` | WebSocket registration result |
245
257
  | `WEBSOCKET_DEREGISTER_SUCCESS` / `FAIL` | `'Websocket Deregister ...'` | WebSocket deregistration result |
@@ -249,6 +261,9 @@ All event names are defined in `METRIC_EVENT_NAMES` (`constants.ts`). Events fol
249
261
  | `ADDRESSBOOK_FETCH_SUCCESS` / `FAILED` | `'AddressBook Fetch ...'` | Address book fetch result |
250
262
  | `QUEUE_FETCH_SUCCESS` / `FAILED` | `'Queue Fetch ...'` | Queue fetch result |
251
263
  | `OUTDIAL_ANI_EP_FETCH_SUCCESS` / `FAILED` | `'Outdial ANI Entries Fetch ...'` | Outdial ANI entries fetch result |
264
+ | `AI_ASSISTANT_WELLNESS_ACTION_ACCEPTED` / `FAILED` | `'AI Assistant Wellness Action ...'` | Direct wellness custom-event result |
265
+ | `AI_ASSISTANT_WELLNESS_EVENT_INVALID` | `'AI Assistant Wellness Event Invalid'` | Malformed or mismatched wellness notification ignored |
266
+ | `WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS` / `FAILED` | `'Wellbeing Break Idle Code Fetch ...'` | System wellness idle-code lookup result |
252
267
 
253
268
  All event names are defined in `constants.ts` as `METRIC_EVENT_NAMES`. Events follow a `{Domain} {Action} {Success|Failed}` naming convention:
254
269
 
@@ -277,8 +292,17 @@ All event names are defined in `constants.ts` as `METRIC_EVENT_NAMES`. Events fo
277
292
  | Conference End | `TASK_CONFERENCE_END_SUCCESS` | `TASK_CONFERENCE_END_FAILED` |
278
293
  | Conference Transfer | `TASK_CONFERENCE_TRANSFER_SUCCESS` | `TASK_CONFERENCE_TRANSFER_FAILED` |
279
294
  | Conference Exit | `TASK_CONFERENCE_EXIT_SUCCESS` | `TASK_CONFERENCE_EXIT_FAILED` |
295
+ | Conference Participant Drop | `TASK_CONFERENCE_PARTICIPANT_DROP_SUCCESS` | `TASK_CONFERENCE_PARTICIPANT_DROP_FAILED` |
280
296
  | Switch Call | `TASK_SWITCH_CALL_SUCCESS` | `TASK_SWITCH_CALL_FAILED` |
281
297
  | Outdial | `TASK_OUTDIAL_SUCCESS` | `TASK_OUTDIAL_FAILED` |
298
+ | WxApp Task Mute | `WXAPP_TASK_MUTE_SUCCESS` | `WXAPP_TASK_MUTE_FAILED` |
299
+ | WxApp Task DTMF | `WXAPP_TASK_DTMF_SUCCESS` | `WXAPP_TASK_DTMF_FAILED` |
300
+ | WxApp Task Accept | `WXAPP_TASK_ACCEPT_SUCCESS` | `WXAPP_TASK_ACCEPT_FAILED` |
301
+ | WxApp Task Decline | `WXAPP_TASK_DECLINE_SUCCESS` | `WXAPP_TASK_DECLINE_FAILED` |
302
+ | WxApp Session Init | `WXAPP_SESSION_INIT_SUCCESS` | `WXAPP_SESSION_INIT_FAILED` |
303
+ | WxApp Usersub Publish | `WXAPP_USERSUB_PUBLISH_SUCCESS` | `WXAPP_USERSUB_PUBLISH_FAILED` |
304
+ | WxApp Mercury Subscribe | `WXAPP_MERCURY_SUBSCRIBE_SUCCESS` | `WXAPP_MERCURY_SUBSCRIBE_FAILED` |
305
+ | WxApp Offer Participant Fields | — | `WXAPP_OFFER_PARTICIPANT_FIELDS_MISSING` |
282
306
  | Upload Logs | `UPLOAD_LOGS_SUCCESS` | `UPLOAD_LOGS_FAILED` |
283
307
  | WebSocket Deregister | `WEBSOCKET_DEREGISTER_SUCCESS` | `WEBSOCKET_DEREGISTER_FAIL` |
284
308
  | Device Type Update | `AGENT_DEVICE_TYPE_UPDATE_SUCCESS` | `AGENT_DEVICE_TYPE_UPDATE_FAILED` |
@@ -287,6 +311,61 @@ All event names are defined in `constants.ts` as `METRIC_EVENT_NAMES`. Events fo
287
311
  | Queue | `QUEUE_FETCH_SUCCESS` | `QUEUE_FETCH_FAILED` |
288
312
  | Outdial ANI Entries | `OUTDIAL_ANI_EP_FETCH_SUCCESS` | `OUTDIAL_ANI_EP_FETCH_FAILED` |
289
313
 
314
+ ### Webex Together behavioral taxonomy
315
+
316
+ Webex Together events (`WXAPP_*` constants) use `*_webex_together` compound targets. Assembled Amplitude names follow `wxcc_sdk.user.{target}.{verb}`:
317
+
318
+ | Feature | Behavioral target | Success name | Failure name | Skip name |
319
+ |---|---|---|---|---|
320
+ | Task accept / answer | `task_accept_webex_together` | `wxcc_sdk.user.task_accept_webex_together.complete` | `wxcc_sdk.user.task_accept_webex_together.fail` | — |
321
+ | Task reject / decline | `task_reject_webex_together` | `wxcc_sdk.user.task_reject_webex_together.complete` | `wxcc_sdk.user.task_reject_webex_together.fail` | — |
322
+ | Task mute / unmute toggle | `task_mute_webex_together` | `wxcc_sdk.user.task_mute_webex_together.complete` | `wxcc_sdk.user.task_mute_webex_together.fail` | — |
323
+ | Task DTMF / keypad | `task_dtmf_webex_together` | `wxcc_sdk.user.task_dtmf_webex_together.complete` | `wxcc_sdk.user.task_dtmf_webex_together.fail` | — |
324
+ | Usersub publish | `webex_together_usersub_publish` | `wxcc_sdk.user.webex_together_usersub_publish.complete` | `wxcc_sdk.user.webex_together_usersub_publish.fail` | — |
325
+ | Mercury subscribe | `webex_together_mercury_subscribe` | `wxcc_sdk.user.webex_together_mercury_subscribe.complete` | `wxcc_sdk.user.webex_together_mercury_subscribe.fail` | — |
326
+ | Session init | `webex_together_session_init` | `wxcc_sdk.user.webex_together_session_init.complete` | `wxcc_sdk.user.webex_together_session_init.fail` | `wxcc_sdk.user.webex_together_session_init.ignore` |
327
+ | Offer participant fields | `webex_together_offer_participant_fields` | — | `wxcc_sdk.user.webex_together_offer_participant_fields.fail` | — |
328
+
329
+ Operational and business wire names are unchanged (`WXCC_SDK_WXAPP_*`).
330
+
331
+ ### WxApp metric payload fields (operational / behavioral tags)
332
+
333
+ | Event | Payload fields (booleans/enums; no raw IDs) |
334
+ |---|---|
335
+ | `WXAPP_SESSION_INIT_SUCCESS` | `loginOption`, `enableWxBetterTogether`, `usersubPublished`, `mercurySubscribed`, `telephonyTaskType` |
336
+ | `WXAPP_SESSION_INIT_FAILED` | above + `skipReason` (`usersub_not_published`, `mercury_not_subscribed`, `mercury_subscribe_failed`, `publish_failed`) + optional `error`. `usersubPublished` reflects **retained session state** (`isAnswerCallsStateActive()` / `answerCallsState`), including on catch-path failures — not gated on the current init attempt's `publishedEnable`. |
337
+ | `WXAPP_USERSUB_PUBLISH_SUCCESS` | `enableWxBetterTogether`, `usersubPublished` |
338
+ | `WXAPP_USERSUB_PUBLISH_FAILED` | `enableWxBetterTogether`, `usersubPublished`, optional `skipReason`, `error`. `usersubPublished` reflects **retained session state** (`answerCallsState`), not the requested enable value — a failed disable/refresh while usersub remains active reports `true`. |
339
+ | `WXAPP_MERCURY_SUBSCRIBE_SUCCESS` | `mercurySubscribed: true` |
340
+ | `WXAPP_MERCURY_SUBSCRIBE_FAILED` | `mercurySubscribed: false`, `error` |
341
+ | `WXAPP_TASK_ACCEPT_*` / `DECLINE_*` | `taskId`, `hasDeviceCallId`, `hasDeviceId`, optional `acceptReason`; failures add `trackingId` when available. `acceptReason` is captured **before** the telephony REST call (not hard-coded `wxApp_offer_ready`) so success and failure both retain `wxApp_answer_pending` / `wxApp_accept_in_flight` when those flags were already set. Outdial-cancel AQM failures (`error.details`) include the same participant context fields via `getWxAppTelephonyMetricContext` merged with AQM correlation fields. Outdial cancel during post-accept pending phase may report `acceptReason: wxApp_answer_pending`. |
342
+ | `WXAPP_TASK_MUTE_*` / `DTMF_*` | `taskId`, `hasDeviceCallId`, `hasDeviceId`; failures add `trackingId` when available |
343
+ | `WXAPP_OFFER_PARTICIPANT_FIELDS_MISSING` | `taskId`, `usersubPublished`, `hasDeviceCallId`, `hasDeviceId`, `acceptReason` |
344
+
345
+ ### Customer console log triage (MMT / support)
346
+
347
+ Customers often embed with `logger.level: 'log'`. wxApp diagnostics use **`LoggerProxy.log`** / **`warn`** / **`error`** with prefix **`[CC wxApp]`** and grep-friendly `key=value` suffixes on the message string (fields also appear in structured `data`).
348
+
349
+ | Search in browser console | Meaning |
350
+ |---|---|
351
+ | `[CC wxApp]` | All wxApp diagnostic lines (primary search) |
352
+ | `WXCC_SDK_WXAPP` | Operational metric wire names (name only in console; payloads go to backend) |
353
+ | `session readiness` | usersub + Mercury state after station login |
354
+ | `offer decision` | Why Accept is visible/enabled; includes `acceptReason`, `hasDeviceCallId`, `usersubPublished` |
355
+ | `participant fields mismatch` | usersub active but WS participant **still** missing wxApp triple after ~500 ms (transient gaps on first OFFERED tick are normal — look for `wxApp_offer_ready` within 1 s) |
356
+ | `telephony accept failed` | REST answer failure; includes `trackingId` when available |
357
+
358
+ Do **not** search `WXAPP` alone — it matches metric wire names but misses `[CC wxApp]` diagnostic lines.
359
+
360
+ Example lines at `logger.level: 'log'`:
361
+
362
+ ```text
363
+ PLUGIN_CC - [LOG]: ... [CC wxApp] session readiness usersubPublished=true mercurySubscribed=true loginOption=EXTENSION ...
364
+ PLUGIN_CC - [LOG]: ... [CC wxApp] offer decision acceptReason=wxApp_offer_ready hasDeviceCallId=true usersubPublished=true interactionId=...
365
+ PLUGIN_CC - [WARN]: ... [CC wxApp] participant fields mismatch usersubPublished=true hasDeviceCallId=false acceptReason=extension_non_wxApp_offer interactionId=...
366
+ PLUGIN_CC - [LOG]: ... operational-events -> @submitEvent. Submit event: WXCC_SDK_WXAPP_TASK_ACCEPT_SUCCESS
367
+ ```
368
+
290
369
  Special events (no success/failure pair):
291
370
 
292
371
  - `AGENT_RONA` — has behavioral taxonomy (`service.agent_rona.set`)
@@ -297,11 +376,13 @@ Special events (no success/failure pair):
297
376
 
298
377
  - `WEBSOCKET_EVENT_RECEIVED` — **no** behavioral taxonomy (not in `eventTaxonomyMap`)
299
378
 
300
- Of the 80 defined metric names, 71 have behavioral taxonomy and 9 do not. Events **without** an `eventTaxonomyMap` entry are the six `AI_ASSISTANT_*` names plus `WEBSOCKET_DEREGISTER_SUCCESS`, `WEBSOCKET_DEREGISTER_FAIL`, and `WEBSOCKET_EVENT_RECEIVED`.
379
+ - `WXAPP_SESSION_SKIPPED` — has behavioral taxonomy (`wxcc_sdk.user.webex_together_session_init.ignore`)
380
+
381
+ Of the 121 defined metric names, 97 have behavioral taxonomy and 24 do not. The unmapped names are the eight original `AI_ASSISTANT_*` names, three Agent Wellness Break `AI_ASSISTANT_WELLNESS_*` names, two `WELLBEING_BREAK_IDLE_CODE_FETCH_*` names, eight `AI_SUMMARY_*` names, and three WebSocket names (`WEBSOCKET_DEREGISTER_SUCCESS`, `WEBSOCKET_DEREGISTER_FAIL`, and `WEBSOCKET_EVENT_RECEIVED`). Agent Wellness Break and AI summary metrics are intentionally operational-only.
301
382
 
302
383
  ### Complete METRIC_EVENT_NAMES catalog
303
384
 
304
- This table contains all 80 names from `src/metrics/constants.ts`; taxonomy presence is checked against `src/metrics/behavioral-events.ts`: 71 mapped and 9 unmapped.
385
+ This table contains all 121 names from `src/metrics/constants.ts`; taxonomy presence is checked against `src/metrics/behavioral-events.ts`: 97 mapped and 24 unmapped.
305
386
 
306
387
  | Constant | Emitted name | Behavioral taxonomy? |
307
388
  |---|---|---|
@@ -354,10 +435,28 @@ This table contains all 80 names from `src/metrics/constants.ts`; taxonomy prese
354
435
  | `TASK_CONFERENCE_TRANSFER_FAILED` | `Task Conference Transfer Failed` | yes |
355
436
  | `TASK_CONFERENCE_EXIT_SUCCESS` | `Task Conference Exit Success` | yes |
356
437
  | `TASK_CONFERENCE_EXIT_FAILED` | `Task Conference Exit Failed` | yes |
438
+ | `TASK_CONFERENCE_PARTICIPANT_DROP_SUCCESS` | `Task Conference Participant Drop Success` | yes |
439
+ | `TASK_CONFERENCE_PARTICIPANT_DROP_FAILED` | `Task Conference Participant Drop Failed` | yes |
357
440
  | `TASK_SWITCH_CALL_SUCCESS` | `Task Switch Call Success` | yes |
358
441
  | `TASK_SWITCH_CALL_FAILED` | `Task Switch Call Failed` | yes |
359
442
  | `TASK_OUTDIAL_SUCCESS` | `Task Outdial Success` | yes |
360
443
  | `TASK_OUTDIAL_FAILED` | `Task Outdial Failed` | yes |
444
+ | `WXAPP_TASK_MUTE_SUCCESS` | `WxApp Task Mute Success` | yes |
445
+ | `WXAPP_TASK_MUTE_FAILED` | `WxApp Task Mute Failed` | yes |
446
+ | `WXAPP_TASK_DTMF_SUCCESS` | `WxApp Task Dtmf Success` | yes |
447
+ | `WXAPP_TASK_DTMF_FAILED` | `WxApp Task Dtmf Failed` | yes |
448
+ | `WXAPP_TASK_ACCEPT_SUCCESS` | `WxApp Task Accept Success` | yes |
449
+ | `WXAPP_TASK_ACCEPT_FAILED` | `WxApp Task Accept Failed` | yes |
450
+ | `WXAPP_TASK_DECLINE_SUCCESS` | `WxApp Task Decline Success` | yes |
451
+ | `WXAPP_TASK_DECLINE_FAILED` | `WxApp Task Decline Failed` | yes |
452
+ | `WXAPP_SESSION_INIT_SUCCESS` | `WxApp Session Init Success` | yes |
453
+ | `WXAPP_SESSION_INIT_FAILED` | `WxApp Session Init Failed` | yes |
454
+ | `WXAPP_SESSION_SKIPPED` | `WxApp Session Skipped` | yes |
455
+ | `WXAPP_USERSUB_PUBLISH_SUCCESS` | `WxApp Usersub Publish Success` | yes |
456
+ | `WXAPP_USERSUB_PUBLISH_FAILED` | `WxApp Usersub Publish Failed` | yes |
457
+ | `WXAPP_MERCURY_SUBSCRIBE_SUCCESS` | `WxApp Mercury Subscribe Success` | yes |
458
+ | `WXAPP_MERCURY_SUBSCRIBE_FAILED` | `WxApp Mercury Subscribe Failed` | yes |
459
+ | `WXAPP_OFFER_PARTICIPANT_FIELDS_MISSING` | `WxApp Offer Participant Fields Missing` | yes |
361
460
  | `UPLOAD_LOGS_SUCCESS` | `Upload Logs Success` | yes |
362
461
  | `UPLOAD_LOGS_FAILED` | `Upload Logs Failed` | yes |
363
462
  | `WEBSOCKET_DEREGISTER_SUCCESS` | `Websocket Deregister Success` | no |
@@ -381,12 +480,35 @@ This table contains all 80 names from `src/metrics/constants.ts`; taxonomy prese
381
480
  | `CAMPAIGN_PREVIEW_REMOVE_FAILED` | `Campaign Preview Remove Failed` | yes |
382
481
  | `AI_ASSISTANT_SEND_EVENT_SUCCESS` | `AI Assistant Send Event Success` | no |
383
482
  | `AI_ASSISTANT_SEND_EVENT_FAILED` | `AI Assistant Send Event Failed` | no |
384
- | `AI_ASSISTANT_GET_SUGGESTED_RESPONSE_SUCCESS` | `AI Assistant Get Suggested Response Success` | no |
385
- | `AI_ASSISTANT_GET_SUGGESTED_RESPONSE_FAILED` | `AI Assistant Get Suggested Response Failed` | no |
483
+ | `AI_ASSISTANT_GET_REAL_TIME_ASSISTANCE_SUCCESS` | `AI Assistant Get Real Time Assistance Success` | no |
484
+ | `AI_ASSISTANT_GET_REAL_TIME_ASSISTANCE_FAILED` | `AI Assistant Get Real Time Assistance Failed` | no |
485
+ | `AI_ASSISTANT_SEND_REAL_TIME_ASSISTANCE_USER_ACTION_SUCCESS` | `AI Assistant Send Real Time Assistance User Action Success` | no |
486
+ | `AI_ASSISTANT_SEND_REAL_TIME_ASSISTANCE_USER_ACTION_FAILED` | `AI Assistant Send Real Time Assistance User Action Failed` | no |
386
487
  | `AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_SUCCESS` | `AI Assistant Fetch Historic Transcripts Success` | no |
387
488
  | `AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_FAILED` | `AI Assistant Fetch Historic Transcripts Failed` | no |
388
-
389
- Defined names without an `eventTaxonomyMap` entry: `AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_FAILED`, `AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_SUCCESS`, `AI_ASSISTANT_GET_SUGGESTED_RESPONSE_FAILED`, `AI_ASSISTANT_GET_SUGGESTED_RESPONSE_SUCCESS`, `AI_ASSISTANT_SEND_EVENT_FAILED`, `AI_ASSISTANT_SEND_EVENT_SUCCESS`, `WEBSOCKET_DEREGISTER_FAIL`, `WEBSOCKET_DEREGISTER_SUCCESS`, `WEBSOCKET_EVENT_RECEIVED`.
489
+ | `AI_ASSISTANT_WELLNESS_ACTION_ACCEPTED` | `AI Assistant Wellness Action Accepted` | no |
490
+ | `AI_ASSISTANT_WELLNESS_ACTION_FAILED` | `AI Assistant Wellness Action Failed` | no |
491
+ | `AI_ASSISTANT_WELLNESS_EVENT_INVALID` | `AI Assistant Wellness Event Invalid` | no |
492
+ | `WELLBEING_BREAK_IDLE_CODE_FETCH_SUCCESS` | `Wellbeing Break Idle Code Fetch Success` | no |
493
+ | `WELLBEING_BREAK_IDLE_CODE_FETCH_FAILED` | `Wellbeing Break Idle Code Fetch Failed` | no |
494
+ | `AI_SUMMARY_GET_POST_CALL_SUCCESS` | `Post Call Summary Get Success` | no |
495
+ | `AI_SUMMARY_GET_POST_CALL_FAILED` | `Post Call Summary Get Failed` | no |
496
+ | `AI_SUMMARY_GET_MID_CALL_SUCCESS` | `Mid Call Summary Get Success` | no |
497
+ | `AI_SUMMARY_GET_MID_CALL_FAILED` | `Mid Call Summary Get Failed` | no |
498
+ | `AI_SUMMARY_POST_CALL_RESPONSE_SUCCESS` | `Post Call Summary Response Success` | no |
499
+ | `AI_SUMMARY_POST_CALL_RESPONSE_FAILED` | `Post Call Summary Response Failed` | no |
500
+ | `AI_SUMMARY_MID_CALL_RESPONSE_SUCCESS` | `Mid Call Summary Response Success` | no |
501
+ | `AI_SUMMARY_MID_CALL_RESPONSE_FAILED` | `Mid Call Summary Response Failed` | no |
502
+ | `USER_PREFERENCE_GET_SUCCESS` | `User Preference Get Success` | yes |
503
+ | `USER_PREFERENCE_GET_FAILED` | `User Preference Get Failed` | yes |
504
+ | `USER_PREFERENCE_CREATE_SUCCESS` | `User Preference Create Success` | yes |
505
+ | `USER_PREFERENCE_CREATE_FAILED` | `User Preference Create Failed` | yes |
506
+ | `USER_PREFERENCE_UPDATE_SUCCESS` | `User Preference Update Success` | yes |
507
+ | `USER_PREFERENCE_UPDATE_FAILED` | `User Preference Update Failed` | yes |
508
+ | `USER_PREFERENCE_DELETE_SUCCESS` | `User Preference Delete Success` | yes |
509
+ | `USER_PREFERENCE_DELETE_FAILED` | `User Preference Delete Failed` | yes |
510
+
511
+ Defined names without an `eventTaxonomyMap` entry: `WEBSOCKET_DEREGISTER_SUCCESS`, `WEBSOCKET_DEREGISTER_FAIL`, `WEBSOCKET_EVENT_RECEIVED`, all eight AI Assistant request names, and the seven Agent Wellness Break notification/action/system-code/ASC names listed above.
390
512
 
391
513
  ## Requires (dependencies)
392
514
  - `webex.internal.newMetrics` submission APIs
@@ -409,6 +531,7 @@ Defined names without an `eventTaxonomyMap` entry: `AI_ASSISTANT_FETCH_HISTORIC_
409
531
  | METRICS-R-003 | When metrics are disabled, clear pending events and make `timeEvent` plus all tracking methods return without recording/submitting. | Telemetry must never block or alter product behavior and disablement must be comprehensive. | `src/metrics/MetricsManager.ts` | `test/unit/spec/metrics/MetricsManager.ts` | None; source and test evidence rechecked during the 2026-07-09 remediation; independent document revalidation pending. | PRESENT |
410
532
  | METRICS-R-004 | Queue submissions until the host SDK is ready and flush through the correct behavioral/operational/business service. | Early lifecycle telemetry must not be lost solely because the host is not ready. | `src/metrics/MetricsManager.ts` | `test/unit/spec/metrics/MetricsManager.ts` | None; source and test evidence rechecked during the 2026-07-09 remediation; independent document revalidation pending. | PRESENT |
411
533
  | METRICS-R-005 | Submit through the host SDK's `webex.internal.newMetrics` client without storing credentials or implementing authorization policy in MetricsManager. | Host-owned authentication keeps telemetry credential handling outside the Contact Center metrics module. | `src/metrics/MetricsManager.ts` | `test/unit/spec/metrics/MetricsManager.ts` | None; authentication is inherited and credential ownership is explicitly N/A. | PRESENT |
534
+ | METRICS-R-006 | Track wellness action, invalid notification, system-code lookup, and ASC state-change outcomes as operational metrics using fixed names and reason-only/context-minimized payloads. | The feature needs diagnosable lifecycle signals without logging wellness payloads or agent PII. | `src/metrics/constants.ts`, `src/cc.ts`, `src/services/ApiAiAssistant.ts` | `test/unit/spec/cc.ts`, `test/unit/spec/services/ApiAiAssistant.ts` | These names intentionally have no behavioral taxonomy. | PRESENT |
412
535
 
413
536
  ## Design Overview
414
537
  Metrics separates its stable consumption boundary from collaborators so ownership and failure behavior stay explicit. Telemetry is deliberately non-blocking and queue-backed so product behavior never waits for metrics; failures are logged rather than propagated.
@@ -431,16 +554,7 @@ Each behavioral event maps to a structured taxonomy in `behavioral-events.ts`:
431
554
 
432
555
  **Example**: `STATION_LOGIN_SUCCESS` maps to `wxcc_sdk.user.station_login.complete`
433
556
 
434
- > **Note**: The following events do **not** have behavioral taxonomy mappings in `behavioral-events.ts`:
435
- > - `AI_ASSISTANT_SEND_EVENT_SUCCESS`
436
- > - `AI_ASSISTANT_SEND_EVENT_FAILED`
437
- > - `AI_ASSISTANT_GET_SUGGESTED_RESPONSE_SUCCESS`
438
- > - `AI_ASSISTANT_GET_SUGGESTED_RESPONSE_FAILED`
439
- > - `AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_SUCCESS`
440
- > - `AI_ASSISTANT_FETCH_HISTORIC_TRANSCRIPTS_FAILED`
441
- > - `WEBSOCKET_DEREGISTER_SUCCESS`
442
- > - `WEBSOCKET_DEREGISTER_FAIL`
443
- > - `WEBSOCKET_EVENT_RECEIVED`
557
+ > **Note**: The 20 names catalogued above as lacking `eventTaxonomyMap` entries, including all nine new wellness-related names, are operational-only.
444
558
  >
445
559
  > Calling `trackBehavioralEvent` with these event names will push an event with an `undefined` taxonomy.
446
560
 
@@ -463,6 +577,8 @@ Example: `wxcc_sdk.user.station_login.complete`
463
577
 
464
578
  The mapping is defined in `behavioral-events.ts` via `eventTaxonomyMap` and accessed through `getEventTaxonomy(name)`.
465
579
 
580
+ Participant Drop uses target `task_conference_participant_drop` with `complete` for success and `fail` for failure. Its metric payload is limited to task/request correlation and standard AQM tracking fields; participant IDs, numbers, names, URLs, headers, and raw routing payloads are excluded.
581
+
466
582
  ```mermaid
467
583
  flowchart LR
468
584
  A[timeEvent keys] --> B[runningEvents stores startTime + key Set]
@@ -728,7 +844,7 @@ MetricsManager holds three pending queues, running timing entries, a readiness f
728
844
 
729
845
  ## Business Rules & Invariants
730
846
  - `timeEvent` and every tracking method return immediately while metrics are disabled.
731
- - Only names present in `eventTaxonomyMap` receive behavioral taxonomy; 71 of 80 names are mapped and the six AI Assistant plus three WebSocket names are intentionally catalogued as unmapped.
847
+ - Only names present in `eventTaxonomyMap` receive behavioral taxonomy; 81 of 101 names are mapped and all 20 exceptions are explicitly catalogued as unmapped.
732
848
  - `submittingEvents` prevents overlapping queue-drain executions.
733
849
  - Authentication is inherited from the host Webex SDK's metrics client; MetricsManager owns no credentials, tokens, or authorization policy.
734
850
 
@@ -763,7 +879,7 @@ stateDiagram-v2
763
879
  - **metricsDisabled**: When `true`, `timeEvent` and all `track*` methods return early, and `clearPendingEvents()` empties all queues.
764
880
 
765
881
  ## Pitfalls
766
- - `METRIC_EVENT_NAMES` and `eventTaxonomyMap` are different inventories: nine defined names intentionally have no behavioral taxonomy.
882
+ - `METRIC_EVENT_NAMES` and `eventTaxonomyMap` are different inventories: 24 defined names intentionally have no behavioral taxonomy.
767
883
  - `setMetricsDisabled(true)` clears pending queues but does not create a delivery receipt; callers must not infer that previously submitted events were accepted.
768
884
  - Submission helpers hand events to `webex.internal.newMetrics` without a module-level retry/requeue policy, so telemetry must remain non-blocking and non-authoritative.
769
885
 
@@ -824,10 +940,11 @@ Use `test/unit/spec/metrics/MetricsManager.ts` for readiness queues, timing/trac
824
940
  | Behavior / Requirement | Existing test evidence | Gap |
825
941
  |---|---|---|
826
942
  | `METRICS-R-001` | `test/unit/spec/metrics/MetricsManager.ts` | Add a catalog parity assertion if constants change. |
827
- | `METRICS-R-002` | `test/unit/spec/metrics/behavioral-events.ts` | Keep explicit coverage for all nine unmapped names. |
943
+ | `METRICS-R-002` | `test/unit/spec/metrics/behavioral-events.ts` | Keep explicit coverage for all 24 unmapped names. |
828
944
  | `METRICS-R-003` | `test/unit/spec/metrics/MetricsManager.ts` | None. |
829
945
  | `METRICS-R-004` | `test/unit/spec/metrics/MetricsManager.ts` | None. |
830
946
  | `METRICS-R-005` | `test/unit/spec/metrics/MetricsManager.ts` | Authentication ownership is verified indirectly through the host metrics client. |
947
+ | `METRICS-R-006` | `test/unit/spec/cc.ts`, `test/unit/spec/services/ApiAiAssistant.ts` | Add direct catalog-parity coverage if metrics constants receive a dedicated test. |
831
948
 
832
949
  ## Traceability
833
950
  - Repo architecture: `../../../ai-docs/ARCHITECTURE.md` · Registry: `../../../ai-docs/SPEC_INDEX.md`