@webex/contact-center 3.12.0-next.9 → 3.12.0-next.90

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 (229) hide show
  1. package/.sdd/manifest.json +876 -0
  2. package/AGENTS.md +94 -0
  3. package/ai-docs/ARCHITECTURE.md +168 -0
  4. package/ai-docs/CONTRACTS.md +46 -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 +48 -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 +341 -0
  17. package/ai-docs/features/generated-spec-conformance-fidelity-remediation/spec/feature-spec.md +117 -0
  18. package/ai-docs/features/residual-warning-coverage-completion/spec/feature-spec.md +203 -0
  19. package/ai-docs/features/validator-code-fidelity-drift-fix/spec/feature-spec.md +315 -0
  20. package/ai-docs/patterns/event-driven-patterns.md +485 -0
  21. package/ai-docs/patterns/testing-patterns.md +480 -0
  22. package/ai-docs/patterns/typescript-patterns.md +365 -0
  23. package/ai-docs/templates/README.md +102 -0
  24. package/ai-docs/templates/documentation/create-agents-md.md +240 -0
  25. package/ai-docs/templates/documentation/create-architecture-md.md +295 -0
  26. package/ai-docs/templates/existing-service/bug-fix.md +254 -0
  27. package/ai-docs/templates/existing-service/feature-enhancement.md +450 -0
  28. package/ai-docs/templates/new-method/00-master.md +80 -0
  29. package/ai-docs/templates/new-method/01-requirements.md +232 -0
  30. package/ai-docs/templates/new-method/02-implementation.md +295 -0
  31. package/ai-docs/templates/new-method/03-tests.md +201 -0
  32. package/ai-docs/templates/new-method/04-validation.md +141 -0
  33. package/ai-docs/templates/new-service/00-master.md +109 -0
  34. package/ai-docs/templates/new-service/01-pre-questions.md +159 -0
  35. package/ai-docs/templates/new-service/02-code-generation.md +346 -0
  36. package/ai-docs/templates/new-service/03-integration.md +178 -0
  37. package/ai-docs/templates/new-service/04-test-generation.md +205 -0
  38. package/ai-docs/templates/new-service/05-validation.md +145 -0
  39. package/dist/cc.js +265 -29
  40. package/dist/cc.js.map +1 -1
  41. package/dist/config.js +6 -0
  42. package/dist/config.js.map +1 -1
  43. package/dist/constants.js +17 -1
  44. package/dist/constants.js.map +1 -1
  45. package/dist/index.js +20 -5
  46. package/dist/index.js.map +1 -1
  47. package/dist/metrics/behavioral-events.js +101 -0
  48. package/dist/metrics/behavioral-events.js.map +1 -1
  49. package/dist/metrics/constants.js +25 -4
  50. package/dist/metrics/constants.js.map +1 -1
  51. package/dist/services/ApiAiAssistant.js +153 -8
  52. package/dist/services/ApiAiAssistant.js.map +1 -1
  53. package/dist/services/UserPreference.js +427 -0
  54. package/dist/services/UserPreference.js.map +1 -0
  55. package/dist/services/config/Util.js +3 -3
  56. package/dist/services/config/Util.js.map +1 -1
  57. package/dist/services/config/constants.js +23 -2
  58. package/dist/services/config/constants.js.map +1 -1
  59. package/dist/services/config/types.js +49 -9
  60. package/dist/services/config/types.js.map +1 -1
  61. package/dist/services/core/Err.js.map +1 -1
  62. package/dist/services/core/Utils.js +107 -32
  63. package/dist/services/core/Utils.js.map +1 -1
  64. package/dist/services/core/websocket/WebSocketManager.js +2 -1
  65. package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
  66. package/dist/services/core/websocket/types.js.map +1 -1
  67. package/dist/services/index.js +1 -1
  68. package/dist/services/index.js.map +1 -1
  69. package/dist/services/task/Task.js +688 -0
  70. package/dist/services/task/Task.js.map +1 -0
  71. package/dist/services/task/TaskFactory.js +45 -0
  72. package/dist/services/task/TaskFactory.js.map +1 -0
  73. package/dist/services/task/TaskManager.js +728 -527
  74. package/dist/services/task/TaskManager.js.map +1 -1
  75. package/dist/services/task/TaskUtils.js +162 -26
  76. package/dist/services/task/TaskUtils.js.map +1 -1
  77. package/dist/services/task/constants.js +9 -2
  78. package/dist/services/task/constants.js.map +1 -1
  79. package/dist/services/task/dialer.js +78 -0
  80. package/dist/services/task/dialer.js.map +1 -1
  81. package/dist/services/task/digital/Digital.js +77 -0
  82. package/dist/services/task/digital/Digital.js.map +1 -0
  83. package/dist/services/task/state-machine/TaskStateMachine.js +837 -0
  84. package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -0
  85. package/dist/services/task/state-machine/actions.js +543 -0
  86. package/dist/services/task/state-machine/actions.js.map +1 -0
  87. package/dist/services/task/state-machine/constants.js +161 -0
  88. package/dist/services/task/state-machine/constants.js.map +1 -0
  89. package/dist/services/task/state-machine/guards.js +340 -0
  90. package/dist/services/task/state-machine/guards.js.map +1 -0
  91. package/dist/services/task/state-machine/index.js +53 -0
  92. package/dist/services/task/state-machine/index.js.map +1 -0
  93. package/dist/services/task/state-machine/types.js +54 -0
  94. package/dist/services/task/state-machine/types.js.map +1 -0
  95. package/dist/services/task/state-machine/uiControlsComputer.js +553 -0
  96. package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -0
  97. package/dist/services/task/taskDataNormalizer.js +99 -0
  98. package/dist/services/task/taskDataNormalizer.js.map +1 -0
  99. package/dist/services/task/types.js +212 -4
  100. package/dist/services/task/types.js.map +1 -1
  101. package/dist/services/task/voice/Voice.js +1042 -0
  102. package/dist/services/task/voice/Voice.js.map +1 -0
  103. package/dist/services/task/voice/WebRTC.js +149 -0
  104. package/dist/services/task/voice/WebRTC.js.map +1 -0
  105. package/dist/types/cc.d.ts +94 -1
  106. package/dist/types/config.d.ts +6 -0
  107. package/dist/types/constants.d.ts +17 -1
  108. package/dist/types/index.d.ts +21 -6
  109. package/dist/types/metrics/constants.d.ts +21 -1
  110. package/dist/types/services/ApiAiAssistant.d.ts +22 -4
  111. package/dist/types/services/UserPreference.d.ts +118 -0
  112. package/dist/types/services/config/constants.d.ts +21 -0
  113. package/dist/types/services/config/types.d.ts +171 -10
  114. package/dist/types/services/core/Err.d.ts +4 -0
  115. package/dist/types/services/core/Utils.d.ts +33 -13
  116. package/dist/types/services/core/websocket/WebSocketManager.d.ts +1 -0
  117. package/dist/types/services/core/websocket/types.d.ts +1 -1
  118. package/dist/types/services/index.d.ts +1 -1
  119. package/dist/types/services/task/Task.d.ts +157 -0
  120. package/dist/types/services/task/TaskFactory.d.ts +12 -0
  121. package/dist/types/services/task/TaskUtils.d.ts +46 -2
  122. package/dist/types/services/task/constants.d.ts +7 -0
  123. package/dist/types/services/task/dialer.d.ts +30 -0
  124. package/dist/types/services/task/digital/Digital.d.ts +22 -0
  125. package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +1144 -0
  126. package/dist/types/services/task/state-machine/actions.d.ts +10 -0
  127. package/dist/types/services/task/state-machine/constants.d.ts +107 -0
  128. package/dist/types/services/task/state-machine/guards.d.ts +90 -0
  129. package/dist/types/services/task/state-machine/index.d.ts +13 -0
  130. package/dist/types/services/task/state-machine/types.d.ts +267 -0
  131. package/dist/types/services/task/state-machine/uiControlsComputer.d.ts +9 -0
  132. package/dist/types/services/task/taskDataNormalizer.d.ts +10 -0
  133. package/dist/types/services/task/types.d.ts +603 -66
  134. package/dist/types/services/task/voice/Voice.d.ts +184 -0
  135. package/dist/types/services/task/voice/WebRTC.d.ts +53 -0
  136. package/dist/types/types.d.ts +135 -0
  137. package/dist/types/webex.d.ts +1 -0
  138. package/dist/types.js +118 -2
  139. package/dist/types.js.map +1 -1
  140. package/dist/webex.js +14 -2
  141. package/dist/webex.js.map +1 -1
  142. package/package.json +15 -12
  143. package/src/cc.ts +329 -30
  144. package/src/config.ts +6 -0
  145. package/src/constants.ts +17 -1
  146. package/src/index.ts +23 -5
  147. package/src/metrics/ai-docs/AGENTS.md +350 -0
  148. package/src/metrics/ai-docs/ARCHITECTURE.md +338 -0
  149. package/src/metrics/ai-docs/metrics-spec.md +854 -0
  150. package/src/metrics/behavioral-events.ts +106 -0
  151. package/src/metrics/constants.ts +27 -4
  152. package/src/services/ApiAiAssistant.ts +203 -8
  153. package/src/services/UserPreference.ts +509 -0
  154. package/src/services/agent/ai-docs/AGENTS.md +240 -0
  155. package/src/services/agent/ai-docs/ARCHITECTURE.md +304 -0
  156. package/src/services/agent/ai-docs/agent-spec.md +504 -0
  157. package/src/services/ai-docs/AGENTS.md +386 -0
  158. package/src/services/ai-docs/services-spec.md +492 -0
  159. package/src/services/config/Util.ts +3 -3
  160. package/src/services/config/ai-docs/AGENTS.md +255 -0
  161. package/src/services/config/ai-docs/ARCHITECTURE.md +426 -0
  162. package/src/services/config/ai-docs/config-spec.md +669 -0
  163. package/src/services/config/constants.ts +25 -1
  164. package/src/services/config/types.ts +174 -11
  165. package/src/services/core/Err.ts +2 -0
  166. package/src/services/core/Utils.ts +123 -37
  167. package/src/services/core/ai-docs/AGENTS.md +381 -0
  168. package/src/services/core/ai-docs/ARCHITECTURE.md +698 -0
  169. package/src/services/core/ai-docs/core-spec.md +783 -0
  170. package/src/services/core/websocket/WebSocketManager.ts +2 -0
  171. package/src/services/core/websocket/types.ts +1 -1
  172. package/src/services/index.ts +1 -1
  173. package/src/services/task/Task.ts +837 -0
  174. package/src/services/task/TaskFactory.ts +55 -0
  175. package/src/services/task/TaskManager.ts +739 -614
  176. package/src/services/task/TaskUtils.ts +205 -25
  177. package/src/services/task/ai-docs/AGENTS.md +457 -0
  178. package/src/services/task/ai-docs/ARCHITECTURE.md +594 -0
  179. package/src/services/task/ai-docs/task-spec.md +1319 -0
  180. package/src/services/task/constants.ts +7 -0
  181. package/src/services/task/dialer.ts +80 -0
  182. package/src/services/task/digital/Digital.ts +95 -0
  183. package/src/services/task/state-machine/TaskStateMachine.ts +1077 -0
  184. package/src/services/task/state-machine/actions.ts +685 -0
  185. package/src/services/task/state-machine/ai-docs/AGENTS.md +458 -0
  186. package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +1137 -0
  187. package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +2115 -0
  188. package/src/services/task/state-machine/constants.ts +172 -0
  189. package/src/services/task/state-machine/guards.ts +406 -0
  190. package/src/services/task/state-machine/index.ts +28 -0
  191. package/src/services/task/state-machine/types.ts +241 -0
  192. package/src/services/task/state-machine/uiControlsComputer.ts +867 -0
  193. package/src/services/task/taskDataNormalizer.ts +137 -0
  194. package/src/services/task/types.ts +710 -71
  195. package/src/services/task/voice/Voice.ts +1267 -0
  196. package/src/services/task/voice/WebRTC.ts +187 -0
  197. package/src/types.ts +166 -2
  198. package/src/utils/AGENTS.md +278 -0
  199. package/src/utils/ai-docs/utils-spec.md +381 -0
  200. package/src/webex.js +2 -0
  201. package/test/unit/spec/cc.ts +343 -23
  202. package/test/unit/spec/logger-proxy.ts +70 -0
  203. package/test/unit/spec/services/ApiAiAssistant.ts +178 -20
  204. package/test/unit/spec/services/UserPreference.ts +401 -0
  205. package/test/unit/spec/services/WebCallingService.ts +7 -1
  206. package/test/unit/spec/services/config/index.ts +30 -30
  207. package/test/unit/spec/services/core/Utils.ts +425 -8
  208. package/test/unit/spec/services/core/websocket/WebSocketManager.ts +66 -40
  209. package/test/unit/spec/services/task/AutoWrapup.ts +63 -0
  210. package/test/unit/spec/services/task/Task.ts +477 -0
  211. package/test/unit/spec/services/task/TaskFactory.ts +62 -0
  212. package/test/unit/spec/services/task/TaskManager.ts +834 -1704
  213. package/test/unit/spec/services/task/TaskUtils.ts +206 -0
  214. package/test/unit/spec/services/task/dialer.ts +190 -0
  215. package/test/unit/spec/services/task/digital/Digital.ts +105 -0
  216. package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +1825 -0
  217. package/test/unit/spec/services/task/state-machine/guards.ts +479 -0
  218. package/test/unit/spec/services/task/state-machine/types.ts +18 -0
  219. package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +2020 -0
  220. package/test/unit/spec/services/task/taskTestUtils.ts +87 -0
  221. package/test/unit/spec/services/task/voice/Voice.ts +631 -0
  222. package/test/unit/spec/services/task/voice/WebRTC.ts +235 -0
  223. package/umd/contact-center.min.js +2 -2
  224. package/umd/contact-center.min.js.map +1 -1
  225. package/dist/services/task/index.js +0 -1525
  226. package/dist/services/task/index.js.map +0 -1
  227. package/dist/types/services/task/index.d.ts +0 -650
  228. package/src/services/task/index.ts +0 -1801
  229. package/test/unit/spec/services/task/index.ts +0 -2184
