@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
@@ -1,4 +1,5 @@
1
1
  import * as Agent from '../agent/types';
2
+ import {COLLABORATION_ACCESS} from './constants';
2
3
 
3
4
  /**
4
5
  * Generic type for converting a const enum object into a union type of its values
@@ -6,8 +7,13 @@ import * as Agent from '../agent/types';
6
7
  */
7
8
  type Enum<T extends Record<string, unknown>> = T[keyof T];
8
9
 
10
+ /** Desktop Profile access level for a collaboration destination category. */
11
+ export type CollaborationAccess = Enum<typeof COLLABORATION_ACCESS>;
12
+
9
13
  /**
10
- * Events emitted on task objects
14
+ * Contact Center backend and realtime event types.
15
+ *
16
+ * Includes task lifecycle, transcript, suggested-response, and AI summary events.
11
17
  * @enum {string}
12
18
  * @private
13
19
  * @ignore
@@ -57,6 +63,8 @@ export const CC_TASK_EVENTS = {
57
63
  PARTICIPANT_LEFT_CONFERENCE: 'ParticipantLeftConference',
58
64
  /** Event emitted when participant leaving conference fails */
59
65
  PARTICIPANT_LEFT_CONFERENCE_FAILED: 'ParticipantLeftConferenceFailed',
66
+ /** Event emitted when dropping another conference participant fails */
67
+ PARTICIPANT_DROP_CONFERENCE_FAILED: 'ParticipantDropConferenceFailed',
60
68
  /** Event emitted when consultation conference end fails */
61
69
  AGENT_CONSULT_CONFERENCE_END_FAILED: 'AgentConsultConferenceEndFailed',
62
70
  /** Event emitted when conference is successfully transferred */
@@ -135,17 +143,20 @@ export const CC_TASK_EVENTS = {
135
143
  SUGGESTED_RESPONSE: 'SUGGESTED_RESPONSE',
136
144
  /** Event emitted when backend acknowledges it is listening for more context */
137
145
  SUGGESTED_RESPONSE_ACKNOWLEDGE: 'SUGGESTED_RESPONSE_ACKNOWLEDGE',
138
- /** Event emitted when a mid-call summary is available */
139
- MID_CALL_SUMMARY: 'MID_CALL_SUMMARY',
140
- /** Event emitted when a post-call summary is available */
146
+ /** Event received when a post-call summary is available through realtime delivery */
141
147
  POST_CALL_SUMMARY: 'POST_CALL_SUMMARY',
148
+ /** Event received when a mid-call summary is available through realtime delivery */
149
+ MID_CALL_SUMMARY: 'MID_CALL_SUMMARY',
150
+ /** Event received when AI-summary feature enablement is available through realtime delivery */
151
+ FEATURE_ENABLEMENT: 'FEATURE_ENABLEMENT',
152
+ /** Event received when a subsequent agent receives a mid-call summary */
153
+ MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT: 'MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT',
142
154
  } as const;
143
155
 
144
156
  /**
145
157
  * Events emitted on Contact Center agent operations
146
158
  * @enum {string}
147
- * @private
148
- * @ignore
159
+ * @public
149
160
  */