@@ -0,0 +1,1267 @@
1
+ import {CC_FILE, METHODS} from '../../../constants';
2
+ import {
3
+ buildConsultConferenceParamData,
4
+ calculateDestAgentId,
5
+ calculateDestType,
6
+ getErrorDetails,
7
+ } from '../../core/Utils';
8
+ import routingContact from '../contact';
9
+ import {
10
+ ConsultPayload,
11
+ ConsultEndPayload,
12
+ ResumeRecordingPayload,
13
+ TaskData,
14
+ TaskResponse,
15
+ IVoice,
16
+ VoiceUIControlOptions,
17
+ TransferPayLoad,
18
+ ConsultTransferPayLoad,
19
+ consultConferencePayloadData,
20
+ CONSULT_TRANSFER_DESTINATION_TYPE,
21
+ TASK_EVENTS,
22
+ VOICE_VARIANT,
23
+ } from '../types';
24
+ import Task from '../Task';
25
+ import LoggerProxy from '../../../logger-proxy';
26
+ import MetricsManager from '../../../metrics/MetricsManager';
27
+ import {METRIC_EVENT_NAMES} from '../../../metrics/constants';
28
+ import {TaskState, TaskEvent, TaskActionArgs} from '../state-machine';
29
+ import {WrapupData} from '../../config/types';
30
+ import {getConsultMediaResourceId, getIsConferenceInProgress} from '../TaskUtils';
31
+
32
+ export default class Voice extends Task implements IVoice {
33
+ constructor(
34
+ contact: ReturnType<typeof routingContact>,
35
+ data: TaskData,
36
+ callOptions?: VoiceUIControlOptions,
37
+ wrapupData?: WrapupData,
38
+ agentId?: string
39
+ ) {
40
+ const resolvedOptions = {
41
+ isEndTaskEnabled: callOptions?.isEndTaskEnabled ?? true,
42
+ isEndConsultEnabled: callOptions?.isEndConsultEnabled ?? true,
43
+ voiceVariant: callOptions?.voiceVariant ?? VOICE_VARIANT.PSTN,
44
+ isRecordingEnabled: callOptions?.isRecordingEnabled ?? true,
45
+ };
46
+
47
+ super(
48
+ contact,
49
+ data,
50
+ {
51
+ ...resolvedOptions,
52
+ },
53
+ wrapupData,
54
+ agentId
55
+ );
56
+ }
57
+
58
+ private getStateMachineSnapshot() {
59
+ return this.stateMachineService?.getSnapshot?.();
60
+ }
61
+
62
+ /**
63
+ * This method is used to accept the task.
64
+ * It is expected to be overridden by child classes.
65
+ * @returns Promise<TaskResponse>
66
+ * @throws Error
67
+ */
68
+ public async accept(): Promise<TaskResponse> {
69
+ super.unsupportedMethodError(METHODS.ACCEPT);
70
+ }
71
+
72
+ /**
73
+ * This method is used to decline the task.
74
+ * It is expected to be overridden by child classes.
75
+ * @returns Promise<TaskResponse>
76
+ * @throws Error
77
+ */
78
+ public async decline(): Promise<TaskResponse> {
79
+ super.unsupportedMethodError(METHODS.REJECT);
80
+ }
81
+
82
+ /**
83
+ * This is used to hold the task.
84
+ * @returns Promise<TaskResponse>
85
+ * @throws Error
86
+ * @example
87
+ * ```typescript
88
+ * task.hold().then(()=>{}).catch(()=>{})
89
+ * ```
90
+ * */
91
+ public async hold(): Promise<TaskResponse> {
92
+ return this.holdResume();
93
+ }
94
+
95
+ /**
96
+ * This is used to resume the task.
97
+ * @returns Promise<TaskResponse>
98
+ * @throws Error
99
+ * @example
100
+ * ```typescript
101
+ * task.resume().then(()=>{}).catch(()=>{})
102
+ * ```
103
+ * */
104
+ public async resume(): Promise<TaskResponse> {
105
+ return this.holdResume();
106
+ }
107
+
108
+ /**
109
+ * This is used to hold or resume the task.
110
+ * @param isHeld: boolean - true to hold the task, false to resume it
111
+ * @returns Promise<TaskResponse>
112
+ * @throws Error
113
+ * @example
114
+ * ```typescript
115
+ * task.holdResume(isHeld: true).then(()=>{}).catch(()=>{})
116
+ * ```
117
+ * */
118
+ public async holdResume(): Promise<TaskResponse> {
119
+ /*
120
+ Determine if the task is being held or resumed based on the media resource state
121
+ If the media resource is not found, default to resuming the task
122
+ */
123
+ const snapshot = this.getStateMachineSnapshot();
124
+ const snapshotState = snapshot?.value as TaskState | undefined;
125
+ const mainInteractionId = this.data.interaction?.mainInteractionId || this.data.interactionId;
126
+ const mainMediaResource =
127
+ this.data.interaction?.media?.[mainInteractionId]?.mediaResourceId ||
128
+ this.data.mediaResourceId;
129
+ const mediaHoldState =
130
+ this.data.interaction?.media?.[mainInteractionId]?.isHold ??
131
+ this.data.interaction.media?.[mainMediaResource]?.isHold;
132
+ let shouldHold = !(mediaHoldState ?? false);
133
+ if (snapshotState === TaskState.HELD) {
134
+ shouldHold = false;
135
+ } else if (snapshotState === TaskState.CONNECTED) {
136
+ shouldHold = true;
137
+ }
138
+
139
+ // Validate operation is allowed in current state
140
+ const state = snapshot;
141
+ if (state) {
142
+ const currentState = state.value as TaskState;
143
+ if (shouldHold) {
144
+ if (!state.matches(TaskState.CONNECTED)) {
145
+ const error = new Error(`Cannot hold call in current state: ${currentState}`);
146
+ LoggerProxy.error('Hold operation not allowed', {
147
+ module: CC_FILE,
148
+ method: METHODS.HOLD_RESUME,
149
+ interactionId: this.data.interactionId,
150
+ });
151
+ throw error;
152
+ }
153
+ } else if (
154
+ !state.matches(TaskState.HELD) &&
155
+ !(state.matches(TaskState.CONFERENCING) && mediaHoldState === true)
156
+ ) {
157
+ const error = new Error(`Cannot resume call in current state: ${currentState}`);
158
+ LoggerProxy.error('Resume operation not allowed', {
159
+ module: CC_FILE,
160
+ method: METHODS.HOLD_RESUME,
161
+ interactionId: this.data.interactionId,
162
+ });
163
+ throw error;
164
+ }
165
+ }
166
+
167
+ // Send initiating event to transition to intermediate state
168
+ if (this.stateMachineService) {
169
+ const initiatingEvent = shouldHold ? TaskEvent.HOLD_INITIATED : TaskEvent.UNHOLD_INITIATED;
170
+ this.stateMachineService.send({
171
+ type: initiatingEvent,
172
+ mediaResourceId: mainMediaResource,
173
+ });
174
+ }
175
+
176
+ LoggerProxy.info(`${shouldHold ? 'Holding' : 'Resuming'} task`, {
177
+ module: CC_FILE,
178
+ method: METHODS.HOLD_RESUME,
179
+ interactionId: this.data.interactionId,
180
+ });
181
+ const [successEvt, failedEvt] = shouldHold
182
+ ? [METRIC_EVENT_NAMES.TASK_HOLD_SUCCESS, METRIC_EVENT_NAMES.TASK_HOLD_FAILED]
183
+ : [METRIC_EVENT_NAMES.TASK_RESUME_SUCCESS, METRIC_EVENT_NAMES.TASK_RESUME_FAILED];
184
+
185
+ this.metricsManager.timeEvent([successEvt, failedEvt]);
186
+
187
+ try {
188
+ let response: TaskResponse;
189
+ if (shouldHold) {
190
+ response = await this.contact.hold({
191
+ interactionId: this.data.interactionId,
192
+ data: {mediaResourceId: mainMediaResource},
193
+ });
194
+
195
+ // Send success event to complete the transition
196
+ if (this.stateMachineService) {
197
+ this.stateMachineService.send({
198
+ type: TaskEvent.HOLD_SUCCESS,
199
+ mediaResourceId: mainMediaResource,
200
+ });
201
+ }
202
+
203
+ this.metricsManager.trackEvent(
204
+ successEvt,
205
+ {
206
+ taskId: this.data.interactionId,
207
+ mediaResourceId: mainMediaResource,
208
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
209
+ },
210
+ ['operational', 'behavioral']
211
+ );
212
+ LoggerProxy.log(`Task placed on hold successfully`, {
213
+ module: CC_FILE,
214
+ method: METHODS.HOLD_RESUME,
215
+ trackingId: response.trackingId,
216
+ interactionId: this.data.interactionId,
217
+ });
218
+ } else {
219
+ response = await this.contact.unHold({
220
+ interactionId: this.data.interactionId,
221
+ data: {mediaResourceId: mainMediaResource},
222
+ });
223
+
224
+ // Send success event to complete the transition
225
+ if (this.stateMachineService) {
226
+ this.stateMachineService.send({
227
+ type: TaskEvent.UNHOLD_SUCCESS,
228
+ mediaResourceId: mainMediaResource,
229
+ });
230
+ }
231
+
232
+ this.metricsManager.trackEvent(
233
+ successEvt,
234
+ {
235
+ taskId: this.data.interactionId,
236
+ mainInteractionId,
237
+ mediaResourceId: mainMediaResource,
238
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
239
+ },
240
+ ['operational', 'behavioral']
241
+ );
242
+ LoggerProxy.log(`Task resumed successfully`, {
243
+ module: CC_FILE,
244
+ method: METHODS.HOLD_RESUME,
245
+ trackingId: response.trackingId,
246
+ interactionId: this.data.interactionId,
247
+ });
248
+ }
249
+
250
+ return response;
251
+ } catch (error) {
252
+ const failureEvent = shouldHold ? TaskEvent.HOLD_FAILED : TaskEvent.UNHOLD_FAILED;
253
+ this.stateMachineService.send({
254
+ type: failureEvent,
255
+ reason: error.toString(),
256
+ mediaResourceId: this.data.mediaResourceId,
257
+ });
258
+
259
+ const {error: detailedError} = getErrorDetails(error, 'holdResume', CC_FILE);
260
+ this.metricsManager.trackEvent(
261
+ failedEvt,
262
+ shouldHold
263
+ ? {
264
+ taskId: this.data.interactionId,
265
+ mediaResourceId: this.data.mediaResourceId,
266
+ error: error.toString(),
267
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
268
+ }
269
+ : {
270
+ taskId: this.data.interactionId,
271
+ error: error.toString(),
272
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
273
+ },
274
+ ['operational', 'behavioral']
275
+ );
276
+ throw detailedError;
277
+ }
278
+ }
279
+
280
+ /**
281
+ * This is used to pause the call recording
282
+ * @returns Promise<TaskResponse>
283
+ * @throws Error
284
+ * @example
285
+ * ```typescript
286
+ * task.pauseRecording().then(()=>{}).catch(()=>{});
287
+ * ```
288
+ */
289
+ public async pauseRecording(): Promise<TaskResponse> {
290
+ // Validate recording is active
291
+ const state = this.getStateMachineSnapshot();
292
+ if (state) {
293
+ const {recordingControlsAvailable, recordingInProgress} = state.context as {
294
+ recordingControlsAvailable?: boolean;
295
+ recordingInProgress?: boolean;
296
+ };
297
+ const recordingActive = Boolean(recordingControlsAvailable && recordingInProgress);
298
+ if (!recordingActive) {
299
+ const error = new Error('Recording is not active or already paused');
300
+ LoggerProxy.error('Pause recording operation not allowed', {
301
+ module: CC_FILE,
302
+ method: 'pauseRecording',
303
+ interactionId: this.data.interactionId,
304
+ });
305
+ throw error;
306
+ }
307
+ }
308
+
309
+ try {
310
+ LoggerProxy.info(`Pausing recording`, {
311
+ module: CC_FILE,
312
+ method: 'pauseRecording',
313
+ interactionId: this.data.interactionId,
314
+ });
315
+ this.metricsManager.timeEvent([
316
+ METRIC_EVENT_NAMES.TASK_PAUSE_RECORDING_SUCCESS,
317
+ METRIC_EVENT_NAMES.TASK_PAUSE_RECORDING_FAILED,
318
+ ]);
319
+ const result = await this.contact.pauseRecording({interactionId: this.data.interactionId});
320
+ this.metricsManager.trackEvent(
321
+ METRIC_EVENT_NAMES.TASK_PAUSE_RECORDING_SUCCESS,
322
+ {
323
+ taskId: this.data.interactionId,
324
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(result),
325
+ },
326
+ ['operational', 'behavioral', 'business']
327
+ );
328
+ LoggerProxy.log(`Recording paused successfully`, {
329
+ module: CC_FILE,
330
+ method: 'pauseRecording',
331
+ trackingId: result.trackingId,
332
+ interactionId: this.data.interactionId,
333
+ });
334
+
335
+ return result;
336
+ } catch (error) {
337
+ const {error: detailedError} = getErrorDetails(error, 'pauseRecording', CC_FILE);
338
+ this.metricsManager.trackEvent(
339
+ METRIC_EVENT_NAMES.TASK_PAUSE_RECORDING_FAILED,
340
+ {
341
+ taskId: this.data.interactionId,
342
+ error: error.toString(),
343
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
344
+ },
345
+ ['operational', 'behavioral', 'business']
346
+ );
347
+ throw detailedError;
348
+ }
349
+ }
350
+
351
+ /**
352
+ * This is used to pause the call recording
353
+ * @param resumeRecordingPayload
354
+ * @returns Promise<TaskResponse>
355
+ * @throws Error
356
+ * @example
357
+ * ```typescript
358
+ * task.resumeRecording(resumeRecordingPayload).then(()=>{}).catch(()=>{});
359
+ * ```
360
+ */
361
+ public async resumeRecording(
362
+ resumeRecordingPayload?: ResumeRecordingPayload
363
+ ): Promise<TaskResponse> {
364
+ // Validate recording is paused
365
+ const state = this.getStateMachineSnapshot();
366
+ if (state) {
367
+ const {recordingControlsAvailable, recordingInProgress} = state.context as {
368
+ recordingControlsAvailable?: boolean;
369
+ recordingInProgress?: boolean;
370
+ };
371
+ const recordingPaused = Boolean(recordingControlsAvailable && !recordingInProgress);
372
+ if (!recordingPaused) {
373
+ const error = new Error('Recording is not paused');
374
+ LoggerProxy.error('Resume recording operation not allowed', {
375
+ module: CC_FILE,
376
+ method: 'resumeRecording',
377
+ interactionId: this.data.interactionId,
378
+ });
379
+ throw error;
380
+ }
381
+ }
382
+
383
+ try {
384
+ LoggerProxy.info(`Resuming recording`, {
385
+ module: CC_FILE,
386
+ method: 'resumeRecording',
387
+ interactionId: this.data.interactionId,
388
+ });
389
+ this.metricsManager.timeEvent([
390
+ METRIC_EVENT_NAMES.TASK_RESUME_RECORDING_SUCCESS,
391
+ METRIC_EVENT_NAMES.TASK_RESUME_RECORDING_FAILED,
392
+ ]);
393
+ resumeRecordingPayload ??= {autoResumed: false};
394
+
395
+ const result = await this.contact.resumeRecording({
396
+ interactionId: this.data.interactionId,
397
+ data: resumeRecordingPayload,
398
+ });
399
+ this.metricsManager.trackEvent(
400
+ METRIC_EVENT_NAMES.TASK_RESUME_RECORDING_SUCCESS,
401
+ {
402
+ taskId: this.data.interactionId,
403
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(result),
404
+ },
405
+ ['operational', 'behavioral', 'business']
406
+ );
407
+ LoggerProxy.log(`Recording resumed successfully`, {
408
+ module: CC_FILE,
409
+ method: 'resumeRecording',
410
+ trackingId: result.trackingId,
411
+ interactionId: this.data.interactionId,
412
+ });
413
+
414
+ return result;
415
+ } catch (error) {
416
+ const {error: detailedError} = getErrorDetails(error, 'resumeRecording', CC_FILE);
417
+ this.metricsManager.trackEvent(
418
+ METRIC_EVENT_NAMES.TASK_RESUME_RECORDING_FAILED,
419
+ {
420
+ taskId: this.data.interactionId,
421
+ error: error.toString(),
422
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
423
+ },
424
+ ['operational', 'behavioral', 'business']
425
+ );
426
+ throw detailedError;
427
+ }
428
+ }
429
+
430
+ /**
431
+ * This is used to consult the task
432
+ * @param consultPayload
433
+ * @returns Promise<TaskResponse>
434
+ * @throws Error
435
+ * @example
436
+ * ```typescript
437
+ * const consultPayload = {
438
+ * destination: 'myBuddyAgentId',
439
+ * destinationType: DESTINATION_TYPE.AGENT,
440
+ * }
441
+ * task.consult(consultPayload).then(()=>{}).catch(()=>{});
442
+ * ```
443
+ * */
444
+ public async consult(consultPayload?: ConsultPayload): Promise<TaskResponse> {
445
+ // Validate consult is allowed
446
+ const state = this.getStateMachineSnapshot();
447
+ const canConsult =
448
+ state &&
449
+ (state.matches(TaskState.CONNECTED) ||
450
+ state.matches(TaskState.HELD) ||
451
+ state.matches(TaskState.CONFERENCING));
452
+
453
+ if (!canConsult) {
454
+ const currentState = state?.value as TaskState;
455
+ const error = new Error(`Cannot initiate consult in ${currentState} state`);
456
+ LoggerProxy.error('Consult operation not allowed', {
457
+ module: CC_FILE,
458
+ method: 'consult',
459
+ interactionId: this.data.interactionId,
460
+ });
461
+ throw error;
462
+ }
463
+
464
+ // Send initiating event to transition to CONSULT_INITIATING state
465
+ if (this.stateMachineService) {
466
+ this.stateMachineService.send({
467
+ type: TaskEvent.CONSULT,
468
+ destination: consultPayload.to,
469
+ destinationType: consultPayload.destinationType,
470
+ });
471
+ }
472
+
473
+ const requestInteractionId =
474
+ this.data.interaction?.mainInteractionId || this.data.interactionId;
475
+
476
+ try {
477
+ LoggerProxy.info(`Starting consult`, {
478
+ module: CC_FILE,
479
+ method: 'consult',
480
+ interactionId: requestInteractionId,
481
+ });
482
+ this.metricsManager.timeEvent([
483
+ METRIC_EVENT_NAMES.TASK_CONSULT_START_SUCCESS,
484
+ METRIC_EVENT_NAMES.TASK_CONSULT_START_FAILED,
485
+ ]);
486
+ const result = await this.contact.consult({
487
+ interactionId: requestInteractionId,
488
+ data: consultPayload,
489
+ });
490
+
491
+ // Send success event to transition to CONSULTING state
492
+ if (this.stateMachineService) {
493
+ this.stateMachineService.send({
494
+ type: TaskEvent.CONSULT_SUCCESS,
495
+ taskData: result.data,
496
+ });
497
+ }
498
+
499
+ this.metricsManager.trackEvent(
500
+ METRIC_EVENT_NAMES.TASK_CONSULT_START_SUCCESS,
501
+ {
502
+ taskId: this.data.interactionId,
503
+ requestInteractionId,
504
+ destination: consultPayload.to,
505
+ destinationType: consultPayload.destinationType,
506
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(result),
507
+ },
508
+ ['operational', 'behavioral', 'business']
509
+ );
510
+ LoggerProxy.log(`Consult successfully initiated to ${consultPayload.to}`, {
511
+ module: CC_FILE,
512
+ method: 'consult',
513
+ trackingId: result.trackingId,
514
+ interactionId: requestInteractionId,
515
+ });
516
+
517
+ return result;
518
+ } catch (error) {
519
+ this.stateMachineService.send({
520
+ type: TaskEvent.CONSULT_FAILED,
521
+ reason: error.toString(),
522
+ });
523
+
524
+ const {error: detailedError} = getErrorDetails(error, 'consult', CC_FILE);
525
+ this.metricsManager.trackEvent(
526
+ METRIC_EVENT_NAMES.TASK_CONSULT_START_FAILED,
527
+ {
528
+ taskId: this.data.interactionId,
529
+ requestInteractionId,
530
+ destination: consultPayload.to,
531
+ destinationType: consultPayload.destinationType,
532
+ error: error.toString(),
533
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
534
+ },
535
+ ['operational', 'behavioral', 'business']
536
+ );
537
+ throw detailedError;
538
+ }
539
+ }
540
+
541
+ /**
542
+ * This is used to end the consult session on the task.
543
+ * @param consultEndPayload - Payload indicating consult end flags and identifiers
544
+ * @returns Promise<TaskResponse>
545
+ * @throws Error
546
+ * @example
547
+ * ```typescript
548
+ * task.endConsult({
549
+ * isConsult: true,
550
+ * queueId: 'myQueueId',
551
+ * taskId: 'taskId',
552
+ * });
553
+ * ```
554
+ */
555
+ public async endConsult(consultEndPayload?: ConsultEndPayload): Promise<TaskResponse> {
556
+ const requestInteractionId =
557
+ this.data.interaction?.mainInteractionId || this.data.interactionId;
558
+
559
+ try {
560
+ LoggerProxy.info(`Ending consult`, {
561
+ module: CC_FILE,
562
+ method: 'endConsult',
563
+ interactionId: requestInteractionId,
564
+ });
565
+ this.metricsManager.timeEvent([
566
+ METRIC_EVENT_NAMES.TASK_CONSULT_END_SUCCESS,
567
+ METRIC_EVENT_NAMES.TASK_CONSULT_END_FAILED,
568
+ ]);
569
+ const result = await this.contact.consultEnd({
570
+ interactionId: requestInteractionId,
571
+ data: consultEndPayload,
572
+ });
573
+ this.metricsManager.trackEvent(
574
+ METRIC_EVENT_NAMES.TASK_CONSULT_END_SUCCESS,
575
+ {
576
+ taskId: this.data.interactionId,
577
+ requestInteractionId,
578
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(result),
579
+ },
580
+ ['operational', 'behavioral', 'business']
581
+ );
582
+ LoggerProxy.log(`Consult ended successfully`, {
583
+ module: CC_FILE,
584
+ method: 'endConsult',
585
+ trackingId: result.trackingId,
586
+ interactionId: this.data.interactionId,
587
+ });
588
+
589
+ return result;
590
+ } catch (error) {
591
+ const {error: detailedError} = getErrorDetails(error, 'endConsult', CC_FILE);
592
+ this.metricsManager.trackEvent(
593
+ METRIC_EVENT_NAMES.TASK_CONSULT_END_FAILED,
594
+ {
595
+ taskId: this.data.interactionId,
596
+ requestInteractionId,
597
+ error: error.toString(),
598
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
599
+ },
600
+ ['operational', 'behavioral', 'business']
601
+ );
602
+ throw detailedError;
603
+ }
604
+ }
605
+
606
+ /**
607
+ * This is used to transfer the task.
608
+ * @param payload - Transfer payload
609
+ * @returns Promise<TaskResponse>
610
+ * @throws Error
611
+ * @example
612
+ * ```typescript
613
+ * task.transfer({
614
+ * to: 'destinationId',
615
+ * destinationType: DESTINATION_TYPE.AGENT,
616
+ * consult: true, // Optional, if true will perform a consult transfer else blind transfer
617
+ * });
618
+ * ```
619
+ */
620
+ public async transfer(payload: TransferPayLoad): Promise<TaskResponse> {
621
+ try {
622
+ LoggerProxy.info(`Transferring task to ${payload.to}`, {
623
+ module: CC_FILE,
624
+ method: METHODS.TRANSFER_CALL,
625
+ interactionId: this.data.interactionId,
626
+ });
627
+ this.metricsManager.timeEvent([
628
+ METRIC_EVENT_NAMES.TASK_TRANSFER_SUCCESS,
629
+ METRIC_EVENT_NAMES.TASK_TRANSFER_FAILED,
630
+ ]);
631
+
632
+ // consult transfer path
633
+ if (this.data.interaction.state === 'consulting') {
634
+ const normalizedDestinationType =
635
+ payload.destinationType === 'Agent' || payload.destinationType === 'Queue'
636
+ ? (payload.destinationType.toLowerCase() as ConsultTransferPayLoad['destinationType'])
637
+ : payload.destinationType;
638
+ let consultPayload: ConsultTransferPayLoad = {
639
+ to: payload.to,
640
+ destinationType: normalizedDestinationType,
641
+ };
642
+
643
+ if (normalizedDestinationType === CONSULT_TRANSFER_DESTINATION_TYPE.QUEUE) {
644
+ const consultContext = this.getStateMachineSnapshot()?.context;
645
+ const destAgent = consultContext?.consultDestinationAgentId || this.data.destAgentId;
646
+ if (!destAgent) {
647
+ throw new Error('No agent has accepted this queue consult yet');
648
+ }
649
+ consultPayload = {
650
+ to: destAgent,
651
+ destinationType: CONSULT_TRANSFER_DESTINATION_TYPE.AGENT,
652
+ };
653
+ }
654
+
655
+ const result = await this.contact.consultTransfer({
656
+ interactionId: this.data.interactionId,
657
+ data: consultPayload,
658
+ });
659
+ this.metricsManager.trackEvent(
660
+ METRIC_EVENT_NAMES.TASK_TRANSFER_SUCCESS,
661
+ {
662
+ taskId: this.data.interactionId,
663
+ destination: consultPayload.to,
664
+ destinationType: consultPayload.destinationType,
665
+ isConsultTransfer: true,
666
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(result),
667
+ },
668
+ ['operational', 'behavioral', 'business']
669
+ );
670
+ LoggerProxy.log(`Consult transfer completed successfully to ${consultPayload.to}`, {
671
+ module: CC_FILE,
672
+ method: METHODS.TRANSFER_CALL,
673
+ trackingId: result.trackingId,
674
+ interactionId: this.data.interactionId,
675
+ });
676
+
677
+ return result;
678
+ }
679
+
680
+ // standard blind transfer
681
+ return await super.transfer({
682
+ to: payload.to,
683
+ destinationType: payload.destinationType,
684
+ });
685
+ } catch (err) {
686
+ const {error: detailedError} = getErrorDetails(err, METHODS.TRANSFER_CALL, CC_FILE);
687
+ this.metricsManager.trackEvent(
688
+ METRIC_EVENT_NAMES.TASK_TRANSFER_FAILED,
689
+ {
690
+ taskId: this.data.interactionId,
691
+ destination: payload.to,
692
+ destinationType: payload.destinationType,
693
+ isConsultTransfer: this.data.interaction.state === 'consulting',
694
+ error: err.toString(),
695
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(err.details || {}),
696
+ },
697
+ ['operational', 'behavioral', 'business']
698
+ );
699
+ throw detailedError;
700
+ }
701
+ }
702
+
703
+ /**
704
+ * Start a consult conference, merging main and consult calls.
705
+ */
706
+ public async consultConference(): Promise<TaskResponse> {
707
+ const derivedDestAgentId =
708
+ this.data.interaction && this.data.agentId
709
+ ? calculateDestAgentId(this.data.interaction, this.data.agentId)
710
+ : '';
711
+ const derivedDestType =
712
+ this.data.interaction && this.data.agentId
713
+ ? calculateDestType(this.data.interaction, this.data.agentId)
714
+ : '';
715
+
716
+ // derivedDestType is most reliable as it inspects live interaction participants
717
+ const resolvedDestinationType =
718
+ derivedDestType ||
719
+ this.getStateMachineSnapshot()?.context?.consultDestinationType ||
720
+ this.data.destinationType ||
721
+ 'agent';
722
+
723
+ const consultationData: consultConferencePayloadData = {
724
+ agentId: this.data.agentId,
725
+ destinationType: resolvedDestinationType,
726
+ // derivedDestAgentId is most reliable as it resolves epId for EP_DN
727
+ // and agent ID for regular agents from live interaction data
728
+ destAgentId:
729
+ derivedDestAgentId ||
730
+ this.getStateMachineSnapshot()?.context?.consultDestinationAgentId ||
731
+ this.data.destAgentId,
732
+ };
733
+
734
+ // Send state machine event to transition to CONF_INITIATING
735
+ if (this.stateMachineService) {
736
+ this.stateMachineService.send({
737
+ type: TaskEvent.MERGE_TO_CONFERENCE,
738
+ });
739
+ }
740
+
741
+ try {
742
+ if (!consultationData.destAgentId) {
743
+ throw new Error('Unable to determine consult destination for conference');
744
+ }
745
+
746
+ LoggerProxy.info(`Initiating consult conference to ${consultationData.destAgentId}`, {
747
+ module: CC_FILE,
748
+ method: METHODS.CONSULT_CONFERENCE,
749
+ interactionId: this.data.interactionId,
750
+ });
751
+
752
+ const paramsDataForConferenceV2 = buildConsultConferenceParamData(
753
+ consultationData,
754
+ this.data.interactionId
755
+ );
756
+
757
+ const response = await this.contact.consultConference({
758
+ interactionId: paramsDataForConferenceV2.interactionId,
759
+ data: paramsDataForConferenceV2.data,
760
+ });
761
+
762
+ // Send success event to transition to CONFERENCING
763
+ if (this.stateMachineService) {
764
+ this.stateMachineService.send({
765
+ type: TaskEvent.CONFERENCE_START,
766
+ });
767
+ }
768
+
769
+ this.metricsManager.trackEvent(
770
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_START_SUCCESS,
771
+ {
772
+ taskId: this.data.interactionId,
773
+ destination: paramsDataForConferenceV2.data.to,
774
+ destinationType: paramsDataForConferenceV2.data.destinationType,
775
+ agentId: paramsDataForConferenceV2.data.agentId,
776
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
777
+ },
778
+ ['operational', 'behavioral', 'business']
779
+ );
780
+
781
+ LoggerProxy.log(`Consult conference started successfully`, {
782
+ module: CC_FILE,
783
+ method: METHODS.CONSULT_CONFERENCE,
784
+ interactionId: this.data.interactionId,
785
+ });
786
+
787
+ return response;
788
+ } catch (error) {
789
+ // Send failure event to revert state
790
+ if (this.stateMachineService) {
791
+ this.stateMachineService.send({
792
+ type: TaskEvent.CONFERENCE_FAILED,
793
+ reason: error.toString(),
794
+ });
795
+ }
796
+
797
+ const {error: detailedError} = getErrorDetails(error, METHODS.CONSULT_CONFERENCE, CC_FILE);
798
+
799
+ const failedParamsData = buildConsultConferenceParamData(
800
+ consultationData,
801
+ this.data.interactionId
802
+ );
803
+
804
+ this.metricsManager.trackEvent(
805
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_START_FAILED,
806
+ {
807
+ taskId: this.data.interactionId,
808
+ destination: failedParamsData.data.to,
809
+ destinationType: failedParamsData.data.destinationType,
810
+ agentId: failedParamsData.data.agentId,
811
+ error: error.toString(),
812
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
813
+ },
814
+ ['operational', 'behavioral', 'business']
815
+ );
816
+
817
+ LoggerProxy.error(`Failed to start consult conference`, {
818
+ module: CC_FILE,
819
+ method: METHODS.CONSULT_CONFERENCE,
820
+ interactionId: this.data.interactionId,
821
+ });
822
+
823
+ throw detailedError;
824
+ }
825
+ }
826
+
827
+ /**
828
+ * Exit from a conference call.
829
+ * Per conference-spec.md:
830
+ * - Primary agent exits to wrapup
831
+ * - Non-primary agent exits to available/connected
832
+ * - Other participants continue the call
833
+ *
834
+ * @returns Promise<TaskResponse>
835
+ * @throws Error if not in conference or exit fails
836
+ * @example
837
+ * ```typescript
838
+ * task.exitConference().then(() => {}).catch(() => {});
839
+ * ```
840
+ */
841
+ public async exitConference(): Promise<TaskResponse> {
842
+ // Validate we're in conference state OR conference is in progress per task data
843
+ // This handles cases where:
844
+ // 1. State machine is in CONFERENCING state
845
+ // 2. State machine is in CONNECTED but conference is active (e.g., ownership transferred)
846
+ const state = this.getStateMachineSnapshot();
847
+ const isConferencingState = state?.matches(TaskState.CONFERENCING);
848
+
849
+ const isConferenceInProgressFromData = this.data ? getIsConferenceInProgress(this.data) : false;
850
+
851
+ if (!state || (!isConferencingState && !isConferenceInProgressFromData)) {
852
+ const currentState = state?.value as TaskState;
853
+ const error = new Error(`Cannot exit conference in ${currentState} state`);
854
+ LoggerProxy.error('Exit conference operation not allowed', {
855
+ module: CC_FILE,
856
+ method: 'exitConference',
857
+ interactionId: this.data.interactionId,
858
+ });
859
+ throw error;
860
+ }
861
+
862
+ // Send state machine event
863
+ if (this.stateMachineService) {
864
+ this.stateMachineService.send({
865
+ type: TaskEvent.EXIT_CONFERENCE,
866
+ agentId: this.data.agentId,
867
+ });
868
+ }
869
+
870
+ const requestInteractionId =
871
+ this.data.interaction?.mainInteractionId || this.data.interactionId;
872
+
873
+ try {
874
+ LoggerProxy.info(`Exiting conference`, {
875
+ module: CC_FILE,
876
+ method: 'exitConference',
877
+ interactionId: requestInteractionId,
878
+ });
879
+
880
+ this.metricsManager.timeEvent([
881
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_EXIT_SUCCESS,
882
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_EXIT_FAILED,
883
+ ]);
884
+
885
+ const response = await this.contact.exitConference({
886
+ interactionId: requestInteractionId,
887
+ });
888
+
889
+ // Send success event to transition state
890
+ if (this.stateMachineService) {
891
+ this.stateMachineService.send({
892
+ type: TaskEvent.EXIT_CONFERENCE_SUCCESS,
893
+ taskData: response.data,
894
+ });
895
+ }
896
+
897
+ this.metricsManager.trackEvent(
898
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_EXIT_SUCCESS,
899
+ {
900
+ taskId: this.data.interactionId,
901
+ requestInteractionId,
902
+ agentId: this.data.agentId,
903
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
904
+ },
905
+ ['operational', 'behavioral', 'business']
906
+ );
907
+
908
+ LoggerProxy.log(`Successfully exited conference`, {
909
+ module: CC_FILE,
910
+ method: 'exitConference',
911
+ trackingId: response.trackingId,
912
+ interactionId: requestInteractionId,
913
+ });
914
+
915
+ return response;
916
+ } catch (error) {
917
+ // Send failure event
918
+ if (this.stateMachineService) {
919
+ this.stateMachineService.send({
920
+ type: TaskEvent.EXIT_CONFERENCE_FAILED,
921
+ reason: error.toString(),
922
+ });
923
+ }
924
+
925
+ const {error: detailedError} = getErrorDetails(error, 'exitConference', CC_FILE);
926
+ this.metricsManager.trackEvent(
927
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_EXIT_FAILED,
928
+ {
929
+ taskId: this.data.interactionId,
930
+ requestInteractionId,
931
+ agentId: this.data.agentId,
932
+ error: error.toString(),
933
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
934
+ },
935
+ ['operational', 'behavioral', 'business']
936
+ );
937
+
938
+ LoggerProxy.error(`Failed to exit conference`, {
939
+ module: CC_FILE,
940
+ method: 'exitConference',
941
+ interactionId: requestInteractionId,
942
+ });
943
+
944
+ throw detailedError;
945
+ }
946
+ }
947
+
948
+ /**
949
+ * Transfer the conference to another participant.
950
+ * Per conference-spec.md: Only primary agent can transfer conference.
951
+ * After transfer, the transferring agent exits to wrapup.
952
+ *
953
+ * @returns Promise<TaskResponse>
954
+ * @throws Error if not in conference or transfer fails
955
+ * @example
956
+ * ```typescript
957
+ * task.transferConference().then(() => {}).catch(() => {});
958
+ * ```
959
+ */
960
+ public async transferConference(): Promise<TaskResponse> {
961
+ // Validate we're in conference or consulting state
962
+ // CONSULTING is allowed because agent can transfer conference while consulting
963
+ // (transfers ownership to the consulted agent)
964
+ const state = this.getStateMachineSnapshot();
965
+ const isValidState =
966
+ state && (state.matches(TaskState.CONFERENCING) || state.matches(TaskState.CONSULTING));
967
+ if (!isValidState) {
968
+ const currentState = state?.value as TaskState;
969
+ const error = new Error(`Cannot transfer conference in ${currentState} state`);
970
+ LoggerProxy.error('Transfer conference operation not allowed', {
971
+ module: CC_FILE,
972
+ method: 'transferConference',
973
+ interactionId: this.data.interactionId,
974
+ });
975
+ throw error;
976
+ }
977
+
978
+ // Send state machine event
979
+ if (this.stateMachineService) {
980
+ this.stateMachineService.send({
981
+ type: TaskEvent.TRANSFER_CONFERENCE,
982
+ agentId: this.data.agentId,
983
+ });
984
+ }
985
+
986
+ const requestInteractionId =
987
+ this.data.interaction?.mainInteractionId || this.data.interactionId;
988
+
989
+ try {
990
+ LoggerProxy.info(`Transferring conference`, {
991
+ module: CC_FILE,
992
+ method: 'transferConference',
993
+ interactionId: requestInteractionId,
994
+ });
995
+
996
+ this.metricsManager.timeEvent([
997
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_TRANSFER_SUCCESS,
998
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_TRANSFER_FAILED,
999
+ ]);
1000
+
1001
+ const response = await this.contact.conferenceTransfer({
1002
+ interactionId: requestInteractionId,
1003
+ });
1004
+
1005
+ // Send success event to transition state
1006
+ if (this.stateMachineService) {
1007
+ this.stateMachineService.send({
1008
+ type: TaskEvent.TRANSFER_CONFERENCE_SUCCESS,
1009
+ taskData: response.data,
1010
+ });
1011
+ }
1012
+
1013
+ this.metricsManager.trackEvent(
1014
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_TRANSFER_SUCCESS,
1015
+ {
1016
+ taskId: this.data.interactionId,
1017
+ requestInteractionId,
1018
+ agentId: this.data.agentId,
1019
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
1020
+ },
1021
+ ['operational', 'behavioral', 'business']
1022
+ );
1023
+
1024
+ LoggerProxy.log(`Successfully transferred conference`, {
1025
+ module: CC_FILE,
1026
+ method: 'transferConference',
1027
+ trackingId: response.trackingId,
1028
+ interactionId: requestInteractionId,
1029
+ });
1030
+
1031
+ return response;
1032
+ } catch (error) {
1033
+ // Send failure event
1034
+ if (this.stateMachineService) {
1035
+ this.stateMachineService.send({
1036
+ type: TaskEvent.TRANSFER_CONFERENCE_FAILED,
1037
+ reason: error.toString(),
1038
+ });
1039
+ }
1040
+
1041
+ const {error: detailedError} = getErrorDetails(error, 'transferConference', CC_FILE);
1042
+ this.metricsManager.trackEvent(
1043
+ METRIC_EVENT_NAMES.TASK_CONFERENCE_TRANSFER_FAILED,
1044
+ {
1045
+ taskId: this.data.interactionId,
1046
+ requestInteractionId,
1047
+ agentId: this.data.agentId,
1048
+ error: error.toString(),
1049
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
1050
+ },
1051
+ ['operational', 'behavioral', 'business']
1052
+ );
1053
+
1054
+ LoggerProxy.error(`Failed to transfer conference`, {
1055
+ module: CC_FILE,
1056
+ method: 'transferConference',
1057
+ interactionId: requestInteractionId,
1058
+ });
1059
+
1060
+ throw detailedError;
1061
+ }
1062
+ }
1063
+
1064
+ /**
1065
+ * Toggle between consult call and main call during consulting.
1066
+ * If on consult leg (consultCallHeld = false), switches to main call by holding consult.
1067
+ * If on main call (consultCallHeld = true), switches to consult by resuming consult.
1068
+ *
1069
+ * @returns Promise<TaskResponse>
1070
+ * @throws Error if not in CONSULTING state or no consult media resource
1071
+ * @example
1072
+ * ```typescript
1073
+ * await task.switchCall();
1074
+ * ```
1075
+ */
1076
+ public async switchCall(): Promise<TaskResponse> {
1077
+ // Validate we're in CONSULTING state
1078
+ const state = this.getStateMachineSnapshot();
1079
+ if (!state?.matches(TaskState.CONSULTING)) {
1080
+ const currentState = state?.value as TaskState;
1081
+ const error = new Error(`Cannot switch call in ${currentState} state`);
1082
+ LoggerProxy.error('Switch call operation not allowed', {
1083
+ module: CC_FILE,
1084
+ method: 'switchCall',
1085
+ interactionId: this.data.interactionId,
1086
+ });
1087
+ throw error;
1088
+ }
1089
+
1090
+ // Validate we have a consult media resource
1091
+ const consultMediaResourceId = getConsultMediaResourceId(
1092
+ this.data.interaction,
1093
+ this.data.consultMediaResourceId,
1094
+ this.data.agentId
1095
+ );
1096
+ if (!consultMediaResourceId) {
1097
+ const error = new Error('No consult media resource available');
1098
+ LoggerProxy.error('Switch call failed - no consult media resource', {
1099
+ module: CC_FILE,
1100
+ method: 'switchCall',
1101
+ interactionId: this.data.interactionId,
1102
+ });
1103
+ throw error;
1104
+ }
1105
+
1106
+ const context = state.context;
1107
+ const isOnConsultLeg = !context.consultCallHeld;
1108
+
1109
+ // Determine direction and send appropriate state machine event
1110
+ const targetEvent = isOnConsultLeg
1111
+ ? TaskEvent.SWITCH_TO_MAIN_CALL
1112
+ : TaskEvent.SWITCH_TO_CONSULT;
1113
+ const revertEvent = isOnConsultLeg
1114
+ ? TaskEvent.SWITCH_TO_CONSULT
1115
+ : TaskEvent.SWITCH_TO_MAIN_CALL;
1116
+
1117
+ if (this.stateMachineService) {
1118
+ this.stateMachineService.send({type: targetEvent});
1119
+ }
1120
+
1121
+ this.metricsManager.timeEvent([
1122
+ METRIC_EVENT_NAMES.TASK_SWITCH_CALL_SUCCESS,
1123
+ METRIC_EVENT_NAMES.TASK_SWITCH_CALL_FAILED,
1124
+ ]);
1125
+
1126
+ try {
1127
+ if (isOnConsultLeg) {
1128
+ const response = await this.contact.unHold({
1129
+ interactionId: this.data.interactionId,
1130
+ data: {mediaResourceId: this.data.mediaResourceId},
1131
+ });
1132
+
1133
+ this.metricsManager.trackEvent(
1134
+ METRIC_EVENT_NAMES.TASK_SWITCH_CALL_SUCCESS,
1135
+ {
1136
+ taskId: this.data.interactionId,
1137
+ direction: 'toMainCall',
1138
+ mediaResourceId: consultMediaResourceId,
1139
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
1140
+ },
1141
+ ['operational', 'behavioral']
1142
+ );
1143
+
1144
+ LoggerProxy.log(`Switched to main call successfully`, {
1145
+ module: CC_FILE,
1146
+ method: 'switchCall',
1147
+ trackingId: response.trackingId,
1148
+ interactionId: this.data.interactionId,
1149
+ });
1150
+
1151
+ return response;
1152
+ }
1153
+
1154
+ const response = await this.contact.hold({
1155
+ interactionId: this.data.interactionId,
1156
+ data: {mediaResourceId: this.data.mediaResourceId},
1157
+ });
1158
+
1159
+ this.metricsManager.trackEvent(
1160
+ METRIC_EVENT_NAMES.TASK_SWITCH_CALL_SUCCESS,
1161
+ {
1162
+ taskId: this.data.interactionId,
1163
+ direction: 'toConsultCall',
1164
+ mediaResourceId: consultMediaResourceId,
1165
+ ...MetricsManager.getCommonTrackingFieldForAQMResponse(response),
1166
+ },
1167
+ ['operational', 'behavioral']
1168
+ );
1169
+
1170
+ LoggerProxy.log(`Switched to consult call successfully`, {
1171
+ module: CC_FILE,
1172
+ method: 'switchCall',
1173
+ trackingId: response.trackingId,
1174
+ interactionId: this.data.interactionId,
1175
+ });
1176
+
1177
+ return response;
1178
+ } catch (error) {
1179
+ if (this.stateMachineService) {
1180
+ this.stateMachineService.send({type: revertEvent});
1181
+ }
1182
+
1183
+ this.metricsManager.trackEvent(
1184
+ METRIC_EVENT_NAMES.TASK_SWITCH_CALL_FAILED,
1185
+ {
1186
+ taskId: this.data.interactionId,
1187
+ direction: isOnConsultLeg ? 'toMainCall' : 'toConsultCall',
1188
+ mediaResourceId: consultMediaResourceId,
1189
+ error: error.toString(),
1190
+ ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(error.details || {}),
1191
+ },
1192
+ ['operational', 'behavioral']
1193
+ );
1194
+
1195
+ const {error: detailedError} = getErrorDetails(error, 'switchCall', CC_FILE);
1196
+ LoggerProxy.error(`Failed to switch call`, {
1197
+ module: CC_FILE,
1198
+ method: 'switchCall',
1199
+ interactionId: this.data.interactionId,
1200
+ });
1201
+ throw detailedError;
1202
+ }
1203
+ }
1204
+
1205
+ protected override getChannelSpecificActionOverrides() {
1206
+ const baseOverrides = super.getChannelSpecificActionOverrides();
1207
+
1208
+ return {
1209
+ ...baseOverrides,
1210
+ emitTaskHold: this.createEmitSelfAction(TASK_EVENTS.TASK_HOLD, {updateTaskData: true}),
1211
+ emitTaskResume: this.createEmitSelfAction(TASK_EVENTS.TASK_RESUME, {updateTaskData: true}),
1212
+ emitTaskRecordingStarted: this.createEmitSelfAction(TASK_EVENTS.TASK_RECORDING_STARTED, {
1213
+ updateTaskData: true,
1214
+ }),
1215
+ emitTaskRecordingPaused: this.createEmitSelfAction(TASK_EVENTS.TASK_RECORDING_PAUSED, {
1216
+ updateTaskData: true,
1217
+ }),
1218
+ emitTaskRecordingPauseFailed: this.createEmitSelfAction(
1219
+ TASK_EVENTS.TASK_RECORDING_PAUSE_FAILED,
1220
+ {updateTaskData: true}
1221
+ ),
1222
+ emitTaskRecordingResumed: this.createEmitSelfAction(TASK_EVENTS.TASK_RECORDING_RESUMED, {
1223
+ updateTaskData: true,
1224
+ }),
1225
+ emitTaskRecordingResumeFailed: this.createEmitSelfAction(
1226
+ TASK_EVENTS.TASK_RECORDING_RESUME_FAILED,
1227
+ {updateTaskData: true}
1228
+ ),
1229
+ // Conference event emitters
1230
+ emitTaskParticipantJoined: this.createEmitSelfAction(TASK_EVENTS.TASK_PARTICIPANT_JOINED, {
1231
+ updateTaskData: true,
1232
+ }),
1233
+ emitTaskParticipantLeft: this.createEmitSelfAction(TASK_EVENTS.TASK_PARTICIPANT_LEFT, {
1234
+ updateTaskData: true,
1235
+ }),
1236
+ emitTaskConferenceStarted: this.createEmitSelfAction(TASK_EVENTS.TASK_CONFERENCE_STARTED, {
1237
+ updateTaskData: true,
1238
+ }),
1239
+ emitTaskConferenceEnded: this.createEmitSelfAction(TASK_EVENTS.TASK_CONFERENCE_ENDED, {
1240
+ updateTaskData: true,
1241
+ }),
1242
+ emitTaskConferenceFailed: this.createEmitSelfAction(TASK_EVENTS.TASK_CONFERENCE_FAILED, {
1243
+ updateTaskData: true,
1244
+ }),
1245
+ emitTaskExitConference: this.createEmitSelfAction(TASK_EVENTS.TASK_EXIT_CONFERENCE, {
1246
+ updateTaskData: false,
1247
+ }),
1248
+ emitTaskTransferConference: this.createEmitSelfAction(TASK_EVENTS.TASK_TRANSFER_CONFERENCE, {
1249
+ updateTaskData: false,
1250
+ }),
1251
+ emitTaskSwitchCall: this.createEmitSelfAction(TASK_EVENTS.TASK_SWITCH_CALL, {
1252
+ updateTaskData: false,
1253
+ }),
1254
+ emitTaskTransferConferenceFailed: this.createEmitSelfAction(
1255
+ TASK_EVENTS.TASK_CONFERENCE_TRANSFER_FAILED,
1256
+ {updateTaskData: true}
1257
+ ),
1258
+ emitTaskOutdialFailed: ({event}: TaskActionArgs) => {
1259
+ if (event && 'taskData' in event && event.taskData) {
1260
+ this.updateTaskData(event.taskData as TaskData);
1261
+ }
1262
+ const reason = (event as {reason?: string})?.reason || 'Outdial failed';
1263
+ this.emit(TASK_EVENTS.TASK_OUTDIAL_FAILED, reason);
1264
+ },
1265
+ };
1266
+ }
1267
+ }