150
161
  export const CC_AGENT_EVENTS = {
151
162
  /** Welcome event when agent connects to websocket/backend */
@@ -184,6 +195,8 @@ export const CC_AGENT_EVENTS = {
184
195
  AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: 'BuddyAgentsRetrieveFailed',
185
196
  /** Event emitted when contact is reserved for agent */
186
197
  AGENT_CONTACT_RESERVED: 'AgentContactReserved',
198
+ /** Agent-level Agent Wellness Break notification */
199
+ WELLNESS_BREAK: 'WellnessBreak',
187
200
  } as const;
188
201
 
189
202
  /**
@@ -196,6 +209,11 @@ export const CC_EVENTS = {
196
209
  ...CC_TASK_EVENTS,
197
210
  } as const;
198
211
 
212
+ /** Public Contact Center browser voice event names. */
213
+ export enum VOICE_CONNECTION_EVENTS {
214
+ STATE_CHANGE = 'voice:connectionStateChange',
215
+ }
216
+
199
217
  /**
200
218
  * Event data received when agent connects to the system
201
219
  * @public
@@ -244,7 +262,7 @@ export type WebSocketEvent = {
244
262
  };
245
263
 
246
264
  /**
247
- * Represents the response from getUserUsingCI method.
265
+ * Agent identity carried by the `user` section of the user desktop-login aggregate.
248
266
  */
249
267
  export type AgentResponse = {
250
268
  /**
@@ -277,16 +295,6 @@ export type AgentResponse = {
277
295
  */
278
296
  email: string;
279
297
 
280
- /**
281
- * Team IDs assigned to the agent.
282
- */
283
- teamIds: string[];
284
-
285
- /**
286
- * Multimedia profile ID associated with the agent.
287
- */
288
- multimediaProfileId: string;
289
-
290
298
  /**
291
299
  * Skill profile ID of the agent.
292
300
  */
@@ -298,9 +306,10 @@ export type AgentResponse = {
298
306
  siteId: string;
299
307
 
300
308
  /**
301
- * Database ID of the agent.
309
+ * Database ID of the agent, distinct from `ciUserId`. Passed as `userDbId` to the team lookup,
310
+ * which sends it as the backend's `filter=userId==` value.
302
311
  */
303
- dbId?: string;
312
+ dbId: string;
304
313
 
305
314
  /**
306
315
  * The default dialed number of the agent.
@@ -310,36 +319,12 @@ export type AgentResponse = {
310
319
  };
311
320
 
312
321
  /**
313
- * Represents the response from getDesktopProfileById method.
322
+ * Desktop Profile settings carried by the `agentProfile` section of the user desktop-login
323
+ * aggregate.
314
324
  */
315
- export type DesktopProfileResponse = {
316
- /**
317
- * Unique identifier of the agent profile configuration.
318
- */
319
- id: string;
320
-
321
- /**
322
- * Display name for the agent profile.
323
- */
324
- name: string;
325
-
326
- /**
327
- * Description of the agent profile.
328
- */
329
- description: string;
330
-
331
- /**
332
- * Parent entity type for the profile (for example ORGANIZATION).
333
- */
334
- parentType: string;
335
-
336
- /**
337
- * Indicates whether screen pop is enabled.
338
- */
339
- screenPopup: boolean;
340
-
325
+ export type AgentProfile = {
341
326
  /**
342
- * Represents the voice options of an agent.
327
+ * Represents the voice options of an agent. The order is nondeterministic; treat as a set.
343
328
  */
344
329
  loginVoiceOptions: LoginOption[];
345
330
 
@@ -353,16 +338,6 @@ export type DesktopProfileResponse = {
353
338
  */
354
339
  accessIdleCode: string;
355
340
 
356
- /**
357
- * Wrap-up codes list that the agents can select when they wrap up a contact.
358
- */
359
- wrapUpCodes: string[];
360
-
361
- /**
362
- * Idle codes list that the agents can select in Agent Desktop.
363
- */
364
- idleCodes: string[];
365
-
366
341
  /**
367
342
  * Dial plan enabled for the agent.
368
343
  */
@@ -381,12 +356,7 @@ export type DesktopProfileResponse = {
381
356
  /**
382
357
  * Whether the agent personal greeting is enabled.
383
358
  */
384
- agentPersonalGreeting: boolean;
385
-
386
- /**
387
- * Auto answer allowed.
388
- */
389
- autoAnswer: boolean;
359
+ agentPersonalGreeting?: boolean;
390
360
 
391
361
  /**
392
362
  * Auto wrap-up after seconds.
@@ -404,34 +374,19 @@ export type DesktopProfileResponse = {
404
374
  allowAutoWrapUpExtension: boolean;
405
375
 
406
376
  /**
407
- * Access control for queues assigned to the agent (ALL or SPECIFIC).
377
+ * Access control for queues assigned to the agent (ALL, SPECIFIC, or NONE).
408
378
  */
409
- accessQueue: string;
410
-
411
- /**
412
- * Queue identifiers available to the agent when access is SPECIFIC.
413
- */
414
- queues: string[];
379
+ accessQueue: CollaborationAccess;
415
380
 
416
381
  /**
417
382
  * Access control for entry points assigned to the agent.
418
383
  */
419
- accessEntryPoint: string;
420
-
421
- /**
422
- * Entry point identifiers available to the agent when access is SPECIFIC.
423
- */
424
- entryPoints: string[];
384
+ accessEntryPoint: CollaborationAccess;
425
385
 
426
386
  /**
427
387
  * Access control for buddy teams assigned to the agent.
428
388
  */
429
- accessBuddyTeam: string;
430
-
431
- /**
432
- * Buddy team identifiers available to the agent when access is SPECIFIC.
433
- */
434
- buddyTeams: string[];
389
+ accessBuddyTeam: CollaborationAccess;
435
390
 
436
391
  /**
437
392
  * Outdial enabled for the agent.
@@ -448,6 +403,11 @@ export type DesktopProfileResponse = {
448
403
  */
449
404
  outdialANIId: string;
450
405
 
406
+ /**
407
+ * Whether the agent can schedule and manage callbacks.
408
+ */
409
+ scheduleAndManageCallBack?: boolean;
410
+
451
411
  /**
452
412
  * Consult to queue allowed.
453
413
  */
@@ -456,19 +416,14 @@ export type DesktopProfileResponse = {
456
416
  /**
457
417
  * Address book ID of the agent.
458
418
  */
459
- addressBookId: string;
419
+ addressBookId?: string;
460
420
 
461
421
  /**
462
422
  * Viewable statistics of the agent.
463
423
  */
464
424
  viewableStatistics: {
465
- id: string;
466
425
  agentStats: boolean;
467
- accessQueueStats: string;
468
- contactServiceQueues: string[];
469
- loggedInTeamStats: boolean;
470
- accessTeamStats: string;
471
- teams: string[];
426
+ aiAgentPerformance?: boolean;
472
427
  };
473
428
 
474
429
  /**
@@ -476,16 +431,6 @@ export type DesktopProfileResponse = {
476
431
  */
477
432
  agentDNValidation: string;
478
433
 
479
- /**
480
- * Additional DN validation criteria configured for the agent.
481
- */
482
- agentDNValidationCriterions: string[];
483
-
484
- /**
485
- * Dial plans of the agent.
486
- */
487
- dialPlans: string[];
488
-
489
434
  /**
490
435
  * Timeout desktop inactivity custom enabled.
491
436
  */
@@ -494,52 +439,7 @@ export type DesktopProfileResponse = {
494
439
  /**
495
440
  * Timeout desktop inactivity minutes.
496
441
  */
497
- timeoutDesktopInactivityMins: number;
498
-
499
- /**
500
- * Show user details in Microsoft enabled or not.
501
- */
502
- showUserDetailsMS: boolean;
503
-
504
- /**
505
- * State synchronization in Microsoft enabled or not.
506
- */
507
- stateSynchronizationMS: boolean;
508
-
509
- /**
510
- * Show user details in Webex enabled or not.
511
- */
512
- showUserDetailsWebex: boolean;
513
-
514
- /**
515
- * State synchronization in Webex enabled or not.
516
- */
517
- stateSynchronizationWebex: boolean;
518
-
519
- /**
520
- * Threshold rules configured for the agent profile.
521
- */
522
- thresholdRules: Array<Record<string, string | number>>;
523
-
524
- /**
525
- * Whether the agent profile is currently active.
526
- */
527
- active: boolean;
528
-
529
- /**
530
- * Whether this profile is the system default.
531
- */
532
- systemDefault: boolean;
533
-
534
- /**
535
- * Timestamp when the profile was created.
536
- */
537
- createdTime: number;
538
-
539
- /**
540
- * Timestamp when the profile was last updated.
541
- */
542
- lastUpdatedTime: number;
442
+ timeoutDesktopInactivityMins?: number;
543
443
  };
544
444
 
545
445
  /**
@@ -699,7 +599,8 @@ export type ListTeamsResponse = {
699
599
  };
700
600
 
701
601
  /**
702
- * Basic organization information in the contact center system
602
+ * Basic organization information carried by the `organization` section of the org desktop-login
603
+ * aggregate.
703
604
  * @private
704
605
  * @ignore
705
606
  */
@@ -708,12 +609,11 @@ export type OrgInfo = {
708
609
  tenantId: string;
709
610
  /** Organization timezone */
710
611
  timezone: string;
711
- /** Current environment (e.g., 'produs1', 'intgus1') */
712
- environment: string;
713
612
  };
714
613
 
715
614
  /**
716
- * Organization-wide feature settings and configurations
615
+ * Organization-wide feature settings carried by the `organizationSetting` section of the org
616
+ * desktop-login aggregate.
717
617
  * @private
718
618
  */
719
619
  export type OrgSettings = {
@@ -723,6 +623,8 @@ export type OrgSettings = {
723
623
  maskSensitiveData: boolean;
724
624
  /** Whether campaign manager features are enabled */
725
625
  campaignManagerEnabled: boolean;
626
+ /** Number of AI Assistant licenses assigned to the organization */
627
+ aiAssistantQuantity?: number | null;
726
628
  };
727
629
 
728
630
  /**
@@ -743,12 +645,13 @@ export type SiteInfo = {
743
645
  };
744
646
 
745
647
  /**
746
- * Tenant-level configuration data and settings
648
+ * Tenant-level configuration carried by the `tenantConfiguration` section of the org
649
+ * desktop-login aggregate.
747
650
  * @private
748
651
  */
749
652
  export type TenantData = {
750
- /** Desktop inactivity timeout in minutes */
751
- timeoutDesktopInactivityMins: number;
653
+ /** Desktop inactivity timeout in minutes. Omitted when the timeout is not enabled. */
654
+ timeoutDesktopInactivityMins?: number;
752
655
  /** Whether default DN is enforced */
753
656
  forceDefaultDn: boolean;
754
657
  /** Regex pattern for default DN validation */
@@ -772,16 +675,46 @@ export type TenantData = {
772
675
  };
773
676
 
774
677
  /**
775
- * URL mapping configuration for external integrations
678
+ * URL mappings carried by the `urlMappings` section of the org desktop-login aggregate, keyed by
679
+ * mapping name. The aggregate returns `{}` when the organization has no Acqueon configuration.
776
680
  * @public
777
681
  */
778
- export type URLMapping = {
779
- id: string;
780
- name: string;
781
- url: string;
782
- links: string[]; // Assuming 'links' is an array of strings, adjust if necessary
783
- createdTime: number; // Assuming timestamps are represented as numbers
784
- lastUpdatedTime: number;
682
+ export type OrgUrlMappings = {
683
+ /** Acqueon API endpoint URL */
684
+ ACQUEON_API_URL?: string;
685
+ /** Acqueon console URL */
686
+ ACQUEON_CONSOLE_URL?: string;
687
+ };
688
+
689
+ /**
690
+ * Organization-level Microsoft Teams integration configuration carried by the `microsoftConfig`
691
+ * section of the org desktop-login aggregate. The whole section is absent when the organization
692
+ * has no Microsoft integration.
693
+ * @public
694
+ */
695
+ export type MicrosoftConfig = {
696
+ /** Whether to show user details in Teams */
697
+ showUserDetails?: boolean;
698
+ /** Whether to sync agent state with Teams */
699
+ stateSynchronization?: boolean;
700
+ /** Whether the integration is enabled organization-wide */
701
+ active?: boolean;
702
+ /** Idle codes mapped to Teams presence states */
703
+ idleCodes?: Record<string, string>;
704
+ };
705
+
706
+ /**
707
+ * Organization-level Webex integration configuration carried by the `webexConfig` section of the
708
+ * org desktop-login aggregate.
709
+ * @public
710
+ */
711
+ export type WebexConfig = {
712
+ /** Whether to show user details in Webex */
713
+ showUserDetails?: boolean;
714
+ /** Whether to sync agent state with Webex */
715
+ stateSynchronization?: boolean;
716
+ /** Idle codes mapped to Webex presence states */
717
+ idleCodes?: Record<string, string>;
785
718
  };
786
719
 
787
720
  /**
@@ -879,6 +812,8 @@ export type DialPlanEntity = {
879
812
  strippedChars: string;
880
813
  /** Name of the dial plan */
881
814
  name: string;
815
+ /** Whether the dial plan is active */
816
+ active: boolean;
882
817
  };
883
818
 
884
819
  /**
@@ -986,19 +921,6 @@ export type WrapupData = {
986
921
  };
987
922
  };
988
923
 
989
- /**
990
- * Team configuration information
991
- * @public
992
- */
993
- export type Team = {
994
- /** Unique team identifier */
995
- teamId: string;
996
- /** Team display name */
997
- teamName: string;
998
- /** Optional desktop layout configuration identifier */
999
- desktopLayoutId?: string;
1000
- };
1001
-
1002
924
  /**
1003
925
  * Basic queue configuration information
1004
926
  * @public
@@ -1022,11 +944,12 @@ export type URLMappings = {
1022
944
  };
1023
945
 
1024
946
  /**
1025
- * AI feature resource row returned by /v2/ai-feature API.
947
+ * AI feature flags carried by the `aiFeature` section of the org desktop-login aggregate.
1026
948
  * @public
1027
949
  */
1028
950
  export type AIFeatureFlags = {
1029
- id: string;
951
+ /** Not carried by the aggregate; retained for responses that still supply a record id. */
952
+ id?: string;
1030
953
  realtimeTranscripts?: {
1031
954
  enable?: boolean;
1032
955
  agentInclusionType?: string;
@@ -1051,27 +974,42 @@ export type AIFeatureFlags = {
1051
974
  queuesInclusionType?: string;
1052
975
  surveyDataSource?: string;
1053
976
  };
1054
- links?: string[];
1055
- createdTime?: number;
1056
- lastUpdatedTime?: number;
1057
977
  };
1058
978
 
1059
979
  /**
1060
- * Response type for list AI feature resources API.
980
+ * Aggregated organization configuration returned by `organization/{orgId}/desktop-login`.
981
+ * Replaces the separate organization, organization-setting, tenant-configuration,
982
+ * org-url-mapping and ai-feature calls.
1061
983
  * @public
1062
984
  */
1063
- export type AIFeatureFlagsResponse = {
1064
- meta?: {
1065
- orgid?: string;
1066
- page?: number;
1067
- pageSize?: number;
1068
- totalPages?: number;
1069
- totalRecords?: number;
1070
- links?: {
1071
- self?: string;
1072
- };
1073
- };
1074
- data: AIFeatureFlags[];
985
+ export type OrgDesktopLoginResponse = {
986
+ /** Organization identity and timezone */
987
+ organization: OrgInfo;
988
+ /** Organization-wide feature settings */
989
+ organizationSetting: OrgSettings;
990
+ /** Tenant-level configuration */
991
+ tenantConfiguration: TenantData;
992
+ /** External integration URLs, keyed by mapping name */
993
+ urlMappings?: OrgUrlMappings;
994
+ /** AI feature flags */
995
+ aiFeature?: AIFeatureFlags;
996
+ /** Microsoft Teams integration configuration; absent when not configured */
997
+ microsoftConfig?: MicrosoftConfig;
998
+ /** Webex integration configuration */
999
+ webexConfig?: WebexConfig;
1000
+ };
1001
+
1002
+ /**
1003
+ * Aggregated user configuration returned by
1004
+ * `organization/{orgId}/v2/user/by-ci-user-id/{ciUserId}/desktop-login`.
1005
+ * Replaces the separate user and agent-profile calls.
1006
+ * @public
1007
+ */
1008
+ export type UserDesktopLoginResponse = {
1009
+ /** Agent identity */
1010
+ user: AgentResponse;
1011
+ /** Desktop Profile settings for the agent */
1012
+ agentProfile: AgentProfile;
1075
1013
  };
1076
1014
 
1077
1015
  /**
@@ -1094,8 +1032,8 @@ export type Profile = {
1094
1032
  /** Whether to sync agent state with Webex */
1095
1033
  stateSynchronizationWebex?: boolean;
1096
1034
  };
1097
- /** List of teams the agent belongs to */
1098
- teams: Team[];
1035
+ /** List of teams the agent belongs to, as returned by the team API */
1036
+ teams: TeamList[];
1099
1037
  /** Agent's default dial number */
1100
1038
  defaultDn: string;
1101
1039
  dn?: string;
@@ -1169,6 +1107,12 @@ export type Profile = {
1169
1107
  agentAnalyzerId?: string;
1170
1108
  /** Whether consult to queue is allowed */
1171
1109
  allowConsultToQueue: boolean;
1110
+ /** Access control for queues on Desktop Profile Collaboration tab */
1111
+ accessQueue?: CollaborationAccess;
1112
+ /** Access control for entry points on Desktop Profile Collaboration tab */
1113
+ accessEntryPoint?: CollaborationAccess;
1114
+ /** Access control for buddy teams on Desktop Profile Collaboration tab */
1115
+ accessBuddyTeam?: CollaborationAccess;
1172
1116
  /** Additional campaign manager information */
1173
1117
  campaignManagerAdditionalInfo?: string;
1174
1118
  /** Whether personal statistics are enabled */
@@ -1205,8 +1149,6 @@ export type Profile = {
1205
1149
  isAnalyzerEnabled?: boolean;
1206
1150
  /** Tenant timezone */
1207
1151
  tenantTimezone?: string;
1208
- /** Current environment (e.g., 'produs1', 'intgus1') */
1209
- environment?: string;
1210
1152
  /** Available voice login options */
1211
1153
  loginVoiceOptions?: LoginOption[];
1212
1154
  /** Current login device type */
@@ -1225,6 +1167,8 @@ export type Profile = {
1225
1167
  maskSensitiveData?: boolean;
1226
1168
  /** Whether agent is currently logged in */
1227
1169
  isAgentLoggedIn?: boolean;
1170
+ /** Active station session after a successful registered relogin. */
1171
+ agentSessionId?: string;
1228
1172
  /** Last auxiliary code ID used for state change */
1229
1173
  lastStateAuxCodeId?: string;
1230
1174
  /** Timestamp of last state change */
@@ -1233,6 +1177,12 @@ export type Profile = {
1233
1177
  lastIdleCodeChangeTimestamp?: number;
1234
1178
  /** AI feature flags resolved from organization config */
1235
1179
  aiFeature?: AIFeatureFlags;
1180
+ /**
1181
+ * Whether Agent Wellness Break is effectively enabled for this profile.
1182
+ * This combines the organization wellbeing configuration with AI Assistant licensing;
1183
+ * Server-side rollout remains enforced by the backend configuration and notification delivery.
1184
+ */
1185
+ isWellnessBreakEnabled?: boolean;
1236
1186
  };
1237
1187
 
1238
1188
  /**
@@ -32,6 +32,16 @@ export const WCC_CALLING_RTMS_DOMAIN = 'wcc-calling-rtms-domain';
32
32
  */
33
33
  export const DEFAULT_RTMS_DOMAIN = 'rtw.prod-us1.rtmsprod.net';
34
34
 
35
+ /**
36
+ * Trusted domain suffix for RTMS hosts returned by the u2c service catalog. A catalog-provided
37
+ * RTMS host is only used when its hostname is, or is a subdomain of, this domain; otherwise
38
+ * `DEFAULT_RTMS_DOMAIN` is used.
39
+ * @type {string}
40
+ * @public
41
+ * @ignore
42
+ */
43
+ export const ALLOWED_RTMS_DOMAIN = 'rtmsprod.net';
44
+
35
45
  /**
36
46
  * Timeout in milliseconds for WebSocket events.
37
47
  * @type {number}
@@ -30,6 +30,7 @@ export type TaskErrorIds =
30
30
  | {'Service.aqm.err.trackingId': {trackingId: string}}
31
31
  | {'Service.aqm.task.consultAccept': Failure}
32
32
  | {'Service.aqm.task.consultConference': Failure}
33
+ | {'Service.aqm.task.dropConferenceParticipant': Failure}
33
34
  | {'Service.aqm.task.consultEnd': Failure}
34
35
  | {'Service.aqm.task.cancelCtq': Failure}
35
36
  | {'Service.aqm.task.hold': Failure}
@@ -16,6 +16,10 @@ import {
16
16
  import {PARTICIPANT_TYPES, STATE_CONSULT} from './constants';
17
17
  import {DialPlan} from '../config/types';
18
18
 
19
+ /** Returns whether a value is a non-null object with string keys. */
20
+ export const isRecord = (value: unknown): value is Record<string, unknown> =>
21
+ typeof value === 'object' && value !== null;
22
+
19
23
  /**
20
24
  * Extracts common error details from a Webex request payload.
21
25
  *
@@ -99,6 +103,30 @@ export const isValidDialNumber = (
99
103
  });
100
104
  };
101
105
 
106
+ /**
107
+ * Checks whether a URL's hostname is, or is a subdomain of, one of the allowed domains.
108
+ *
109
+ * @param url - The candidate URL to validate
110
+ * @param allowedDomains - Domains (or domain suffixes) the URL's hostname must match
111
+ * @returns true when the URL parses and its hostname matches an allowed domain, false otherwise
112
+ */
113
+ export const isAllowedUrlHost = (
114
+ url: string | undefined | null,
115
+ allowedDomains: string[]
116
+ ): boolean => {
117
+ if (!url) {
118
+ return false;
119
+ }
120
+
121
+ try {
122
+ const hostname = new URL(url).hostname.toLowerCase();
123
+
124
+ return allowedDomains.some((domain) => hostname === domain || hostname.endsWith(`.${domain}`));
125
+ } catch (error) {
126
+ return false;
127
+ }
128
+ };
129
+
102
130
  export const getStationLoginErrorData = (failure: Failure, loginOption: LoginOption) => {
103
131
  let duplicateLocationMessage = 'This value is already in use';
104
132
 
@@ -34,14 +34,16 @@ class WebexRequest {
34
34
  resource: string;
35
35
  method: HTTP_METHODS;
36
36
  body?: RequestBody;
37
+ headers?: Record<string, string | null>;
37
38
  }): Promise<IHttpResponse> {
38
- const {service, resource, method, body} = options;
39
+ const {service, resource, method, body, headers} = options;
39
40
 
40
41
  return this.webex.request({
41
42
  service,
42
43
  resource,
43
44
  method,
44
45
  body,
46
+ ...(headers ? {headers} : {}),
45
47
  });
46
48
  }
47
49